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
6 changes: 4 additions & 2 deletions downstream/attributes/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@
:AAPCentralAuth: Ansible Automation Platform Central Authentication
:CentralAuthStart: Central authentication
:CentralAuth: central authentication
:PlatformVers: 2.6
:PlatformVers: 2.7
:AAPRegistryNS: ansible-automation-platform-27
:AAPRHELVer: rhel9
:PostgresVers: PostgreSQL 15
//The ansible-core version used to install AAP
:CoreInstVers: 2.14
//The ansible-core version used by the AAP control plane and EEs
:CoreUseVers: 2.16
:PlatformDownloadUrl: https://access.redhat.com/downloads/content/480/ver=2.6/rhel---9/2.6/x86_64/product-software
:PlatformDownloadUrl: https://access.redhat.com/downloads/content/480/ver=2.7/rhel---9/2.7/x86_64/product-software
:BaseURL: https://docs.redhat.com/en/documentation
:VMBase: VM-based installation
:Installer: installation program
Expand Down
3 changes: 2 additions & 1 deletion downstream/modules/builder/con-building-definition-file.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The default definition filename, if not provided, is `execution-environment.yml`

The following is an example of a version 3 definition file. Each definition file must specify the major version number of the {Builder} feature set it uses. If not specified, {Builder} defaults to version 1, making most new features and definition keywords unavailable.

[subs="+attributes"]
----
version: 3

Expand All @@ -30,7 +31,7 @@ dependencies:

images:
base_image:
name: registry.redhat.io/ansible-automation-platform-26/ee-minimal-rhel9:latest
name: registry.redhat.io/{AAPRegistryNS}/ee-minimal-{AAPRHELVer}:latest

