Enable Portworx OpenShift Dynamic Plugin

The Portworx OpenShift Dynamic plugin is an OpenShift console plugin that provides integrated storage observability and management directly within the OpenShift console. It simplifies Day-2 operations, monitoring, and troubleshooting for Portworx storage clusters, Kubernetes applications, and OpenShift integrations such as KubeVirt.

When enabled, the plugin adds:

• A Portworx option in the left navigation pane of the OpenShift console, allowing you to access details of your Portworx cluster.
• A Portworx tab on the KubeVirt VirtualMachine page, allowing you to view and manage PVCs or Disks for KubeVirt VMs.
  For more information, see Observing Portworx PVCs and Disks for KubeVirt VMs.
• Portworx tabs on other storage-related pages such as StorageClasses and PersistentVolumeClaims, allowing you to view detailed information about your Portworx-backed resources.

This topic describes the steps to enable the Portworx OpenShift Dynamic plugin from the OpenShift console. It also explains how to upgrade the plugin installed on your cluster.

Pre-requisites

Ensure that your cluster meets the following prerequisites before you enable Portworx OpenShift Dynamic plugin:

• Portworx version 3.4.0 or later installed.
• Portworx Operator version 25.3.1 or later installed.
• Run OpenShift version 4.16 or later.

Procedure

To enable the Portworx OpenShift Dynamic plugin, follow these steps:

1. Sign in to the OpenShift Container Platform web console.

2. From the left navigation pane, click Installed Operators.

3. Click Portworx Enterprise.

4. In the Console plugin section, click the pencil icon.
   The system displays the Console plugin enablement window.

5. Select Enable and click Save.
   The system enables the plugin and displays the Portworx option in the left navigation pane.

Upgrade Portworx OpenShift Dynamic Plugin

To upgrade the plugin and ensure your Portworx deployment is using the latest recommended components, follow the appropriate procedure based on your setup:

Automatic Upgrade of the Plugin

When you upgrade Portworx Enterprise, Portworx OpenShift Dynamic Plugin is automatically upgraded. The updated plugin version is aligned with the Portworx Enterprise version you are upgrading to.

Manual Upgrade of the Plugin using Storage Cluster

To upgrade the plugin to a version aligned with a specific Portworx Enterprise release, without upgrading Portworx Enterprise, use the StorageCluster specification as follows:

Add the autoUpdateComponents field to the StorageClusterspec:

kind: StorageCluster
spec:
  autoUpdateComponents: Once 

This prompts the Portworx Operator to reconcile all components and retrieve the latest images corresponding to the Portworx Enterprise version.

note

To upgrade only the plugin, you must create a ConfigMap to scope the update; otherwise, all components are upgraded.

Manual Upgrade of the Plugin using a ConfigMap

To upgrade the plugin to a version aligned with a specific Portworx Enterprise release, without upgrading Portworx Enterprise, by using a ConfigMap, follow these steps:

1. Download the latest Portworx version manifest:

   curl -o versions.yaml "https://install.portworx.com/$<portworx-version>/version?kbver=$<kubernetes-version>&opver=$<operator-version>"

   Replace:

   • <portworx_version> with the Portworx version you want to use.
   • <kubernetes-version> with the Kubernetes version you want to use.
   • <operator-version> with the Operator version you want to use.

2. Update the px-versions configmap with the downloaded version manifest:

   kubectl -n <px-namespace> delete configmap px-versions
   kubectl -n <px-namespace> create configmap px-versions --from-file=versions.yaml

3. Add the autoUpdateComponents field to the storage cluster specification:

   kind: StorageCluster
   spec:
     autoUpdateComponents: Once 

   This prompts the Portworx Operator to reconcile all components and retrieve the latest images from the configmap if available, or download them from the manifest if not.

Manual Upgrade of the Plugin to a Custom Version using a ConfigMap

To upgrade the plugin to a custom version, without upgrading Portworx Enterprise, by using a ConfigMap, follow these steps:

1. Update the configmap/px-versions with the desired custom plugin image.

2. Add the autoUpdateComponents field to the storage cluster specification:

   kind: StorageCluster
   spec:
     autoUpdateComponents: Once 

   This prompts the Portworx Operator to reconcile all components and retrieve the latest images from the configmap if available, or download them from the manifest if not.