Using automation decisions

Procedure

1. Log in to the Ansible Automation Platform Dashboard.
2. From the navigation panel, select Automation Decisions → Infrastructure → Credentials.
3. Click Create credential.

4. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

   Organization

   Click the list to select an organization or select Default.

   Credential type

   Click the list to select your Credential type.

   Note

   When you select the credential type, the Type Details section is displayed with fields that are applicable for the credential type you chose.

5. Complete the fields that are applicable to the credential type you selected.
6. 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. On the Credentials list page, click the name of the credential that you want to duplicate. This takes you to the Details tab of the credential.

2. Click Duplicate credential in the top right of the Details tab.

   Note

   You can also click the Duplicate credential icon next to the desired credential on the Credentials list page.

   A message is displayed confirming that your selected credential has been duplicated: "<Name of credential> duplicated."

3. Click the Back to credentials tab to view the credential you just duplicated.

   The duplicated credential is displayed with the same name as the original credential followed by a time stamp in 24-hour format (for example, <Name of credential> @ 17:26:30).

4. Edit the details you prefer for your duplicated credential.
5. Click Save credential.

Prerequisites

1. Ensure that your credential is not currently linked to any rulebook activations.

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.

   Note

   If your credential is still in use by other resources in your organization, a warning message is displayed letting you know that the credential cannot be deleted. Also, if your credential is being used in an event stream, you cannot delete it until the event stream is deleted or attached to a different credential. In general, avoid deleting a credential that is in use because it can lead to broken activations.

3. Click Delete credential.

Procedure

1. Log in to the Ansible Automation Platform Dashboard.
2. From the navigation panel, select Automation Decisions → Infrastructure → Credential Types.
3. Click Create credential type.

4. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

5. In the Input Configuration field, specify an input schema that defines a set of ordered fields for that type. The format can be in YAML or JSON:

   YAML

   fields:
     - type: string
       id: username
       label: Username
     - type: string
       id: password
       label: Password
       secret: true
   required:
     - username
     - password

   Copy to Clipboard Toggle word wrap

   View more YAML examples at the YAML page.

   JSON

   {
   "fields": [
     {
     "type": "string",
     "id": "username",
     "label": "Username"
     },
     {
     "secret": true,
     "type": "string",
     "id": "password",
     "label": "Password"
      }
     ],
    "required": ["username", "password"]
   }

   Copy to Clipboard Toggle word wrap

   View more JSON examples at The JSON website.

6. In the Injector Configuration field, enter environment variables or extra variables that specify the values a credential type can inject. The format can be in YAML or JSON (see examples in the previous step).

   The following configuration in JSON format shows each field and how they are used:

   {
       "extra_vars": {
         "some_extra_var": "{{ username }}:{{ password }}"
     }
   }

   Copy to Clipboard Toggle word wrap

7. Click Create credential type.

   Your newly created credential type is displayed in the list of credential types.

8. Click the Edit credential type icon to modify the credential type options.

Procedure

1. Log in to the Ansible Automation Platform Dashboard.
2. Navigate to Automation Decisions → Projects.
3. Click Create project.

4. Insert the following:

   Name

   Enter project name.

   Description

   This field is optional.

   Source control type

   Git is the only source control type available for use. This field is optional.

   Source control URL

   Enter Git, SSH, or HTTP[S] protocol address of a repository, such as GitHub or GitLab. This required field is editable. See Editing a project to view details of how editing this field impacts rulebook activations.

   Note

   This field accepts SSH private key or private key phrase. To enable the use of these private keys, your project URL must begin with git@.

   Proxy

   This is used to access HTTP or HTTPS servers. This field is optional and editable. See Editing a project to view details of how editing this field impacts rulebook activations.

   Source control branch/tag/commit

   This is the branch to checkout. In addition to branches, you can input tags, commit hashes, and arbitrary refs. Some commit hashes and refs may not be available unless you also provide a custom refspec. This field is optional and editable. See Editing a project to view details of how editing this field impacts rulebook activations.

   Source control refspec

   A refspec to fetch (passed to the Ansible git module). This parameter allows access to references via the branch field not otherwise available. This field is optional and editable. See Editing a project to view details of how editing this field impacts rulebook activations.

   Source control credential

   This is an optional credential used to authenticate with the provided Source control URL.

   Content signature validation credential

   Enable content signing to verify that the content has remained secure when a project is synced. If the content has been tampered with, the job will not run. This field is optional.

   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.

