Este contenido no está disponible en el idioma seleccionado.
Chapter 2. Configuring the Red Hat Ansible Automation Platform Operator on Red Hat OpenShift Container Platform
As a namespace administrator, you can use Ansible Automation Platform gateway to manage new Ansible Automation Platform components in your OpenShift environment.
The Ansible Automation Platform gateway uses the Ansible Automation Platform custom resource to manage and integrate the following Ansible Automation Platform components into a unified user interface:
- Automation controller
- Automation hub
- Event-Driven Ansible
- Red Hat Ansible Lightspeed (This feature is disabled by default, you must opt in to use it.)
Before you can deploy the platform gateway you must have Ansible Automation Platform Operator installed in a namespace. If you have not installed Ansible Automation Platform Operator see Installing the Red Hat Ansible Automation Platform Operator on Red Hat OpenShift Container Platform.
Platform gateway is only available under Ansible Automation Platform Operator version 2.5. Every component deployed under Ansible Automation Platform Operator 2.5 defaults to version 2.5.
If you have the Ansible Automation Platform Operator and some or all of the Ansible Automation Platform components installed see Deploying the platform gateway with existing Ansible Automation Platform components for how to proceed.
2.1. Linking your components to the platform gateway Copiar enlaceEnlace copiado en el portapapeles!
After installing the Ansible Automation Platform Operator in your namespace you can set up your Ansible Automation Platform instance. Then link all the platform components to a single user interface.
Procedure
- Log in to Red Hat OpenShift Container Platform.
-
Navigate to
. - Select your Ansible Automation Platform Operator deployment.
- Select the Details tab.
- On the Ansible Automation Platform tile click .
- From the Create Ansible Automation Platform page enter a name for your instance in the Name field.
Click and replace the
specsection with the following:Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
You must specify your desired value for the
<read-write-many-storage-class>placeholder. - Click .
Verification
Verify instance deployment (UI):
-
Navigate to
. - Select your Ansible Automation Platform Operator deployment.
- Select the All instances tab.
- Verify that the Ansible Automation Platform instance, Automation Controller, Event-Driven Ansible, and Automation Hub instances are listed.
Verify pod status (UI):
-
Navigate to
. - Switch to the project (namespace) where you deployed the instance.
- Verify that all related pods display a Running or Completed status.
Verify Platform Route (CLI):
Run the following command to confirm the URL for accessing the platform gateway:
oc get route
oc get route
2.2. Deploying the platform gateway with existing Ansible Automation Platform components Copiar enlaceEnlace copiado en el portapapeles!
You can link any components of the Ansible Automation Platform, that you have already installed to a new Ansible Automation Platform instance.
The following procedure simulates a scenario where you have automation controller as an existing component and want to add automation hub and Event-Driven Ansible.
Procedure
- Log in to Red Hat OpenShift Container Platform.
-
Navigate to
. - Select your Ansible Automation Platform Operator deployment.
- Click and edit your Update channel to stable-2.5.
- Click and on the Ansible Automation Platform tile click .
From the Create Ansible Automation Platform page enter a name for your instance in the Name field.
-
When deploying an Ansible Automation Platform instance, ensure that
auto_updateis set to the default value offalseon your existing automation controller instance in order for the integration to work.
-
When deploying an Ansible Automation Platform instance, ensure that
Click and copy in the following:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - For new components, if you do not specify a name, a default name is generated.
- Click .
To access your new instance, see Accessing the platform gateway.
NoteIf you have an existing controller with a managed Postgres pod, after creating the Ansible Automation Platform resource your automation controller instance will continue to use that original Postgres pod. If you were to do a fresh install you would have a single Postgres managed pod for all instances.
2.3. Accessing platform gateway through the OpenShift Container Platform UI Copiar enlaceEnlace copiado en el portapapeles!
Use the Ansible Automation Platform instance as your default. This instance links the automation controller, automation hub, and Event-Driven Ansible deployments to a single interface.
Procedure
- Log in to Red Hat OpenShift Container Platform.
-
Navigate to
- Click the link under Location for Ansible Automation Platform.
- This redirects you to the Ansible Automation Platform login page. Enter "admin" as your username in the Username field.
For the password you must:
-
Go to to
. - Click and copy the password.
- Paste the password into the Password field.
-
Go to to
- Click .
Apply your subscription:
- Click or .
- Upload your manifest or enter your username and password.
- Select your subscription from the Subscription list.
- Click . This redirects you to the Analytics page.
- Click .
- Select the I agree to the terms of the license agreement checkbox.
- Click .
Verification
You now have access to the platform gateway user interface.
Troubleshooting
If you cannot access the Ansible Automation Platform see Frequently asked questions on platform gateway for help with troubleshooting and debugging.
2.4. Accessing platform gateway through the OpenShift Container Platform CLI Copiar enlaceEnlace copiado en el portapapeles!
You can use the OpenShift Container Platform CLI to fetch the web address and the password of the Automation controller that you created. To login to the platform gateway, you need the web address and the password.
2.4.1. Fetching the platform gateway web address Copiar enlaceEnlace copiado en el portapapeles!
A Red Hat OpenShift Container Platform route exposes a service at a host name, so that external clients can reach it by name. When you created the platform gateway instance, a route was created for it. The route inherits the name that you assigned to the platform gateway object in the YAML file.
Procedure
Use the following command to fetch the routes:
oc get routes -n <platform_namespace>
oc get routes -n <platform_namespace>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Verification
You can see in the following example, the
exampleplatform gateway is running in theansible-automation-platformnamespace.
oc get routes -n ansible-automation-platform
$ oc get routes -n ansible-automation-platform
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
example example-ansible-automation-platform.apps-crc.testing example-service http edge/Redirect None
The address for the platform gateway instance is example-ansible-automation-platform.apps-crc.testing.
2.4.2. Fetching the platform gateway password Copiar enlaceEnlace copiado en el portapapeles!
The YAML block for the platform gateway instance in the AnsibleAutomationPlatform object assigns values to the name and admin_user keys.
Procedure
Use these values in the following command to fetch the password for the platform gateway instance.
oc get secret/<your instance name>-<admin_user>-password -o yaml
oc get secret/<your instance name>-<admin_user>-password -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow The default value for admin_user is
admin. Modify the command if you changed the admin username in theAnsibleAutomationPlatformobject.The following example retrieves the password for a platform gateway object called
example:oc get secret/example-admin-password -o yaml
oc get secret/example-admin-password -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow The base64 encoded password for the platform gateway instance is listed in the
metadatafield in the output:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.4.3. Decoding the platform gateway password Copiar enlaceEnlace copiado en el portapapeles!
After you have fetched your gateway password, you must decode it from base64.
Procedure
- Run the following command to decode your password from base64:
oc get secret/example-admin-password -o jsonpath={.data.password} | base64 --decode
oc get secret/example-admin-password -o jsonpath={.data.password} | base64 --decode