Chapter 7. Rulebook activations

Procedure

1. Log in to Ansible Automation Platform.
2. Navigate to the Automation Decisions Rulebook Activations.
3. Click Create rulebook activation.

4. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

   Organization

   Enter your organization name or select Default from the list.

   Project

   Projects are a logical collection of rulebooks. This field is optional.

   Rulebook

   Rulebooks are displayed according to the project selected.

   Credential

   Select 0 or more credentials for this rulebook activation. This field is optional.

   Note

   • The credentials that display in this field are customized based on your rulebook activation and only include the following credential types: Vault, Red Hat Ansible Automation Platform, or any custom credential types that you have created. For more information about credentials, see Credentials.
   • If you plan to use a Red Hat Ansible Automation Platform credential, you can only select 1 Red Hat Ansible Automation Platform credential type for a rulebook activation.

   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 the policy that determines how an activation should restart after the container process running the source plugin ends.

   • Policies:

     1. Always: This restarts the rulebook activation immediately, regardless of whether it ends successfully or not, and occurs no more than 5 times.
     2. Never: This never restarts a rulebook activation when the container process ends.
     3. On failure: This restarts the rulebook activation after 60 seconds by default, only when the container process fails, and occurs no more than 5 times.

   Log level

   This field defines the severity and type of content in your logged events.

   • Levels:

     1. Error: Logs that contain error messages that are displayed in the History tab of an activation.
     2. Info: Logs that contain useful information about rulebook activations, such as a success or failure, triggered action names and their related action events, and errors.
     3. Debug: Logs that contain information that is only useful during the debug phase and might be of little value during production. This log level includes both error and log level data.

   Service name

   This defines a service name for Kubernetes to configure inbound connections if the activation exposes a port. This field is optional.

   Rulebook activation enabled?

   This automatically enables the rulebook activation to run.

   Variables

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

   Note

   In the context of automation controller and Event-Driven Ansible controller, you can use both extra_vars and credentials to store a variety of information. However, credentials are the preferred method of storing sensitive information such as passwords or API keys because they offer better security and centralized management, whereas extra_vars are more suitable for passing dynamic, non-sensitive data.

   Options

   Check the Skip audit events option if you do not want to see your events in the Rule Audit.

5. Click Create rulebook activation.

Procedure

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

Procedure

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

Procedure

1. On the Rulebook Activations page, next to the activation you want to edit, toggle the Rulebook Activation enabled button to the off position first to disable the activation.

   The Disable rulebook activations message is displayed asking you to confirm that you want to disable the activation.

2. Select the Yes, I confirm that I want to disable these <1> rulebook activations checkbox and click Disable rulebook activations.

3. Next to the rulebook activation, click the Edit icon. This takes you to the Edit form.

   Note

   You can also access the Edit feature by clicking the rulebook activation on the Rulebook Activations page, toggling the Rulebook activation enabled button to the off position, confirming that you want to disable the activation, and clicking the Edit rulebook activation button on the top right of the page to access the Edit form.

4. Edit the desired fields.

   Note

   If you prefer to run your activation immediately, you can toggle the Rulebook activation enabled button to the on position, and then save your changes.

5. Click Save rulebook activation.

Procedure

1. On the Rulebook Activations page, click the More Actions icon ⋮ on the row of the activation you want to duplicate. The More Actions list is displayed with three options:

   • Restart rulebook activation
   • Duplicate rulebook activation
   • Delete rulebook activation

2. Select Duplicate rulebook activation.

   A message is displayed: "<Name of rulebook activation 1> duplicated." Initially, the newly duplicated activation is displayed as disabled on the Rulebook Activations page with the same name as the original activation followed by a time stamp in 24-hour format (for example, <Name of rulebook activation 1> @ 18:43:27).

   Important

   The original rulebook activation continues to run after you have duplicated it. If you try to enable the duplicated activation without editing the fields (including the Name field) to distinguish it from the original, a message is displayed reminding you that the rulebook activation was duplicated from an original, and enabling it might fail or result in duplicate jobs and other complications.

3. Before you run the duplicated rulebook activation, edit the fields by completing the following:

   1. Next to the duplicated rulebook activation, click the Edit icon. This takes you to the Edit form.

   2. Edit the desired fields.

      Note

      Ensure that you have given your newly duplicated activation a meaningful Name that distinguishes it from the original activation.

4. Toggle the Enable rulebook activation button to the on position.
5. After confirming all of your edits are complete, click Save rulebook activation.

Procedure

1. Select the More Actions icon ⋮ next to the Rulebook Activation enabled/disabled toggle.
2. Select Delete rulebook activation.
3. In the 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

   Copy to Clipboard Toggle word wrap

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

   Note

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

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

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 '{}'

   Copy to Clipboard Toggle word wrap