5. Select Create project.

Procedure

1. From the Projects list view, select the More Actions icon ⋮ next to the desired project. The Edit page is displayed.

2. Edit the desired fields.

   Important

   When you update a project’s Source control URL, Source control branch/tag/commit, or Source control refspec, Event-Driven Ansible automatically triggers a project resync. This process updates the rulebooks available within Event-Driven Ansible controller and can significantly impact existing rulebook activations:

   • Rulebook Content Updates: Running activations continue to use old content when a rulebook’s content changes. To apply the newer content, you must restart the affected rulebook activation. If the rulebook content you update is attached to an activation that uses event streams, you must re-attach the event stream to that activation after the updates are applied and then, restart the activation.
   • New Rulebooks: Any new rulebook added to the repository becomes available in the database after the sync.
   • Deleted Rulebooks: A removed rulebook is deleted from the database upon sync. Its associated activations, however, continue to run and can be restarted. Review and update any activations detached from their source rulebook.
3. Select Save project.

Prerequisites

1. A project is not currently linked to any rulebook activation.

Procedure

1. To delete a project, complete one of the following:

   • From the Projects list view, select the checkbox next to the desired project, and click the More Actions icon ⋮ from the page menu.
   • From the Projects list view, click the More Actions icon ⋮ next to the desired project.
2. Select Delete project.
3. In the Permanently delete projects window, select Yes, I confirm that I want to delete this project.
4. Select Delete project.

Procedure

1. Use de-minimal as the base image with Ansible Builder to build your custom decision environments. This image is built from a base image provided by Red Hat at Ansible Automation Platform minimal decision environment.

   The following is an example of the Ansible Builder definition file that uses de-minimal as a base image to build a custom decision environment with the ansible.eda collection:

   version: 3
   
   images:
     base_image:
       name: 'registry.redhat.io/ansible-automation-platform-25/de-minimal-rhel9:latest'
   
   dependencies:
     galaxy:
       collections:
         - ansible.eda
     python_interpreter:
       package_system: "python39"
   
   options:
     package_manager_path: /usr/bin/microdnf

   Copy to Clipboard Toggle word wrap

2. Optional: If you need other Python packages or RPMs, add the following to a single definition file:

   version: 3
   
   images:
     base_image:
       name: 'registry.redhat.io/ansible-automation-platform-25/de-minimal-rhel9:latest'
   
   dependencies:
     galaxy:
       collections:
         - ansible.eda
     python:
       - six
       - psutil
     system:
       - iputils [platform:rpm]
     python_interpreter:
       package_system: "python39"
   
   options:
     package_manager_path: /usr/bin/microdnf

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to Ansible Automation Platform.
2. Navigate to Automation Decisions → Decision Environments.
3. Click Create decision environment.

4. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

   Organization

   Select an organization to associate with the decision environment.

   Image

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

   Pull

   This optional field defines when the Event-Driven Ansible controller attempts to download (pull) the specified container image from the registry before running an automation rulebook. This setting is crucial for ensuring security, consistency, and efficient use of system resources by controlling when the local image cache is updated or reused.

   • Always pull container before running - checks the registry for a new version of the image before every use, even if a local copy exists. This ensures that the freshest content is always used, which is critical for security patches, content updates, and staging environments.
   • Only pull the image if not present before running - checks the local cache of Event-Driven Ansible controller first. If the image is found locally, it is used immediately. A pull from the registry only happens if the image is not found locally. This optimizes performance by avoiding unnecessary downloads and is best for production environments where the content image is stable and faster startup is required.
   • Never pull container before running - never attempts to pull the image from the registry. It only uses an image that has been previously pulled and is present in the local cache. This option guarantees consistency by preventing unintended content changes. It requires the image to be manually pulled to Event-Driven Ansible controller beforehand. If the image isn’t present, the activation fails.

   Credential

   This field is optional. This is the credential needed to use the decision environment image.

