Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion downstream/assemblies/eda/assembly-eda-credential-types.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@

= Credential types

{EDAcontroller} comes with several built-in credental types that you can use for syncing projects, running rulebook activations, executing job templates through {MenuTopAE} ({ControllerName}), fetching images from container registries, and processing data through event streams.
[role="_abstract"]
{EDAcontroller} comes with several built-in credential types that you can use for syncing projects, running rulebook activations, executing job templates through {MenuTopAE} ({ControllerName}), fetching images from container registries, and processing data through event streams.

These built-in credential types are not editable. So if you want credential types that support authentication with other systems, you can create your own credential types that can be used in your source plugins. Each credential type contains an input configuration and an injector configuration that can be passed to an Ansible rulebook to configure your sources.

Expand Down
1 change: 1 addition & 0 deletions downstream/assemblies/eda/assembly-eda-credentials.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Credentials

[role="_abstract"]
You can use credentials to store secrets that can be used for authentication purposes with resources, such as decision environments, rulebook activations and projects for {EDAcontroller}, and projects for {ControllerName}.

Credentials authenticate users when launching jobs against machines and importing project content from a version control system.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Decision environments

[role="_abstract"]
Decision environments are container images that run Ansible rulebooks.
They create a common language for communicating automation dependencies, and give a standard way to build and distribute the automation environment.
You can find the default decision environment in the link:https://quay.io/repository/ansible/ansible-rulebook[Ansible-Rulebook].
Expand Down
1 change: 1 addition & 0 deletions downstream/assemblies/eda/assembly-eda-projects.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Projects

[role="_abstract"]
Projects are a logical collection of rulebooks. They must be a git repository and located in the path defined for {EDAName} content in Ansible collections: `/extensions/eda/rulebooks` at the root of the project.

[IMPORTANT]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= {PlatformName} credential

[role="_abstract"]
When {EDAcontroller} is deployed on {PlatformNameShort} {PlatformVers}, you can create a {PlatformName} credential to connect to {ControllerName} through the use of an {ControllerName} URL and a username and password. After it has been created, you can attach the {PlatformName} credential to a rulebook and use it to run rulebook activations. These credentials provide a simple way to configure communication between {ControllerName} and {EDAcontroller}, enabling your rulebook activations to launch job templates.

