diff --git a/.github/workflows/galaxy_publish.yml b/.github/workflows/galaxy_publish.yml index e634702..32875f5 100644 --- a/.github/workflows/galaxy_publish.yml +++ b/.github/workflows/galaxy_publish.yml @@ -1,9 +1,8 @@ - name: Publish on Galaxy on: push: tags: - - '*' + - "*" jobs: galaxy-publish: @@ -11,7 +10,9 @@ jobs: steps: - name: Checkout uses: actions/checkout@v3 + with: + submodules: recursive - name: Ansible Publish uses: ansible/ansible-publish-action@v1.0.0 with: - api_key: ${{ secrets.GALAXY_API_KEY }} \ No newline at end of file + api_key: ${{ secrets.GALAXY_API_KEY }} diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..05068cd --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "roles/role_eda_controller_setup"] + path = roles/role_eda_controller_setup + url = git@github.com:kubealex/role_eda_controller_setup.git diff --git a/README.md b/README.md index 5764b86..0de5f20 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,51 @@ This collection was born with the idea to group some plugins and resources that can be helpful in extending the Event Driven Automation collection. +## Roles + +The following roles are included in the collection + +| Name | Description | +| -------------------------------------- | -------------------------------------------- | +| kubealex.eda.role_eda_controller_setup | Configure Projects, DE, Rulebook Activations | + +### Usage + +```yaml +--- +- name: Sample EDA Controller Setup + hosts: localhost + gather_facts: false + + roles: + + - role: role_eda_controller_setup + vars: + eda_controller_url: "https://your-eda-controller-api.com" + eda_controller_user: "your_eda_user" + eda_controller_password: "your_eda_password" + eda_projects: - name: "EDA Demo Project" + git_url: "https://github.com/kubealex/event-driven-automation" + description: "Demo project to show EDA in action" + eda_decision_env: - name: "kubealex-eda" + image_url: "quay.io/kubealex/eda-decision-env" + eda_activations: - name: "eda-alertmanager" + rulebook: "eda-rulebook-alertmanager.yml" + project_name: EDA Demo Project + decision_env: Automation Hub Default Decision Environment +``` ## Plugins The following plugins are included in the collection -| Name | Description | -|-|-| +| Name | Description | +| ----------------- | ---------------------------------- | | kubealex.eda.mqtt | Configure MQTT listener for events | -## Usage +### Usage -A sample rulebook using *kubealex.eda.mqtt* plugin is shown below +A sample rulebook using _kubealex.eda.mqtt_ plugin is shown below ```yaml --- @@ -35,18 +68,17 @@ A sample rulebook using *kubealex.eda.mqtt* plugin is shown below The following modules are included in the collection -| Name | Description | -|-|-| -| kubealex.eda.eda_activations | Configure activations in EDA Controller | -| kubealex.eda.eda_credentials | Configure credentials in EDA Controller | +| Name | Description | +| ------------------------------------- | ------------------------------------------------- | +| kubealex.eda.eda_activations | Configure activations in EDA Controller | +| kubealex.eda.eda_credentials | Configure credentials in EDA Controller | | kubealex.eda.eda_decision_environment | Configure decision_environments in EDA Controller | -| kubealex.eda.eda_projects | Configure projects in EDA Controller | +| kubealex.eda.eda_projects | Configure projects in EDA Controller | ### Usage A sample playbook to create items using the modules is shown below: - ```yaml --- - name: Example Playbook @@ -115,4 +147,8 @@ A sample playbook to create items using the modules is shown below: project_description: "Project 2 description" project_git_url: "http://example.com/project2" project_credential: "Credential 2" -``` \ No newline at end of file +``` + +``` + +``` diff --git a/galaxy.yml b/galaxy.yml index cda7acf..dbcfacc 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -4,7 +4,7 @@ namespace: kubealex name: eda -version: 1.0.4 +version: 1.0.5 readme: README.md diff --git a/roles/role_eda_controller_setup b/roles/role_eda_controller_setup new file mode 160000 index 0000000..1a9be75 --- /dev/null +++ b/roles/role_eda_controller_setup @@ -0,0 +1 @@ +Subproject commit 1a9be75c591ed2f26fee61bf860da1db74ad0088