5. Select Create decision environment.

Procedure

1. Log in to the Ansible Automation Platform Dashboard.
2. From the navigation panel, select Automation Decisions → Infrastructure → Credentials.
3. Click Create credential.

4. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

   Organization

   Click the list to select an organization or select Default.

   Credential type

   Click the list and select Red Hat Ansible Automation Platform.

   Note

   When you select the credential type, the Type Details section is displayed with fields that are applicable for the credential type you chose.

   Warning

   If you plan to use a backup and restore operation to migrate your Ansible Automation Platform instance to a different cluster or new set of hostnames, the Red Hat Ansible Automation Platform credential will break, and your rulebook activation will fail. You must manually edit and update the automation controller URL and associated credentials after the restore operation is complete to restore connectivity.

5. In the required Red Hat Ansible Automation Platform field, enter your automation controller URL.

   Note

   For Event-Driven Ansible controller 2.6 with automation controller 2.4, use the following example: https://<your_controller_host>

   For Ansible Automation Platform 2.6, use the following example: https://<your_gateway_host>/api/controller/

6. Enter a valid Username and Password, or Oauth Token.
7. Click Create credential.

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

Procedure

1. Confirm whether there are other running activations and if you have reached the limits (for example, memory or CPU limits).

   1. If there are other activations running, terminate one or more of them, if possible.
   2. If not, check that the default worker, Redis, and activation worker are all running.
   3. If all systems are working as expected, check your eda-server internal logs in the worker, scheduler, API, and nginx containers and services to see if the problem can be determined. These logs reveal the source of the issue, such as an exception thrown by the code, a runtime error with network issues, or an error with the rulebook code. If your internal logs do not provide information that leads to resolution, report the issue to Red Hat support.

Procedure

1. Log in to Ansible Automation Platform.
2. From the navigation panel, select Automation Decisions → Rulebook Activations.
3. From the Rulebook Activations page, select the activation in your list that keeps restarting. The Details page is displayed.
4. Click the History tab for more information and select the rulebook activation that keeps restarting. The Details tab is displayed and shows the output information.

5. Check the Restart policy field for your activation.

   There are three selections available: On failure (restarts a rulebook activation when the container process fails), Always (always restarts regardless of success or failure with no more than 5 restarts), or Never (never restarts when the container process ends).

   1. Confirm that your rulebook activation Restart policy is set to On failure. This is an indication that an issue is causing it to fail.
   2. To possibly diagnose the problem, check the YAML code and the instance logs of the rulebook activation for errors.
   3. If you cannot find a solution with the restart policy values, proceed to the next steps related to the Log level.

6. Check your log level for your activation.

   1. If your default log level is Error, go back to the Rulebook Activation page and recreate your activation following procedures in Setting up rulebook a activation.
   2. Change the Log level to Debug.
   3. Run the activation again and navigate to the History tab from the activation details page.
   4. On the History page, click one of your recent activations and view the Output.

Procedure

1. Check the rulebook source: Review the source plugin defined in your rulebook YAML (for example, ansible.eda.webhook, ansible.eda.kafka).
2. Verify event input: Confirm that the events you are sending to Event-Driven Ansible controller are compatible with the source plugin defined in the rulebook. If the rulebook expects a Kafka message, it cannot process a generic webhook event.
3. Confirm activation mapping: If you are using event streams, ensure the correct event stream is mapped to the rulebook during the activation setup. A mismatch here will result in the activation receiving no data.