# Custom package manager path for the RHEL based images
options:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@ The ansible.mcp_builder collection is designed to run as a step in building an {
+
*Example `execution-environment.yml` configuration*:
+
[subs="+attributes"]
----
version: 3

images:
base_image:
name: ansible-automation-platform-26/ee-minimal-rhel9:latest
name: {AAPRegistryNS}/ee-minimal-{AAPRHELVer}:latest
dependencies:
galaxy: requirements.yml

Expand Down
5 changes: 3 additions & 2 deletions downstream/modules/builder/proc-build-ee-with-mcp-server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,15 @@ collections:

. Create `ee-build/execution-environment.yml` with this content:
+
[subs="+attributes"]
----
# execution-environment.yml
---
version: 3

images:
base_image:
name: registry.redhat.io/ansible-automation-platform-25/ee-minimal-rhel9:latest
name: registry.redhat.io/{AAPRegistryNS}/ee-minimal-{AAPRHELVer}:latest

dependencies:
galaxy: requirements.yml
Expand All @@ -77,7 +78,7 @@ Where

* `additional_build_files`: Copies your collection tarballs into the container build context so they can be referenced during the build.
* `additional_build_steps.append_final`: Runs your installation playbook in the final build stage, after collections are installed.
* `options.package_manager_path`: Set to `/usr/bin/microdnf` for `ee-minimal-rhel9`, or `/usr/bin/dnf` for UBI9-based images.
* `options.package_manager_path`: Set to `/usr/bin/microdnf` for `ee-minimal-{AAPRHELVer}`, or `/usr/bin/dnf` for UBI9-based images.

. Run ansible-builder to build your {ExecEnvShort} image:
+
Expand Down
10 changes: 6 additions & 4 deletions downstream/modules/builder/proc-customize-ee-image.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[role="_abstract"]
You can customize existing {ControllerNameStart} provided default {ExecEnvName} by adding content specific to your needs. {ControllerNameStart} includes the following default {ExecEnvName}.

* `Minimal` - `ansible-automation-platform-26` Includes the latest Ansible-core 2.19 release along with Ansible Runner, but does not include collections or other content.
* `Minimal` - `{AAPRegistryNS}` Includes the latest Ansible-core 2.19 release along with Ansible Runner, but does not include collections or other content.
+
While supported {ExecEnvShort}s cover many automation prerequisites, minimal execution-environments are the recommended basis for your own custom images, to keep full control over dependencies and their versions.
* `EE Supported` - Minimal, plus all Red Hat-supported collections and dependencies
Expand All @@ -22,8 +22,9 @@ $ podman login -u="[username]" -p="[token/hash]" registry.redhat.io
----
. Ensure that you can pull the required {ExecEnvNameSing} base image:
+
[subs="+attributes"]
-----
podman pull registry.redhat.io/ansible-automation-platform-26/ee-minimal-rhel8:latest
podman pull registry.redhat.io/{AAPRegistryNS}/ee-minimal-{AAPRHELVer}:latest
-----
+
. Configure your {Builder} files to specify the required base image and any additional content to add to the new {ExecEnvShort} image.
Expand All @@ -38,12 +39,13 @@ collections:
. In the {ExecEnvShort} definition file, specify the original `ee-minimal` container's URL and tag in the `EE_BASE_IMAGE` field.
In doing so, your final `execution-environment.yml` file looks similar to the following:
+
[subs="+attributes"]
----
version: 3

images:
base_image:
name: 'registry.redhat.io/ansible-automation-platform-25/ee-minimal-rhel9:latest'
base_image:
name: 'registry.redhat.io/{AAPRegistryNS}/ee-minimal-{AAPRHELVer}:latest'

dependencies:
galaxy:
Expand Down
2 changes: 1 addition & 1 deletion downstream/modules/builder/ref-definition-file-images.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ A `name` key is required for the container image to use.
Specify the `signature _original_name` key if the image is mirrored within your repository, but is signed with the image's original signature key.
Image names must contain a tag, such as `:latest`.

The default image is `registry.redhat.io/ansible-automation-platform-26/ee-minimal-rhel8:latest`.
The default image is `registry.redhat.io/{AAPRegistryNS}/ee-minimal-{AAPRHELVer}:latest`.

|===
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ $ ansible-navigator run <playbook_name.yml> -eei <execution_environment_name>
----
For example, to execute a playbook called `site.yml` on the {PlatformNameShort} RHEL 9 minimum execution environment, run the following command from the terminal in VS Code.
+
[subs="+attributes"]
----
ansible-navigator run site.yml --eei ee-minimal-rhel8
ansible-navigator run site.yml --eei ee-minimal-{AAPRHELVer}
----

.Verification
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ link:https://catalog.redhat.com/search?searchType=containers&build_categories_li
+
For example, to download the minimal RHEL 8 base image, run the following command:
+
[subs="+attributes"]
----
$ podman pull registry.redhat.io/ansible-automation-platform-26/ee-minimal-rhel9
$ podman pull registry.redhat.io/{AAPRegistryNS}/ee-minimal-{AAPRHELVer}
----
+
You can build and create custom execution environments with `ansible-builder`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ You must update the Helm chart configuration to add an extra container.
+
Add the following code:
+
[subs="+attributes"]
----
upstream:
backstage:
Expand All @@ -23,7 +24,7 @@ upstream:
- adt
- server
image: >-
registry.redhat.io/ansible-automation-platform-26/ansible-dev-tools-rhel9:latest
registry.redhat.io/{AAPRegistryNS}/ansible-dev-tools-{AAPRHELVer}:latest
imagePullPolicy: IfNotPresent
name: ansible-devtools-server
ports:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ To do this, you must modify the base ConfigMap for the {RHDH} deployment.
. Select the *YAML* tab.
. In the editing pane, add a `containers` block in the `spec.deployment.patch.spec.template.spec` block:
+
[subs="+attributes"]
----
apiVersion: rhdh.redhat.com/v1alpha4
kind: Backstage
Expand All @@ -29,7 +30,7 @@ spec:
- command:
- adt
- server
image: registry.redhat.io/ansible-automation-platform-26/ansible-dev-tools-rhel9:latest
image: registry.redhat.io/{AAPRegistryNS}/ansible-dev-tools-{AAPRHELVer}:latest
imagePullPolicy: always
ports:
- containerPort: 8000
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ For HTTP plug-in registry, remove the `http://plugin-registry:8080/\...` entries

. Remove the `extraContainers` section.
+
[subs="+attributes"]
----
upstream:
backstage:
Expand All @@ -44,7 +45,7 @@ upstream:
- adt
- server
image: >-
registry.redhat.io/ansible-automation-platform-26/ansible-dev-tools-rhel9:latest
registry.redhat.io/{AAPRegistryNS}/ansible-dev-tools-{AAPRHELVer}:latest
imagePullPolicy: IfNotPresent
name: ansible-devtools-server
ports:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ you must modify the base ConfigMap for the {RHDH} deployment.

. In the editing pane, remove the `containers` block for the sidecar container from the `spec.deployment.patch.spec.template.spec` block:
+
[subs="+attributes"]
----
...
spec:
Expand All @@ -32,7 +33,7 @@ spec:
- command:
- adt
- server
image: registry.redhat.io/ansible-automation-platform-26/ansible-dev-tools-rhel9:latest
image: registry.redhat.io/{AAPRegistryNS}/ansible-dev-tools-{AAPRHELVer}:latest
imagePullPolicy: always
ports:
- containerPort: 8000
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,20 +54,11 @@ $ podman push <disconnected_registry_url>/<your_namespace>/ansible-automation-pl
----
. Mirror the Ansible Dev Tools sidecar image. Use the path that matches your {PlatformNameShort} version:
+
*{PlatformNameShort} 2.5:*
+
----
$ podman pull registry.redhat.io/ansible-automation-platform-25/ansible-dev-tools-rhel9:latest
$ podman tag registry.redhat.io/ansible-automation-platform-25/ansible-dev-tools-rhel9:latest <disconnected_registry_url>/<your_namespace>/ansible-automation-platform-25/ansible-dev-tools-rhel9:latest
$ podman push <disconnected_registry_url>/<your_namespace>/ansible-automation-platform-25/ansible-dev-tools-rhel9:latest
----
+
*{PlatformNameShort} 2.6:*
+
[subs="+attributes"]
----
$ podman pull registry.redhat.io/ansible-automation-platform-26/ansible-dev-tools-rhel9:latest
$ podman tag registry.redhat.io/ansible-automation-platform-26/ansible-dev-tools-rhel9:latest <disconnected_registry_url>/<your_namespace>/ansible-automation-platform-26/ansible-dev-tools-rhel9:latest
$ podman push <disconnected_registry_url>/<your_namespace>/ansible-automation-platform-26/ansible-dev-tools-rhel9:latest
$ podman pull registry.redhat.io/{AAPRegistryNS}/ansible-dev-tools-{AAPRHELVer}:latest
$ podman tag registry.redhat.io/{AAPRegistryNS}/ansible-dev-tools-{AAPRHELVer}:latest <disconnected_registry_url>/<your_namespace>/{AAPRegistryNS}/ansible-dev-tools-{AAPRHELVer}:latest
$ podman push <disconnected_registry_url>/<your_namespace>/{AAPRegistryNS}/ansible-dev-tools-{AAPRHELVer}:latest
----


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ You can create an Ansible playbook leveraging the Execution Environment (EE) set

. Create the `execution-environment.yml` definition file, which specifies a step to install the MCP server components:
+
[source,yaml,subs="+quotes"]
[source,yaml,subs="+quotes,+attributes"]
....
---
version: 3

images:
base_image:
name: ansible-automation-platform-26/ee-minimal-rhel9:latest
name: {AAPRegistryNS}/ee-minimal-{AAPRHELVer}:latest
dependencies:
galaxy: requirements.yml

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[role="_abstract"]
This example provides a full YAML configuration for the Helm chart using OCI container delivery.

[subs="+attributes"]
----
global:
dynamic:
Expand Down Expand Up @@ -47,7 +48,7 @@ upstream:
- adt
- server
image: >-
registry.redhat.io/ansible-automation-platform-26/ansible-dev-tools-rhel9:latest
registry.redhat.io/{AAPRegistryNS}/ansible-dev-tools-{AAPRHELVer}:latest
imagePullPolicy: IfNotPresent
name: ansible-devtools-server
ports:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,14 @@ Customize a decision environment container image to ensure your rulebook activat

** If you want to connect {EDAcontroller} to {PlatformNameShort} 2.4, you must use `registry.redhat.io/ansible-automation-platform-24/de-minimal-rhel9:latest` (recommended) or `registry.redhat.io/ansible-automation-platform-24/de-minimal-rhel8:latest`
** If you want to connect {EDAcontroller} to {PlatformNameShort} 2.5, you must use `registry.redhat.io/ansible-automation-platform-25/de-minimal-rhel9:latest` (recommended) or `registry.redhat.io/ansible-automation-platform-25/de-minimal-rhel8:latest`
** If you want to connect {EDAcontroller} to {PlatformNameShort} {PlatformVers}, you must use `registry.redhat.io/ansible-automation-platform-26/de-minimal-rhel9:latest`
** If you want to connect {EDAcontroller} to {PlatformNameShort} 2.6, you must use `registry.redhat.io/ansible-automation-platform-26/de-minimal-rhel9:latest`
** If you want to connect {EDAcontroller} to {PlatformNameShort} {PlatformVers}, you must use `registry.redhat.io/{AAPRegistryNS}/de-minimal-{AAPRHELVer}:latest`
====

.Procedure

. 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-26/de-minimal-rhel9/6449633cfb26ed69bfc5d755[{PlatformNameShort} minimal decision environment].
This image is built from a base image provided by Red Hat at link:https://catalog.redhat.com/software/containers/ansible-automation-platform-27/de-minimal-rhel9/6449633cfb26ed69bfc5d755[{PlatformNameShort} minimal decision environment].
+
[IMPORTANT]
====
Expand All @@ -34,12 +35,13 @@ The `ansible.eda` collection is already installed in the `de-minimal` base image
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 `servicenow.itsm` collection:
+

[subs="+attributes"]
----
version: 3

images:
base_image:
name: 'registry.redhat.io/ansible-automation-platform-26/de-minimal-rhel9:latest'
name: 'registry.redhat.io/{AAPRegistryNS}/de-minimal-{AAPRHELVer}:latest'

dependencies:
galaxy:
Expand All @@ -59,12 +61,13 @@ options:
. Optional: If you need other Python packages or RPMs, add the following to a single definition file:
+

[subs="+attributes"]
----
version: 3

images:
base_image:
name: 'registry.redhat.io/ansible-automation-platform-26/de-minimal-rhel9:latest'
name: 'registry.redhat.io/{AAPRegistryNS}/de-minimal-{AAPRHELVer}:latest'

dependencies:
galaxy:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Set up a new decision environment to define the dedicated, containerized runtime

* You have set up a credential, if necessary.
For more information, see the link:https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/{PlatformVers}/html/using_automation_decisions/eda-credentials#eda-set-up-credential[Setting up credentials] section.
* You have pushed a decision environment image to an image repository or you chose to use the `de-minimal` link:https://catalog.redhat.com/en/software/containers/ansible-automation-platform-26/de-minimal-rhel9/66fed7ad6ae4c44aa5de8c72[image] located in link:http://registry.redhat.io/[registry.redhat.io].
* You have pushed a decision environment image to an image repository or you chose to use the `de-minimal` link:https://catalog.redhat.com/en/software/containers/ansible-automation-platform-27/de-minimal-rhel9/66fed7ad6ae4c44aa5de8c72[image] located in link:http://registry.redhat.io/[registry.redhat.io].

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Before configuring simplified event routing, you must prepare your {PlatformName

To successfully integrate GitHub event streams with rulebook activations, verify that the following components and configurations are in place:

* *Decision environment:* Use the image version that corresponds to your specific {PlatformNameShort} instance (for example, `de-minimal-rhel9`).
* *Decision environment:* Use the image version that corresponds to your specific {PlatformNameShort} instance (for example, `de-minimal-{AAPRHELVer}`).
* *Event stream credentials:* Configure credentials specifically for simplified event routing within the controller interface.
* *Project synchronization:* Ensure your Ansible project is synced to the Git repository containing your rulebook YAML files.
* *Plugin compatibility:* Verify that your decision environment supports the required event source plugins (for example, `eda.builtin`).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ For information about importing collections from {Galaxy} or {HubName} into a {P

Mirrored PyPI content once transferred into the disconnected network can be made available by using a web server or an artifact repository such as Nexus. The RHEL and UBI repository content can be exported from an internet-facing Red Hat Satellite Server, copied into the disconnected environment, then imported into a disconnected Satellite so it is available for building custom {ExecEnvShort}s. See link:{BaseURL}/red_hat_satellite/{SatelliteVers}/html-single/installing_satellite_server_in_a_disconnected_network_environment/index#iss_export_sync_in_an_air_gapped_scenario[ISS Export Sync in an Air-Gapped Scenario] for details.

The default base container image, `ee-minimal-rhel8`, is used to create custom {ExecEnvShort} images and is included with the bundled installer.
The default base container image, `ee-minimal-{AAPRHELVer}`, is used to create custom {ExecEnvShort} images and is included with the bundled installer.
This image is added to the {PrivateHubName} at install time.

If a different base container image such as `ee-minimal-rhel9` is required, it must be imported to the disconnected network and added to the {PrivateHubName} container registry.
If a different base container image such as `ee-minimal-{AAPRHELVer}` is required, it must be imported to the disconnected network and added to the {PrivateHubName} container registry.

Once all of the prerequisites are available on the disconnected network, the ansible-builder command can be used to create custom {ExecEnvShort} images.

Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,12 @@ $ cd builder/newee

. Create an `execution-environment.yml` file with the following content:
+
[subs="+attributes"]
----
version: 1

build_arg_defaults:
EE_BASE_IMAGE: 'registry.redhat.io/ansible-automation-platform-24/ee-supported-rhel8:latest'
EE_BASE_IMAGE: 'registry.redhat.io/{AAPRegistryNS}/ee-supported-{AAPRHELVer}:latest'

additional_build_steps:
prepend:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,13 @@ Version 3 of the {ExecEnvShort} definition format is required, so ensure the `ex
.. Define the additional build files needed to point to any disconnected content sources that will be used in the build process.
Your custom `execution-environment.yml` file should look similar to the following example:
+
[subs="+attributes"]
----
version: 3

images:
base_image:
name: private-hub.example.com/ee-minimal-rhel8:latest
name: private-hub.example.com/ee-minimal-{AAPRHELVer}:latest

dependencies:
python: requirements.txt
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@ Use the `oc adm must-gather` command to collect comprehensive diagnostic data ab

. To start the `must-gather` tool, run:
+
[subs="+attributes"]
----
oc adm must-gather --image=registry.redhat.io/ansible-automation-platform-26/aap-must-gather-rhel9
oc adm must-gather --image=registry.redhat.io/{AAPRegistryNS}/aap-must-gather-{AAPRHELVer}
----
+
[NOTE]
====
For version {PlatformVers}, the base image name changes to `registry.redhat.io/ansible-automation-platform-26/aap-must-gather-rhel9`.
For version {PlatformVers}, the base image name changes to `registry.redhat.io/{AAPRegistryNS}/aap-must-gather-{AAPRHELVer}`.
====
+
. View the collected data, use the `omc` tool to query the `must-gather` tarball as if it were a live cluster.
Expand Down
Loading