Chapter 8. Upgrading self-service automation portal

Procedure

1. Create a directory on your local machine to store the plug-in files.

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

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

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

4. Click Download now next to Ansible self-service automation portal Setup Bundle to download the latest version of the plug-ins.

   The format of the filename is self-service-automation-portal-plugins-x.y.z.tar.gz.

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

5. Extract the contents to $DYNAMIC_PLUGIN_ROOT_DIR:

   $ tar --exclude='*code*' -xzf self-service-automation-portal-plugins-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR

6. Verify that the extracted files are in the $DYNAMIC_PLUGIN_ROOT_DIR directory:

   ls $DYNAMIC_PLUGIN_ROOT_DIR

   You should see the following files:

   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 plug-in SHA value.

7. Create an httpd service as part of your OpenShift project:

Verification

1. Run the following command to verify that the plug-in registry deployed correctly:

   oc exec $(oc get pods -l deployment=plugin-registry -o jsonpath='{.items[0].metadata.name}') -- ls -l /opt/app-root/src

2. Confirm that the required tarball files are in the plug-in registry.

Procedure

1. In a terminal, log in to your OpenShift Container Platform instance.

2. Open your OpenShift project for self-service automation portal.

   $ oc project <YOUR_SELF_SERVICE_AUTOMATION_PORTAL_PROJECT>

3. Find the name of your current plug-in registry build configuration:

   $ oc get buildconfig

4. From the output, identify the correct build configuration name, for example aap-self-service-plugins.

5. Run the following command to start a new build in in your OpenShift project.

   $ oc start-build <build_config_name> --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait

   • The command assumes 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.
   • Replace <build_config_name> with the build configuration name you identified.

   When the build starts, the following message is displayed:

    Uploading directory "/path/to/dynamic_plugin_root" as binary input for the build ...
    Uploading finished

Verification

1. Open the Topology view in the Developer perspective for your project in the OpenShift web console.
2. Select the plugin registry icon to open the plugin-registry details pane.
3. In the Pods section of the plugin-registry details pane, select View logs for the new build pod. The format for the pod name is <build_config_name>-<build_number>-build.
4. Click the terminal tab and log in to the container.
5. In the terminal, run ls to view the TAR files in the plugin registry.
6. Verify that the new TAR files have been uploaded.