Chapter 5. Upgrading the Ansible plug-ins on an Operator installation on OpenShift Container Platform

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

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 UI, open the ConfigMap where you added the Ansible plug-ins during installation. This example uses a ConfigMap file called rhaap-dynamic-plugins-config.
3. Update x.y.z with the version numbers for the updated Ansible plug-ins.

4. Update the integrity values for each plug-in with the .integrity value from the corresponding extracted Ansible plug-ins .tar file.

   kind: ConfigMap
   apiVersion: v1
   metadata:
    name: rhaap-dynamic-plugins-config
   data:
    dynamic-plugins.yaml: |
      ...
      plugins: # Update the Ansible plug-in entries below with the updated plugin versions
        - 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
   	 ...
        - 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
   	 ...

   Copy to Clipboard Toggle word wrap

5. Click Save.

   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.