Validated Patterns

Procedure: Changing Subscription to Use a specific Operator Version

This procedure outlines the steps to change an Operator subscription to use a specific version by updating the csv field and configuring the installation approval process.

This is required if an issue prevents the Operator from being successfully installed.

Procedure
  1. Change the values-hub.yaml file to include the following fields under subscriptions:

    • csv - Specifies the exact Operator version to install.

    • installPlanApproval - Set to Manual to prevent automatic installation.

      Update values-hub.yaml as follows:

      clusterGroup:
      ...
        subscriptions:
          acm:
            name: advanced-cluster-management
            namespace: open-cluster-management
            channel: release-2.11
            csv: advanced-cluster-management.v2.11.1
            installPlanApproval: Manual

      This change ensures that the specified version is not installed until manually approved.

  2. With the installPlanApproval set to Manual, follow these steps to manually approve the installation:

  3. Navigate to OperatorsInstalled Operators in the OpenShift Web Console.

  4. Locate the InstallPlans section.

  5. Find the pending install plan for the Operator.

  6. Click Review manual InstallPlan.

  7. Click Approve to proceed with the installation.

  8. Optional: Automate approval and deploy the specified Operator version without manual intervention:

    1. Edit the values-global.yaml file.

    2. Add the autoApproveManualInstallPlans variable and set it to true as shown below:

      global:
        options:
          autoApproveManualInstallPlans: true

This configuration generates a cronJob that runs every 5 minutes, automatically approving install plans that match the specified csv version.