[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= {EDAcontroller} overview

[role="_abstract"]
{EDAName} is a highly scalable, flexible automation capability that works with event sources such as other software vendors' monitoring tools.
These tools monitor IT solutions and identify events and automatically implement the documented changes or response in a rulebook to handle that event.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
:_mod-docs-content-type: CONCEPT

:_mod-docs-content-type: <CONCEPT>
[id="eda-cred-types-injector-config"]

= Injector Configuration

[role="_abstract"]
You can use Injector configuration to extract information from Input configuration fields and map them into injector types that can be sent to ansible-rulebook when running a rulebook activation. {EDAName} supports the following types of injectors:

* Environment variables (`env`) - Used in source plugins for the underlying package or shared library.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
:_mod-docs-content-type: CONCEPT

:_mod-docs-content-type: <CONCEPT>
[id="eda-cred-types-input-config"]

= Input Configuration

[role="_abstract"]
The Input configuration has two attributes:

* fields - a collection of properties for a credential type.
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/con-credentials-list-view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Credentials list view

[role="_abstract"]
When you log in to the {PlatformNameShort} and select {MenuADCredentials}, the Credentials page has a pre-loaded *Decision Environment Container Registry* credential. When you create your own credentials, they will be added to this list view. .

From the menu bar, you can search for credentials in the *Name* search field.
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/con-custom-credential-types.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

= Custom credential types

[role="_abstract"]
As a system administrator, you can define a custom credential type that works in ways similar to existing credential types in a standard format using a YAML or JSON-like definition.

Each credential type displays its own unique configurations in the *Input Configuration* and the *Injector Configuration* fields, if applicable. Both YAML and JSON formats are supported in the configuration fields.
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/con-eda-projects-list-view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Projects list view

[role="_abstract"]
On the *Projects* page, you can view the projects that you have created along with the *Status* and the *Git hash*.

[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Rulebook activation list view

[role="_abstract"]
On the *Rulebook Activations* page, you can view the rulebook activations that you have created along with the *Status*, *Number of rules* with the rulebook, the *Fire count*, and *Restart count*.

If the *Status* is *Running*, it means that the rulebook activation is running in the background and executing the required actions according to the rules declared in the rulebook.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Supported event sources

[role="_abstract"]
Event sources are a fundamental component of {EDAName} because they determine where a rulebook can receive events from. The effectiveness of a rulebook activation depends on selecting an event source that is compatible with your automation environment. Certain event sources are designed for use with the web-based {EDAcontroller}, while others, due to their reliance on local host functionality, are exclusive to the `ansible-rulebook` command-line interface (CLI). Understanding this distinction is crucial for successful rulebook activations.

The following list includes currently supported event sources for use with the web-based {EDAcontroller}. You can decide which event sources provide the desired outcome for your rulebook activations.
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/con-external-credential-types.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

= External secret management credential types

[role="_abstract"]
In addition to the built-in credential types, {EDAName} supports a variety of external secret management credential types. These credential types allow rulebooks to securely retrieve sensitive information, such as API keys and passwords, directly from your organization's centralized secret vault.

The following external credential types are available for use in {EDAcontroller}:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@

= Replacing controller tokens in {PlatformName} {PlatformVers}


[role="_abstract"]
To use {EDAcontroller} in {PlatformName} {PlatformVers}, you must replace legacy controller tokens configured in your environment with {PlatformName} credentials because controller tokens have been deprecated.
1 change: 1 addition & 0 deletions downstream/modules/eda/proc-eda-activate-webhook.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Activating webhook rulebooks

[role="_abstract"]
In Openshift environments, you can allow webhooks to reach an activation-job-pod over a given port by creating a route that exposes that rulebook activation's Kubernetes service.

.Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Building a custom decision environment for {EDAName}

[role="_abstract"]
Decision Environments are {ExecEnvShort}s tailored towards running Ansible Rulebooks.

Similar to {ExecEnvShort}s that run Ansible playbooks for {ControllerName}, decision environments are designed to run rulebooks for {EDAcontroller}.
Expand All @@ -25,13 +26,13 @@ You can create a custom decision environment for {EDAName} that provides a custo

.Procedure

* Use `de-minimal` as the base image with {Builder} to build your custom decision environments.
. Use `de-minimal` as the base image with {Builder} to build your custom decision environments.
This image is built from a base image provided by Red Hat at link:https://catalog.redhat.com/software/containers/ansible-automation-platform-25/de-minimal-rhel9/650a5672a370728c710acaab[{PlatformNameShort} minimal decision environment].

.Example

+
The following is an example of the {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:
Expand All @@ -47,10 +48,12 @@ dependencies:

options:
package_manager_path: /usr/bin/microdnf
-----
----

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

Additionally, if you need other Python packages or RPMs, you can add the following to a single definition file:
-----
----
version: 3

images:
Expand All @@ -71,4 +74,4 @@ dependencies:

options:
package_manager_path: /usr/bin/microdnf
-----
----
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@
[role="_abstract"]
After you have created your event stream, you must configure your remote system to send events to {EDAcontroller}. The method used for this configuration varies, depending on the vendor for the event stream credential type you select.

The following example demonstrates how to configure webhooks in a remote system like GitHub to send events to {EDAcontroller}. Each vendor will have unique methods for configuring your remote system to send events to {EDAcontroller}.

.Prerequisites

* The URL that was generated when you created your event stream
* Secrets or passwords that you set up in your event stream credential

.Procedure

The following example demonstrates how to configure webhooks in a remote system like GitHub to send events to {EDAcontroller}. Each vendor will have unique methods for configuring your remote system to send events to {EDAcontroller}.

. Log in to your GitHub repository.
. 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*.
====

+
. Navigate to *Settings* (tool bar).
. In the *General* navigation pane, select *Webhooks*.
. Click *Add webhook*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Duplicating a rulebook activation

[role="_abstract"]
When setting up a new rulebook activation with field inputs that are similar to one of your existing rulebook activations, you can use the *Duplicate rulebook activation* feature instead of manually entering input into each field. While setting up rulebook activations can be a lengthy process, the ability to duplicate the required fields from an existing activation saves time and, in some cases, reduces the possibility of human error.

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Deleting controller tokens

[role="_abstract"]
Before you can set up {PlatformName} credentials, you must delete any existing controller tokens.

.Prerequisites
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/proc-eda-delete-credential.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Deleting a credential

[role="_abstract"]
You can delete credentials if they are no longer needed for your organization.

.Procedure
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/proc-eda-delete-project.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Deleting a project

[role="_abstract"]
If you need to delete a project, the {EDAcontroller} interface provides multiple options.

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Deleting rulebook activations with controller tokens

[role="_abstract"]
To replace the controller tokens, you must delete the rulebook activations that were associated with them.

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Deleting rulebook activations

[role="_abstract"]
You can delete rulebook activations to permanently remove them when they are no longer needed.

.Procedure
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/proc-eda-duplicate-credential.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Duplicating a credential

[role="_abstract"]
When setting up a new credential with field inputs that are similar to your existing credentials, you can use the *Duplicate credential* feature in the Details tab to duplicate information instead of manually entering it. While setting up credentials can be a lengthy process, the ability to duplicate the required fields from an existing credential saves time and, in some cases, reduces the possibility of human error.

.Procedure
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/proc-eda-edit-credential.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Editing a credential

[role="_abstract"]
You can edit existing credentials to ensure the appropriate level of access for your organization.

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Editing a rulebook activation

[role="_abstract"]
You can edit a rulebook activation after you have created or run it to correct input for fields (log levels, Restart policy, turn auditing off or on, and the like) or help mitigate issues caused by failure.

.Procedure
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/proc-eda-editing-a-project.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Editing a project

[role="_abstract"]
You can modify various aspects of a project after you create it. Depending on the changes you make, a rulebook activation might be impacted, requiring you to review and restart it.

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@

= Enabling and disabling rulebook activations

[role="_abstract"]
You can enable or disable rulebook activations to control when they run. Disabling an activation is useful for troubleshooting or to temporarily halt automation without deleting the configuration.

.Procedure

. Select the switch on the row level to enable or disable your chosen rulebook.
. In the window, select btn:[Yes, I confirm that I want to enable/disable these X rulebook activations].
. Select btn:[Enable/Disable rulebook activation].
. Select btn:[Enable/Disable rulebook activation].
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Restarting rulebook activations

[role="_abstract"]
You can restart a rulebook activation to quickly re-engage its automation, which is useful after making updates or to recover from an error.

[NOTE]
Expand Down
6 changes: 3 additions & 3 deletions downstream/modules/eda/proc-eda-set-up-credential-types.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
:_mod-docs-content-type: PROCEDURE

:_mod-docs-content-type: <PROCEDURE>
[id="eda-set-up-new-credential-types"]

= Creating a new credential type

[role="_abstract"]
You can create a credential type to use with a source plugin that you select based on the supported, default credential types. You can make your credential type available to a team or individuals.

.Procedure
Expand Down Expand Up @@ -98,5 +98,5 @@ Your newly created credential type is displayed in the list of credential types.
* If the *Delete* option is disabled, this means that the credential type is being used by a credential, and you must delete the credential type from all the credentials that use it before you can delete it.

.Additional resources

link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_automation_decisions/eda-credentials#eda-set-up-credential[Setting up credentials].
* link:https://docs.redhat.com/en/do
cumentation/red_hat_ansible_automation_platform/2.5/html/using_automation_decisions/eda-credentials#eda-set-up-credential[Setting up credentials]
1 change: 1 addition & 0 deletions downstream/modules/eda/proc-eda-set-up-credential.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Setting up credentials

[role="_abstract"]
You can create a credential to use with a source plugin or a private container registry that you select. You can make your credential available to a team or individuals.

//[IMPORTANT]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Setting up a new decision environment

[role="_abstract"]
You can import a decision environment into your {EDAcontroller} using a default or custom decision environment.

.Prerequisites
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/proc-eda-set-up-new-project.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Setting up a new project

[role="_abstract"]
You can set up projects to manage and store your rulebooks in {EDAcontroller}.

.Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Setting up a {PlatformName} credential

[role="_abstract"]
You can create a {PlatformName} credential type to run your rulebook activations.

.Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Setting up a rulebook activation

[role="_abstract"]
You can create and configure a rulebook activation within the {PlatformNameShort} Dashboard. This process ensures effective management and deployment of your event-driven automation.

.Prerequisites
Expand Down
1 change: 1 addition & 0 deletions downstream/modules/eda/proc-eda-test-with-K8s.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Testing with Kubernetes

[role="_abstract"]
With Kubernetes you can create an Ingress, or expose the port, but not for production.

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Viewing activation output

[role="_abstract"]
You can view the output of the activations in the *History* tab.

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

= Installing ansible-builder

[role="_abstract"]
To build images, you must have Podman or Docker installed, along with the `ansible-builder` Python package.

The `--container-runtime` option must correspond to the Podman or Docker executable you intend to use.
Expand Down