Install the Ansible automation portal Helm chart

You can use the configured secrets and plugin registry to install the Ansible automation portal. Deploy the application onto your OpenShift cluster using the provided Helm chart.

Configure the Helm chart from the OpenShift catalog
Copy link

Deploy the Helm chart from the OpenShift catalog by configuring the base URL and organization name in the YAML view. This launches the Ansible automation portal installation.

Before you begin
Copy link

  • You have created a project for Ansible automation portal in OpenShift Container Platform.
  • You have created secrets in OpenShift Container Platform for Red Hat Ansible Automation Platform authentication.
  • If you configure SCM integration (for example, importing from private repositories or using templates that access SCM), you have created secrets in OpenShift for SCM authentication.
  • You have completed the plug-in delivery prerequisites:
    • For OCI container delivery (default): You have created the <release-name>-dynamic-plugins-registry-auth secret.
    • For HTTP plug-in registry (deprecated): If you are overriding the default OCI delivery to use an in-cluster HTTP plug-in registry, you have deployed the plug-in registry and plan to set pluginMode to tarball.
  • Helm charts are enabled in the OpenShift Container Platform developer catalog. If the Automation Portal chart does not appear in the catalog, verify that the HelmChartRepository custom resources are not disabled. For more information, see Working with Helm charts in the OpenShift Container Platform documentation.

Procedure
Copy link

  1. In the OpenShift Container Platform web console, select the Developer perspective.
  2. Select your project and click the Helm option in the OpenShift sidebar.
  3. Click Create and select Helm Release.
  4. Search for Portal in the Helm Charts filter, and select the Automation Portal chart.
  5. Click Create and select the YAML view.
  6. Update the clusterRouterBase value with the base URL of your OpenShift instance.
    Important

    You must replace the default apps.example.com placeholder value. If the default value remains, Helm chart validation fails.

     
    redhat-developer-hub:
  global:
    clusterRouterBase: apps.example.com
  7. Configure the plug-in delivery mode and version by setting the imageTagInfo key:

    The Helm chart defaults to OCI container delivery (pluginMode: oci). Set imageTagInfo to the plug-in version from the Helm chart or the lifecycle page. To override the default and use the deprecated HTTP plug-in registry, set pluginMode to tarball.

    redhat-developer-hub:
  global:
    pluginMode: oci
    imageTagInfo: "<plugin-version>"
  8. Set the Red Hat Ansible Automation Platform organization to synchronize.

    The default value is Default. Update the orgs key to match your organization name:

    redhat-developer-hub:
    upstream:
      backstage:
        appConfig:
          catalog:
            providers:
              rhaap:
                '{{- include "catalog.providers.env" . }}':
                  orgs: "<your-aap-organization-name>"
  9. Optional: Update the CUSTOMER_SUPPORT_URL to point to your support portal: 
    redhat-developer-hub:
  upstream:
    backstage:
      extraEnvVars:
        - name: CUSTOMER_SUPPORT_URL
          value: https://access.redhat.com/support
  10. Optional: Configure collection discovery sources for the execution environment builder.

    If you plan to use the execution environment builder to automatically discover Ansible collections from Git repositories or Private Automation Hub, define the discovery providers under catalog.providers.rhaap.production.sync before deployment.

    For parameter syntax and complete examples, see Configure collection discovery sources.

  11. Click Create.

Verify the installation
Copy link

Verify the Helm chart installation from the OpenShift Container Platform web console.

Procedure
Copy link

  1. In a browser, log in to your OpenShift instance.
  2. In the Developer perspective, navigate to the Topology view for the namespace where you deployed the Helm chart.

    The deployment appears with the label D on the icon. The name of the deployment is <installation-name>-backstage, for example <my-self-service-automation-portal-backstage>.

    While it is deploying, the icon is light blue. The color changes to dark blue when deployment is complete.

    Figure 1. OpenShift deployment topology view
    Deployment on OpenShift console