Procedure

1. Check rule conditions: Review the rulebook YAML to confirm that the conditions (the when statements) are accurately written and precisely match the structure and values of the incoming event payload.
2. Verify indentation and syntax: Ensure all rulebook syntax and indentation are correct, as a simple error can prevent the rule engine from evaluating conditions.
3. Validate actions: Confirm that the specified action is a recognized and correctly configured action (for example, run_job_template with the proper arguments).

Procedure

1. To help resolve the issue, confirm that you have set up a Red Hat Ansible Automation Platform credential and have obtained the correct automation controller URL.

   1. If you have not set up a Red Hat Ansible Automation Platform credential, follow the procedures in Setting up a Red Hat Ansible Automation Platform credential. Ensure that this credential has the host set to the following URL format: https://<your_gateway>/api/controller
   2. When you have completed this process, try setting up your rulebook activation again.

Procedure

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

Procedure

1. From the navigation panel, select Automation Decisions → 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 Automation Decisions → Rule Audit.
2. Select the desired rule, then select the Actions tab.

Procedure

1. Log in to the Ansible Automation Platform Dashboard.
2. From the navigation panel, select Automation Decisions → Infrastructure → Credentials.
3. Click Create credential.

4. Insert the following:

   Name

   Insert the name.

   Description

   This field is optional.

   Organization

   Click the list to select an organization or select Default.

   Credential type

   Click the list to select your Credential type.

   Note

   When you select the credential type, the Type Details section is displayed with fields that are applicable for the credential type you selected.

   Type Details

   Add the requested information for the credential type you selected. For example, if you selected the GitHub Event Stream credential type, you are required to add an HMAC Secret (symmetrical shared secret) between Event-Driven Ansible controller and the remote server.

5. Click Create credential.

Procedure

1. Log in to Ansible Automation Platform.
2. From the navigation panel, select Automation Decisions → Event Streams.
3. Click Create event stream.

4. Insert the following:

   Name

   Insert the name.

   Organization

   Click the list to select an organization or select Default.

   Event stream type

   Select the event stream type you prefer.

   Note

   This list displays at least 10 default event stream types that can be used to authenticate the connection coming from your remote server.

   Credentials

   Select a credential from the list, preferably the one you created for your event stream.

   Headers

   Enter HTTP header keys, separated by commas, that you want to include in the event payload.

   Important

   If your automation relies on HTTP headers being present in the event payload, you must explicitly define them to avoid unintentional exposure of sensitive information. For more information about HTTP headers and how to securely configure them, see HTTP headers and Configuring HTTP headers securely for event streams.

   Forward events to rulebook activation

   Use this option to enable or disable the capability of forwarding events to rulebook activations.

   Note

   The event stream’s event forwarding can be disabled for testing purposes while diagnosing connections and evaluating the incoming data. Disabling the Forward events to rulebook activation option allows you to test the event stream connection with the remote system, analyze the header and payload, and if necessary, diagnose credential issues. This ensures that events are not be forwarded to rulebook activations causing rules and conditions to be triggered inadvertently while you are in test mode. Some enterprises might have policies to change secrets and passwords at regular cadence. You can enable/disable this option anytime after the event stream is created.

5. Click Create event stream.

Procedure

1. Log in to your GitHub repository.

2. Click Your profile name → Your repositories.

   Note

   If you do not have a repository, click New to create a new one, select an owner, add a Repository name, and click Create repository.

3. Navigate to Settings (tool bar).
4. In the General navigation pane, select Webhooks.
5. Click Add webhook.
6. In the Payload URL field, paste the URL you saved when you created your event stream.
7. Select application/json in the Content type list.
8. Enter your Secret.
9. Click Add webhook.

1. Log in to Ansible Automation Platform.
2. From the navigation panel, select Automation Decisions → Event Streams.
3. Select the event stream that you created to validate connectivity and ensure that the event stream sends data to the rulebook activation.

