The guide to deploy and use EDA Server with AWX on K3s.
In this guide, EDA Server Operator is used to deploy EDA Server.
- Ansible Blog | Ansible.com | Event-Driven Ansible
- Welcome to Ansible Rulebook documentation — Ansible Rulebook Documentation
- ansible/eda-server
- ansible/eda-server-operator
EDA Server is designed to use with AWX, so we have to have working AWX instance. Refer to the main guide on this repository to deploy AWX on K3s.
Clone this repository and change directory.
cd ~
git clone https://github.com/kurokobo/awx-on-k3s.git
cd awx-on-k3sThen invoke kubectl apply -k rulebooks/operator to deploy EDA Server Operator.
kubectl apply -k rulebooks/operatorThe EDA Server Operator will be deployed to the namespace eda.
$ kubectl -n eda get all
NAME READY STATUS RESTARTS AGE
pod/eda-server-operator-controller-manager-7bf7578d44-7r87w 2/2 Running 0 12s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/eda-server-operator-controller-manager-metrics-service ClusterIP 10.43.3.124 <none> 8443/TCP 12s
NAME READY UP-TO-DATE AVAILABLE AGE
deployment.apps/eda-server-operator-controller-manager 1/1 1 1 12s
NAME DESIRED CURRENT READY AGE
replicaset.apps/eda-server-operator-controller-manager-7bf7578d44 1 1 1 12sGenerate a Self-Signed certificate for the Web UI and API for EDA Server. Note that IP address can't be specified.
EDA_HOST="eda.example.com"
openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -out ./rulebooks/server/tls.crt -keyout ./rulebooks/server/tls.key -subj "/CN=${EDA_HOST}/O=${EDA_HOST}" -addext "subjectAltName = DNS:${EDA_HOST}"Modify hostname and automation_server_url in rulebooks/server/eda.yaml. Note hostname is the hostname for your EDA Server instance, and automation_server_url is the URL for your AWX instance that accessible from EDA Server.
...
spec:
...
ingress_type: ingress
ingress_tls_secret: eda-secret-tls
hostname: eda.example.com 👈👈👈
automation_server_url: https://awx.example.com/ 👈👈👈
automation_server_ssl_verify: no
...Modify two passwords in rulebooks/server/kustomization.yaml.
...
- name: eda-postgres-configuration
type: Opaque
literals:
- host=eda-postgres-13
- port=5432
- database=eda
- username=eda
- password=Ansible123! 👈👈👈
- type=managed
- name: eda-admin-password
type: Opaque
literals:
- password=Ansible123! 👈👈👈
...Prepare directories for Persistent Volumes defined in base/pv.yaml. This directory will be used to store your database.
sudo mkdir -p /data/eda/postgres-13/data
sudo chown 26:0 /data/eda/postgres-13/data
sudo chmod 700 /data/eda/postgres-13/dataDeploy EDA Server, this takes few minutes to complete.
kubectl apply -k rulebooks/serverTo monitor the progress of the deployment, check the logs of deployment/eda-server-operator-controller-manager:
kubectl -n eda logs -f deployment/eda-server-operator-controller-managerWhen the deployment completes successfully, the logs end with:
$ kubectl -n eda logs -f deployment/eda-server-operator-controller-manager
...
----- Ansible Task Status Event StdOut (eda.ansible.com/v1alpha1, Kind=EDA, eda/eda) -----
PLAY RECAP *********************************************************************
localhost : ok=58 changed=0 unreachable=0 failed=0 skipped=20 rescued=0 ignored=0Required objects has been deployed next to AWX Operator in awx namespace.
$ kubectl -n eda get eda,all,ingress,configmap,secret
NAME AGE
eda.eda.ansible.com/eda 4m19s
NAME READY STATUS RESTARTS AGE
pod/eda-server-operator-controller-manager-b7f64bc9b-f6c45 2/2 Running 0 6m49s
pod/eda-redis-747596546f-rj8mx 1/1 Running 0 4m3s
pod/eda-postgres-13-0 1/1 Running 0 3m52s
pod/eda-ui-78d6d4c9d7-fndz4 1/1 Running 0 2m54s
pod/eda-activation-worker-5db4894b46-tgk9g 1/1 Running 0 2m49s
pod/eda-default-worker-7bbfd84567-dnbvr 1/1 Running 0 2m51s
pod/eda-scheduler-588d78b9bd-fpfpw 1/1 Running 0 2m47s
pod/eda-api-888c5d77c-95r2z 2/2 Running 0 2m57s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/eda-server-operator-controller-manager-metrics-service ClusterIP 10.43.181.52 <none> 8443/TCP 6m49s
service/eda-redis-svc ClusterIP 10.43.141.149 <none> 6379/TCP 4m4s
service/eda-postgres-13 ClusterIP None <none> 5432/TCP 3m56s
service/eda-api ClusterIP 10.43.209.69 <none> 8000/TCP 2m58s
service/eda-daphne ClusterIP 10.43.182.145 <none> 8001/TCP 2m58s
service/eda-ui ClusterIP 10.43.49.181 <none> 80/TCP 2m55s
NAME READY UP-TO-DATE AVAILABLE AGE
deployment.apps/eda-server-operator-controller-manager 1/1 1 1 6m49s
deployment.apps/eda-redis 1/1 1 1 4m3s
deployment.apps/eda-ui 1/1 1 1 2m54s
deployment.apps/eda-default-worker 1/1 1 1 2m51s
deployment.apps/eda-activation-worker 1/1 1 1 2m49s
deployment.apps/eda-scheduler 1/1 1 1 2m47s
deployment.apps/eda-api 1/1 1 1 2m57s
NAME DESIRED CURRENT READY AGE
replicaset.apps/eda-server-operator-controller-manager-b7f64bc9b 1 1 1 6m49s
replicaset.apps/eda-redis-747596546f 1 1 1 4m3s
replicaset.apps/eda-ui-78d6d4c9d7 1 1 1 2m54s
replicaset.apps/eda-default-worker-7bbfd84567 1 1 1 2m51s
replicaset.apps/eda-activation-worker-5db4894b46 1 1 1 2m49s
replicaset.apps/eda-scheduler-588d78b9bd 1 1 1 2m47s
replicaset.apps/eda-api-888c5d77c 1 1 1 2m57s
NAME READY AGE
statefulset.apps/eda-postgres-13 1/1 3m55s
NAME CLASS HOSTS ADDRESS PORTS AGE
ingress.networking.k8s.io/eda-ingress traefik eda.example.com 192.168.0.221 80, 443 2m52s
NAME DATA AGE
configmap/kube-root-ca.crt 1 6m50s
configmap/eda-eda-env-properties 11 3m
configmap/eda-eda-configmap 1 3m
configmap/eda-server-operator 0 6m37s
NAME TYPE DATA AGE
secret/redhat-operators-pull-secret Opaque 1 6m49s
secret/eda-admin-password Opaque 1 4m19s
secret/eda-postgres-configuration Opaque 6 4m19s
secret/eda-secret-tls kubernetes.io/tls 2 4m19s
secret/eda-db-fields-encryption-secret Opaque 1 3m9sNow your EDA Server is available at https://eda.example.com/ or the hostname you specified.
Here is a demo of configuring a webhook on the EDA Server side, and triggering a Job Template on AWX by posting payload that contains a specific message to the webhook.
In this demo, following example Rulebook is used. Review the Rulebook.
- Webhook as a source: demo_webhook.yaml
- The webhook that listening on
0.0.0.0:5000is defined as a source of the Ruleset. - This Ruleset has a rule that if the payload contains
messagefield with the bodyHello EDA, triggerDemo Job TemplateinDefaultorganization on AWX.
- The webhook that listening on
In addition to the webhook demo, a quick demo to use MQTT as a source is also provided.
- MQTT as a source: demo_mqtt.yaml
- As a source of the Ruleset, subscribing MQTT topic on the MQTT broker is defined. Actual connection information for MQTT can be defined by Rulebook Variables.
- This Ruleset has a rule that if the received data contains
messagefield with the bodyHello EDA, triggerDemo Job TemplateinDefaultorganization on AWX.
In order to the webhook to be ready to receive messages, the following tasks need to be done.
- Issue new token for AWX and add it on EDA Server
- Add Decision Environment on EDA Server
- Add Project on EDA Server
- Enable Rulebook Activation
- Deploy Ingress resource for the webhook
EDA Server uses a token to access AWX. This token has to be issued by AWX and registered on EDA Server.
To issue new token by AWX, in the Web UI for AWX, open User Details page (accessible by user icon at the upper right corner), follow to the Tokens tab, and then click Add button. Specify Write as Scope and click Save, then keep the issued token in the safe place.
Alternatively we can issue new token by CLI as follows:
$ kubectl -n awx exec deployment/awx-task -- awx-manage create_oauth2_token --user=admin
4sIZrWXi**************8xChmahbTo register the token on EDA Server, in the Web UI for EDA Server, open User details page (accessible by user icon at the upper right corner), follow to the Controller Tokens tab, and then click Create controller token button.
Fill the form as follows, then click Create controller token button on the bottom of the page:
| Key | Value |
|---|---|
| Name | awx.example.com |
| Token | <YOUR_TOKEN> |
Decision Environment (DE) is an environment for running Ansible Rulebook (ansible-rulebook) by the EDA Server, like Execution Environment (EE) for running Ansible Runner (ansible-runner) by the AWX.
There is no default DE on EDA Server, so we have to register new one.
Open Decision Environments on Web UI for EDA Server, then click Create decision environment button.
Fill the form as follows, then click Create decision environment button on the bottom of the page:
| Key | Value |
|---|---|
| Name | Minimal DE |
| Image | quay.io/ansible/ansible-rulebook:v1.0.6 |
To run Ansible Rulebook by EDA Server, the repository on SCM that contains Rulebooks have to be registered as Project on EDA Server.
This repository contains some example Rulebooks under rulebooks directory, so we can register this repository as Project.
Open Projects on Web UI for EDA Server, then click Create project button.
Fill the form as follows, then click Create project button on the bottom of the page:
| Key | Value |
|---|---|
| Name | Demo Project |
| SCM URL | https://github.com/kurokobo/awx-on-k3s.git |
Refresh the page and wait for the Status for the project to be Completed.
To run Ansible Rulebook by EDA Server, define Rulebook Activation and enable it.
Open Rulebook Activations on Web UI for EDA Server, then click Create rulebook activation button.
Fill the form as follows, then click Create rulebook activation button on the bottom of the page:
| Key | Value |
|---|---|
| Name | Trigger Demo Job Template by Webhook |
| Project | Demo Project |
| Rulebook | demo_webhook.yaml |
| Decision environment | Minimal DE |
| Controller token | awx.example.com |
Refresh the page and wait for the Activation status for the Rulebook to be Running.
When you enable Rulebook Activation, a Job called an activation job is launched.
$ kubectl -n eda get job
NAME COMPLETIONS DURATION AGE
activation-job-1-1 0/1 7m3s 7m3sThe name of the activation job will be changed with each enabling Rulebook Activation, so it is important to know this name for subsequent tasks.
As an example above, the name of the activation job contains two IDs, such as activation-job-<Activation ID>-<Instance ID>. Each of these IDs can be identified as follows.
- Activation ID
- This is an ID for your Rulebook Activation.
- This is uniquely assigned to each Rulebook Activation and does not change.
- On Web UI, you can gather this ID by
IDcolumn onRulebook Activationspage, orActivation IDon theDetailstab for your Rulebook Activation.
- Instance ID
- This is an ID of each instance of the Ansible Rulebook.
- It is newly assigned each time a Rulebook Activation is enabled. It means that the ID changes when Rulebook Activation is disabled and re-enabled.
- On Web UI, you can gather this ID by
Nameon theHistorytab for your Rulebook Activation. The number at the beginning of theNamecolumn of the line that inRunningstate is the ID.
Once the activation job name has been identified by collecting those two IDs, the Pod created by this job can also be identified. This is the Pod where ansible-rulebook is running on.
$ JOB_NAME=activation-job-1-1
$ kubectl -n eda get pod -l job-name=${JOB_NAME}
NAME READY STATUS RESTARTS AGE
activation-job-1-1-ctz24 1/1 Running 0 7m16sThe new Service is also created by EDA Server. This Service provides the endpoint for the webhook by routing traffic to the above Pod.
$ kubectl -n eda get service -l job-name=${JOB_NAME}
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
activation-job-1-1-5000 ClusterIP 10.43.82.223 <none> 5000/TCP 7m40sTo make the webhook externally accessible, we have to expose the Service that created by EDA Server.
To achieve this, in this example, we create new Ingress.
Modify hosts, host, and name under service in rulebooks/webhook/ingress.yaml. Here, the same hostname as the EDA Server are specified so that the endpoint for webhook can be accessed under the same URL as the EDA Server. Note that the name of the service has to be the name of the Service that created by EDA Server, as reviewed above.
...
spec:
tls:
- hosts:
- eda.example.com 👈👈👈
secretName: eda-secret-tls
rules:
- host: eda.example.com 👈👈👈
http:
paths:
- path: /webhooks/demo
pathType: ImplementationSpecific
backend:
service:
name: activation-job-1-1-5000 👈👈👈
port:
number: 5000By applying this file, your webhook can be accessed on the URL https://eda.example.com/webhooks/demo.
$ kubectl apply -f rulebooks/webhook/ingress.yaml
...
$ kubectl -n eda get ingress
NAME CLASS HOSTS ADDRESS PORTS AGE
eda-ingress traefik eda.example.com 192.168.0.221 80, 443 4h45m
eda-ingress-webhook traefik eda.example.com 192.168.0.221 80, 443 1s 👈👈👈In the Rulebook (demo_webhook.yaml) that used in this demo, the Job Template (Demo Job Template) is invoked on AWX on the condition that message in the payload that posted to the webhook is Hello EDA.
Post that payload to the webhook, and review the Job Template is triggered.
$ curl -k \
-H "Content-Type: application/json" \
-d '{"message": "Hello EDA"}' \
https://eda.example.com/webhooks/demoReview Rule Audit page on the Web UI for EDA Server, and Jobs page under Views on the Web UI for AWX.
For a more authentic example, here is an example of using MQTT as a source.
To use MQTT, a MQTT broker is required. If you don't have one, you can use kubectl apply -k rulebooks/mqtt/broker to deploy a minimal MQTT broker on K3s that listens on 31883 or use a public broker such as test.mosquitto.org. Also, this demonstration is prepared assuming that neither authentication nor encryption is used.
Define the Decision Environment with the following information, just as you configured for the webhook.
| Key | Value |
|---|---|
| Name | Minimal DE with MQTT |
| Image | docker.io/kurokobo/ansible-rulebook:v1.0.6-mqtt |
Note that the image specified above is based on quay.io/ansible/ansible-rulebook:stable-1.0 and includes kubealex.eda collection that includes kubealex.eda.mqtt plugin. The Dockerfile for this image is available under mqtt/de directory.
Then define Rulebook Activation as follows. Note that you should modify actual values for Variables to suit your environment:
| Key | Value |
|---|---|
| Name | Trigger Demo Job Template by MQTT |
| Project | Demo Project |
| Rulebook | demo_mqtt.yaml |
| Decision environment | Minimal DE with MQTT |
| Controller token | awx.example.com |
| Variables | mqtt_host: mqtt.example.commqtt_port: 31883mqtt_topic: demo |
Activate the Rulebook, and publish specific message that matches the condition in the Rule to the topic you've defined.
docker run -it --rm efrecon/mqtt-client pub \
-h mqtt.example.com \
-p 31883 \
-t demo \
-m '{"message": "Hello EDA"}'Ensure your Job Template on AWX has been triggered.