Upgrading the RMF for z/OS plugin on Grafana

You must ensure that the RMF for z/OS Grafana plugin is up to date to leverage its enhanced functionalities. You can do so by either installing or upgrading to the latest version of the RMF for z/OS Grafana plugin.

About this task

The upgrade procedures differ based on the environment you used to install the Grafana server.
Methods Step #
Upgrading the RMF for z/OS Grafana plugin in the Grafana stand-alone application. Perform from step 1.
Upgrading the RMF for z/OS Grafana plugin in the Grafana within the Docker environment. Perform from step 4.

Procedure

  1. Stop the Grafana server.
  2. Run the following command to upgrade the plugin by using Grafana CLI:
    grafana cli plugins install ibm-rmf-app

    To upgrade to a specific version, use:

    grafana cli plugins install ibm-rmf-app <version>
    Note: This command installs the plugin from the Grafana plugin catalog, which hosts versions 2.0.1 and later. To install a version earlier than 2.0.1, see Installing RMF for z/OS Grafana plugin v2.0.0 or earlier.
    The CLI tool downloads the specified version of the plugin and replaces the existing files.
  3. Restart the Grafana server, and then go to step 7.
  4. Run the following command to stop the docker container:
    docker stop rmf-grafana
  5. Run the following command to remove the docker container:
    docker rm rmf-grafana

    Where rmf-grafana is the name of the container.

  6. Run the following command to upgrade the plugin by creating and running a container:
    docker run --name <container_name> \
    --hostname <hostname> \
    --detach \
    --restart <restart_policy> \
    --volume <volume_name>:<container_data_path> \
    --publish <host_port>:<container_port> \
    --env "GF_INSTALL_PLUGINS=<plugin_id>" \
    <image_name>
    Notes:
    • You must replace the value of <image_name> to the version of the Grafana image used.

    • The GF_INSTALL_PLUGINS environment variable installs the latest version from the Grafana plugin catalog. To install a specific version, append the version number (for example, ibm-rmf-app 2.0.1).

    For example,
    docker run --name rmf-grafana \
    --hostname rmf-grafana \ 
    --detach --restart unless-stopped \
    --volume rmf-grafana-data:/var/lib/grafana \
    --publish 3000:3000 \
    --env "GF_INSTALL_PLUGINS=ibm-rmf-app" \
    11.0.1
  7. Optional: To update or reset the dashboards to their default state, click Update / Reset.
    Note: Clicking Update / Reset deletes the destination folder with the reserved UID and re-installs all sample dashboards. Any customizations made to the sample dashboards will be lost.
  8. Optional: To update the sample dashboards, perform the following sub-steps:
    1. Go to More apps > IBM RMF.
      Note: The navigation of the Grafana user interface can differ based on the Grafana version that is currently installed.
    2. On the IBM RMF App page, follow the instructions provided to manage the sample dashboard deployment.
    3. To update or reset the dashboards to their default state, click Update / Reset.
      Note: Clicking Update / Reset deletes the destination folder with the reserved UID and re-installs all sample dashboards. Any customizations made to the sample dashboards will be lost.
    4. To remove installed sample dashboards, click Delete.

Results

You have updated the RMF for z/OS Grafana plugin.