Upgrade the Ansible plug-ins for an Operator environment

To upgrade the Ansible plug-ins, you must update the plugin-registry application with the latest Ansible plug-ins files.

Download the Ansible plug-ins files
Copy link

Download the Ansible plug-ins for Red Hat Developer Hub Setup Bundle from the Red Hat Ansible Automation Platform Product Software downloads page.

Procedure
Copy link

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

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

Results
Copy link

Run ls to verify that the extracted files are in the $DYNAMIC_PLUGIN_ROOT_DIR directory:

$ ls $DYNAMIC_PLUGIN_ROOT_DIR
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-backstage-rhaap-dynamic-x.y.z.tgz.integrity
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz
ansible-plugin-scaffolder-backend-module-backstage-rhaap-dynamic-x.y.z.tgz.integrity

The files with the .integrity file type contain the plugin SHA value. The SHA value is used during the plug-in configuration.

Update the plug-in registry
Copy link

Rebuild your plug-in registry application in your OpenShift cluster with the latest Ansible plug-ins files.

Before you begin
Copy link

  • You have downloaded the Ansible plug-ins files.
  • You have set an environment variable, for example $DYNAMIC_PLUGIN_ROOT_DIR, to represent the path to the local directory where you have stored the .tar files.

Procedure
Copy link

  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

Results
Copy link

Verify that the plugin-registry has been updated.

  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.

Update the Ansible plug-ins version numbers for an Operator installation
Copy link

To upgrade the Ansible plug-ins, you must edit the rhaap-dynamic-plugins-config ConfigMap to reference the new OCI image tag.

Procedure
Copy link

  1. Log in to your Red Hat OpenShift Container Platform instance.
  2. Navigate to ConfigMaps and select the rhaap-dynamic-plugins-config map.
  3. Select the YAML tab to edit the file.
  4. In the plugins list, update the version tag at the end of the package URL for both the frontend and backend plugins. 
    kind: ConfigMap
apiVersion: v1
metadata:
  name: rhaap-dynamic-plugins-config
data:
  dynamic-plugins.yaml: |
    includes:
      - dynamic-plugins.default.yaml
    plugins:
      # FRONTEND PLUGIN
      - disabled: false
        # UPDATE the version tag at the end of the URL (e.g., :2.1)
        package: 'oci:registry.redhat.io/ansible-automation-platform/automation-portal:2.1'
        pluginConfig:
          dynamicPlugins:
            frontend:
              ansible.plugin-backstage-rhaap:
                appIcons:
                  - importName: AnsibleLogo
                    name: AnsibleLogo
                dynamicRoutes:
                  - importName: AnsiblePage
                    menuItem:
                      icon: AnsibleLogo
                      text: Ansible
                    path: /ansible

      # BACKEND PLUGIN
      - disabled: false
        # UPDATE the version tag at the end of the URL (e.g., :2.1)
        package: 'oci:registry.redhat.io/ansible-automation-platform/automation-portal:2.1'
        pluginConfig:
          dynamicPlugins:
            backend:
              ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
  5. Click Save.

    The Red Hat Developer Hub detects the configuration change and reload the plug-ins automatically.

Results
Copy link

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