4. Verify that the events were received. The number of Events received is displayed along with a header that contains details about the event.

   If you scroll down in the UI, you can also see the body of the payload with more information about the webhook.

   The Header and Body sections for the event stream are displayed on the Details page. They differ based on the vendor who is sending the event. The header and body can be used to check the attributes in the event payload, which will help you in writing conditions in your rulebook.

5. Toggle the Forward events to rulebook activation option to enable you to push your events to a rulebook activation.

1. An event stream can only be used once in a rulebook source swap. If you have multiple sources in the rulebook, you can only replace each source once.
2. The source mapping happens only in the current rulebook activation. You must repeat this process for any other activations using the same rulebook.
3. The source mapping is valid only if the rulebook doesn’t get modified. If the rulebook gets modified during the source mapping process, the source mapping would fail and it would have to be repeated.
4. If the rulebook is modified after the source mapping has been created and a Restart happens, the rulebook activation fails.

Procedure

1. Log in to Ansible Automation Platform.
2. From the navigation panel, select 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.

   Note

   Although this field is optional, selecting a project helps refine your list of rulebooks choices.

   Rulebook

   Rulebooks are shown according to the project selected. Select a rulebook.

   Note

   After you have selected a rulebook, the Event streams field is enabled. You can click the gear icon to display the Event streams mapping form.

   Event streams

   All the event streams available and set up to forward events to rulebook actiavtions are displayed. If you have not created any event streams, this field remains disabled.

   Click the gear icon to display the Event streams mapping UI.

   

   Complete the following fields:

   Rulebook source

   A rulebook can contain multiple sources across multiple rulesets. You can map the same rulebook in multiple activations to multiple event streams. While managing event streams, unnamed sources are assigned temporary names (__SOURCE {n}) for identification purposes.

   Select __SOURCE_1 from the list.

   Event stream

   Select your event stream name from the list.

   Click Save.

   Event streams can replace matching sources in a rulebook, and are server-side webhooks that enable you to connect various event sources to your rulebook activations. Source types that can be replaced with the event stream’s source of type ansible.eda.pg_listener include ansible.eda.webhook and other compatible webhook source plugins. Replacing selected sources affects this activation only, and modifies the rulebook’s source type, source name, and arguments. Filters, rules, conditions, and actions are all unaffected.

   You can select which source you want to replace with a single event stream. If there are multiple sources in your rulebook, you can choose to replace each one of them with event streams, but you are not required to replace each one. The following image displays which sources can be replaced.

   

   The items in pink demonstrate the sources that can be replaced: source type, source name, and arguments. The remaining items (filters, rules, and actions) are not replaced.

   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 on credentials, see Credentials.

   Decision environment

   A decision environment is a container image used 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.

   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. Go back to the GitHub Webhook / Manage webhook page.
2. Click the Recent Deliveries tab.
3. Click the ellipsis.
4. Click Redeliver. A Redeliver payload? window is displayed with a delivery message.
5. Click Yes, redeliver this payload.
6. Return to the Ansible Automation Platform to check your rule audit.

Procedure

1. Log in to Ansible Automation Platform.
2. From the navigation panel, select Automation Decisions → Rule Audit.

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

Procedure

1. Perform the following steps to modify your default memory limit for your rulebook activations during installation:

   1. Navigate to the setup inventory file.
   2. Add automationedacontroller_podman_mem_limit in the [all:vars] section. For example, automationedacontroller_podman_mem_limit='400m'.
   3. Run the setup.

2. Perform the following steps to modify your default memory limit for your rulebook activations after installation:

   1. Navigate to the environment file at /etc/ansible-automation-platform/eda/settings.yaml.
   2. Modify the default container memory limit. For example, PODMAN_MEM_LIMIT = '300m'.
   3. Restart the Event-Driven Ansible controller services using automation-eda-controller-service restart.