Chapter 3. Installing the Ansible plug-ins with the Operator on OpenShift Container Platform

1. In the OpenShift console, select the Topology view.
2. Click More actions ⋮ on the developer-hub instance and select Edit backstage to open the Backstage details page.
3. Select the YAML tab.

4. In the editing pane, add a containers block in the spec.deployment.patch.spec.template.spec block:

   apiVersion: rhdh.redhat.com/v1alpha3
   kind: Backstage
   metadata:
     name: developer-hub
   spec:
     deployment:
       patch:
         spec:
           template:
             spec:
               containers:
                 - command:
                     - adt
                     - server
                   image: registry.redhat.io/ansible-automation-platform-25/ansible-dev-tools-rhel8:latest
                   imagePullPolicy: always
                   ports:
                     - containerPort: 8000
                       protocol: TCP
                   terminationMessagePolicy: file

   Copy to Clipboard Toggle word wrap
5. Click Save.

1. In a browser, navigate to the Red Hat Ansible Automation Platform Product Software downloads page. and select the Product Software tab.

2. Click Download now next to Ansible plug-ins for Red Hat Developer Hub Setup Bundle to download the latest version of the plug-ins.

   The format of the filename is ansible-rhdh-plugins-x.y.z.tar.gz. Substitute the Ansible plug-ins release version, for example 2.0.0, for x.y.z.

3. Create a directory on your local machine to store the .tar files.

   $ mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>

   Copy to Clipboard Toggle word wrap

4. Set an environment variable ($DYNAMIC_PLUGIN_ROOT_DIR) to represent the directory path.

   $ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>

   Copy to Clipboard Toggle word wrap

5. Extract the ansible-rhdh-plugins-<version-number>.tar.gz contents to $DYNAMIC_PLUGIN_ROOT_DIR.

   $ tar --exclude='*code*' -xzf ansible-rhdh-plugins-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR

   Copy to Clipboard Toggle word wrap

   Substitute the Ansible plug-ins release version, for example 2.0.0, for x.y.z.

Procedure

1. Log in to your OpenShift Container Platform instance with credentials to create a new application.

2. Open your Red Hat Developer Hub OpenShift project.

   $ oc project <YOUR_DEVELOPER_HUB_PROJECT>

   Copy to Clipboard Toggle word wrap

3. Run the following commands to create a plug-in registry build in the OpenShift cluster.

   $ oc new-build httpd --name=plugin-registry --binary
   $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait
   $ oc new-app --image-stream=plugin-registry

   Copy to Clipboard Toggle word wrap

1. Click the plug-in registry to view the log.

   

   View larger image

   

   (1) Developer hub instance

   (2) Plug-in registry

2. Click the terminal tab and login to the container.

3. In the terminal, run ls to confirm that the .tar files are in the plugin registry.

   ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz
   ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz

   Copy to Clipboard Toggle word wrap

   The version numbers and file names can differ.

Procedure

1. Select ConfigMaps in the navigation pane of the OpenShift console.
2. Select the rhaap-dynamic-plugins-config ConfigMap from the list.
3. Select the YAML tab to edit the rhaap-dynamic-plugins-config ConfigMap.

4. In the data.dynamic-plugins.yaml.plugins block, add the three dynamic plug-ins from the plug-in registry.

   • For the integrity hash values, use the .integrity files in your $DYNAMIC_PLUGIN_ROOT_DIR directory that correspond to each plug-in, for example use ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity for the ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz plug-in.

   • Replace x.y.z with the correct version of the plug-ins.

     kind: ConfigMap
     apiVersion: v1
     metadata:
      name: rhaap-dynamic-plugins-config
     data:
      dynamic-plugins.yaml: |
        ...
        plugins:
          - disabled: false
            package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz'
            integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity
            pluginConfig:
              dynamicPlugins:
                frontend:
                  ansible.plugin-backstage-rhaap:
                    appIcons:
                      - importName: AnsibleLogo
                        name: AnsibleLogo
                    dynamicRoutes:
                      - importName: AnsiblePage
                        menuItem:
                          icon: AnsibleLogo
                          text: Ansible
                        path: /ansible
          - disabled: false
            package: >-
              http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
            integrity: <SHA512 value> # Use hash in ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz.integrity
            pluginConfig:
              dynamicPlugins:
                backend:
                  ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
          - ...<REDACTED>

     Copy to Clipboard Toggle word wrap
5. Click Save.

6. To view the progress of the rolling restart:

   1. In the Topology view, select the deployment pod and click View logs.
   2. Select install-dynamic-plugins from the list of containers.

Verification

1. In the OpenShift console, select the Topology view.
2. Click the Open URL icon on the deployment pod to open your Red Hat Developer Hub instance in a browser window.

Procedure

1. Edit your custom Red Hat Developer Hub config map, app-config-rhdh, that you created in Adding a custom ConfigMap.

2. Add the following code to your Red Hat Developer Hub app-config-rhdh.yaml file.

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: app-config-rhdh
   ...
   data:
     app-config-rhdh.yaml: |-
       ansible:
         creatorService:
           baseUrl: 127.0.0.1
           port: '8000'
   ...

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a Personal Access Token (PAT) with “Read” scope in automation controller, following the Applications section of Access management and authentication.
2. Edit your custom Red Hat Developer Hub config map, for example app-config-rhdh.

3. Add your Ansible Automation Platform details to app-config-rhdh.yaml.

   1. Set the baseURL key with your automation controller URL.
   2. Set the token key with the generated token value that you created in Step 1.

   3. Set the checkSSL key to true or false.

      If checkSSL is set to true, the Ansible plug-ins verify whether the SSL certificate is valid.

      data:
        app-config-rhdh.yaml: |
          ...
          ansible:
          ...
            rhaap:
              baseUrl: '<https://MyControllerUrl>'
              token: '<AAP Personal Access Token>'
              checkSSL: true

      Copy to Clipboard Toggle word wrap

Procedure

1. Edit your custom Red Hat Developer Hub config map, for example app-config-rhdh.

2. Add the following code to your Red Hat Developer Hub app-config-rhdh.yaml file.

   data:
     app-config-rhdh.yaml: |
       catalog:
         ...
         locations:
           ...
           - type: url
             target: https://github.com/ansible/ansible-rhdh-templates/blob/main/all.yaml
             rules:
               - allow: [Template]

   Copy to Clipboard Toggle word wrap