Chapter 5. Upgrading the Ansible plug-ins on a Helm installation on OpenShift Container Platform

1. Download the latest .tar file for the plug-ins from the Red Hat Ansible Automation Platform Product Software downloads page. The format of the filename is ansible-backstage-rhaap-bundle-x.y.z.tar.gz. Substitute the Ansible plug-ins release version, for example 1.0.0, for x.y.z.

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

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

3. 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>

4. Extract the ansible-backstage-rhaap-bundle-<version-number>.tar.gz contents to $DYNAMIC_PLUGIN_ROOT_DIR.

   $ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR

   Substitute the Ansible plug-ins release version, for example 1.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>

3. Run the following commands to update your plug-in registry build in the OpenShift cluster. The commands assume that $DYNAMIC_PLUGIN_ROOT_DIR represents the directory for your .tar files. Replace this in the command if you have chosen a different environment variable name.

   $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait

4. When the registry has started, the output displays the following message:

   Uploading directory "/path/to/dynamic_plugin_root" as binary input for the build …
   Uploading finished
   build.build.openshift.io/plugin-registry-1 started

1. In the OpenShift UI, click Topology.
2. Click the redhat-developer-hub icon to view the pods for the plug-in registry.
3. Click View logs for the plug-in registry pod.
4. Open the Terminal tab and run ls to view the .tar files in the plug-in registry.
5. Verify that the new .tar file has been uploaded.

Procedure

1. Log in to your OpenShift Container Platform instance.
2. In the OpenShift Developer UI, navigate to Helm developer-hub Actions Upgrade Yaml view.

3. Update the Ansible plug-ins version numbers and associated .integrity file values.

   ...
   global:
   ...
       plugins:
         - disabled: false
           integrity: <SHA512 value>
           package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
           pluginConfig:
             dynamicPlugins:
               frontend:
                 ansible.plugin-backstage-rhaap:
                   appIcons:
                     - importName: AnsibleLogo
                       name: AnsibleLogo
                   dynamicRoutes:
                     - importName: AnsiblePage
                       menuItem:
                         icon: AnsibleLogo
                         text: Ansible
                       path: /ansible
         - disabled: false
           integrity: <SHA512 value>
           package: >-
             http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
           pluginConfig:
             dynamicPlugins:
               backend:
                 ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
         - disabled: false
           integrity: <SHA512 value>
           package: >-
             http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
           pluginConfig:
             dynamicPlugins:
               backend:
                 ansible.plugin-backstage-rhaap-backend: null

4. Click Upgrade.

   The developer hub pods restart and the plug-ins are installed.

Verification

1. In the OpenShift UI, click Topology.
2. Make sure that the Red Hat Developer Hub instance is available.