Event-Driven Ansible controller user guide

Procedure

1. Log in to the Event-Driven Ansible controller Dashboard.
2. From the navigation panel, select Resources → Credentials.
3. Click Create credential.

4. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

   Credential type

   The options available are a GitHub personal access token, a GitLab personal access token, or a container registry.

   Username

   Insert the username.

   Token

   Insert a token that allows you to authenticate to your destination.

   Note

   If you are using a container registry, the token field can be a token or a password, depending on the registry provider. If you are using the Ansible Automation Platform hub registry, insert the password for that in the token field.

5. Click Create credential.

Procedure

1. Edit the credential by using one of these methods:

   • From the Credentials list view, click the Edit credential icon next to the desired credential.
   • From the Credentials list view, select the name of the credential, click Edit credential.
2. Edit the appropriate details and click Save credential.

Procedure

1. Delete the credential by using one of these methods:

   • From the Credentials list view, click the More Actions icon ⋮ next to the desired credential and click Delete credential.
   • From the Credentials list view, select the name of the credential, click the More Actions icon ⋮ next to Edit credential, and click Delete credential.
2. In the pop-up window, select Yes, I confirm that I want to delete this credential.
3. Click Delete credential.

Procedure

1. Log in to the Event-Driven Ansible controller Dashboard.
2. From the navigation panel, select Projects → Create project.

3. Insert the following:

   Name

   Enter project name.

   Description

   This field is optional.

   SCM type

   Git is the only SCM type available for use.

   SCM URL

   HTTP[S] protocol address of a repository, such as GitHub or GitLab.

   Note

   You cannot edit the SCM URL after you create the project.

   Credential

   This field is optional. This is the token needed to utilize the SCM URL.

   Options

   The Verify SSL option is enabled by default. Enabling this option verifies the SSL with HTTPS when the project is imported.

   Note

   You can disable this option if you have a local repository that uses self-signed certificates.

4. Select Create project.

Procedure

1. From the Projects list view, select the More Actions icon ⋮ next to the desired project.
2. Select Edit project.
3. Enter the required changes and select Save project.

Procedure

1. From the Projects list view, select the More Actions icon ⋮ next to the desired project.
2. Select Delete project.
3. In the popup window, select Yes, I confirm that I want to delete this project.
4. Select Delete project.

Procedure

1. Navigate to the Event-Driven Ansible controller Dashboard.
2. From the navigation panel, select Decision Environments.

3. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

   Image

   This is the full image location, including the container registry, image name, and version tag.

   Credential

   This field is optional. This is the token needed to utilize the decision environment image.

4. Select Create decision environment.

Procedure

1. Go to the Event-Driven Ansible controller Dashboard.
2. From the top navigation panel, select your profile.
3. Go to User details.
4. Select Controller Tokens → Create controller token.

5. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

   Token

   Create the token in automation controller. For more information about creating the token, see the Users - Tokens section of the Automation controller User Guide.

   Note

   Your token must be in write-scope and if you are the assigned user, you must have permission to execute job and workflow templates.

6. Select Create controller token.

Procedure

1. Navigate to the Event-Driven Ansible controller Dashboard.
2. From the navigation panel, select Rulebook Activations.

3. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

   Project

   Projects are a logical collection of rulebooks.

   Rulebook

   Rulebooks are shown according to the project selected.

   Decision environment

   Decision environments are a container image to run Ansible rulebooks.

   Note

   In Event-Driven Ansible controller, you cannot customize the pull policy of the decision environment. By default, it follows the behavior of the always policy. Every time an activation is started, the system tries to pull the most recent version of the image.

   Restart policy

   This is a policy to decide when to restart a rulebook.

   • Policies:

     1. Always: Restarts when a rulebook finishes
     2. Never: Never restarts a rulebook when it finishes
     3. On failure: Only restarts when it fails

   Rulebook activation enabled?

   This automatically enables the rulebook activation to run.

   Variables

   The variables for the rulebook are in a JSON/YAML format. The content would be equivalent to the file passed through the --vars flag of ansible-rulebook command.

4. Click Create rulebook activation.

1. Select the switch on the row level to enable or disable your chosen rulebook.
2. In the popup window, select Yes, I confirm that I want to enable/disable these X rulebook activations.
3. Select Enable/Disable rulebook activation.

1. Select the More Actions icon ⋮ next to Rulebook Activation enabled/disabled toggle.
2. Select Restart rulebook activation.
3. In the popup window, select Yes, I confirm that I want to restart these X rulebook activations.
4. Select Restart rulebook activations.

1. Select the More Actions icon ⋮ next to the Rulebook Activation enabled/disabled toggle.
2. Select Delete rulebook activation.
3. In the popup window, select Yes, I confirm that I want to delete these X rulebook activations.
4. Select Delete rulebook activations.

Procedure

1. Create a Route (on OpenShift Container Platform) to expose the service. The following is an example Route for an ansible-rulebook source that expects POST’s on port 5000 on the decision environment pod:

   kind: Route
   apiVersion: route.openshift.io/v1
   metadata:
     name: test-sync-bug
     namespace: dynatrace
     labels:
       app: eda
       job-name: activation-job-1-5000
   spec:
     host: test-sync-bug-dynatrace.apps.aap-dt.ocp4.testing.ansible.com
     to:
       kind: Service
       name: activation-job-1-5000
       weight: 100
     port:
       targetPort: 5000
     tls:
       termination: edge
       insecureEdgeTerminationPolicy: Redirect
     wildcardPolicy: None

2. When you create the Route, test it with a Post to the Route URL:

   curl -H "Content-Type: application/json" -X POST
   test-sync-bug-dynatrace.apps.aap-dt.ocp4.testing.ansible.com -d
   '{}'

   Note

   You do not need the port as it is specified on the Route (targetPort).

Procedure

1. Run the following command to expose the port on the cluster for a given service:

   kubectl port-forward svc/<ACTIVATION_SVC_NAME> 5000:5000

2. Make the HTTP requests against the localhost:5000 to trigger the rulebook:

   curl -H "Content-Type: application/json" -X POST test-sync-bug-dynatrace.apps.aap-dt.ocp4.testing.ansible.com -d '{}'

Procedure

1. From the navigation panel select Rule Audit.
2. Select the desired rule, this brings you to the Details tab.

Procedure

1. From the navigation panel select Rule Audit.
2. Select the desired rule, this brings you to the Details tab. To view all the events that triggered an action, select the Events tab. This shows you the event that triggered actions.
3. Select an event to view the Event log, along with the Source type and Timestamp.

Procedure

1. From the navigation panel select Rule Audit.
2. Select the desired rule, this brings you to the Actions tab.

1. Number of simultaneous rulebook activations
2. Number of events received by Event-Driven Ansible controller