Install operators

Install operators using Workspace

Use the following procedure to install operators to OpenShift clusters from your Workspace.

Prerequisites

Procedure

  1. On the main menu, click Workspace, and then click My Software.
  2. Click the product tile. The product page shows. On the Documentation tab, review available material related to product installation.
  3. Click the Operators tab, and then click Install operator. Note: when a product contains multiple operators, a list of available operators shows. Select an option from the list.
  4. Select target clusters from the list, and then click Next. Note: Only registered, connected clusters that are compatible with the operator version show.
  5. Define each target cluster.
  6. To install operators, click Install. It may take several minutes for installation to complete.

Result

The operator installs to your target clusters.

Next steps

Verify operators installed successfully


Verify operators installed successfully

To verify that operators successfully installed, go to your OpenShift console. The operator shows on the following OpenShift console pages:

  • Projects
  • Pods
  • Installed Operators

Installation status descriptions

The following describes each of the possible status values an operator can have after being installed.

StatusDescription
InstallingOperator has been configured to be installed on a cluster and is being processed.
UninstallingOperator has been configured to be removed and is being processed.
UpdatingOperator is processing an update deployed from the channel subscribed to.
Up to dateOperator has been successfully installed.
FailedOperator installation did not successfully complete.
Updates availableOperator has updates that are ready to be deployed.

Install operator parameter descriptions

The following describes options on the Install Operator page.

Note: descriptions provided by OpenShift

ParameterDescription
Update ChannelWhen an operator is available through multiple channels, you can choose which channel you want to subscribe to. For example, to deploy from the stable channel, when available, select it from the list.
Approval StrategyYou can choose Automatic or Manual updates. When you choose Automatic updates for an installed operator, when a new version of that operator is available, the Operator Lifecycle Manager (OLM) automatically upgrades the running instance of your Operator without human intervention. If you select Manual updates, when a newer version of an Operator is available, the OLM creates an update request. As a cluster administrator, you must then manually approve that update request to have the Operator updated to the new version.
Namespace ScopeChoose where to have the operator installed either on all namespaces or individual namespaces, when available, to only install the operator on selected namespaces.

Uninstall operators using Workspace

Use the following procedure to uninstall operators from OpenShift clusters using Workspace.

Procedure

  1. On the main menu, click Workspace, click My Software, click on the product box, and then click the Operators tab.
  2. Find the operator you want to uninstall, open the overflow menu, and click Uninstall.
  3. Confirm that you want to Uninstall the operator.

Result

The operator uninstalls from target clusters. Within 5 minutes, the operator no longer shows on Installed operators.


Uninstall operators using OpenShift console

Use the following procedure to uninstall operators using OpenShift console.

Procedure

  1. Open OpenShift cluster console
  2. On the left nav, click Operators, and then click Installed Operators.
  3. Next to Project:, select the namespace where you installed the operator or select all projects.
  4. Find the operator you want to uninstall, open the overflow menu, and click Uninstall Operator.
  5. Confirm that you want to Remove the operator.

Result

The operator uninstalls from target clusters. Within 5 minutes, the operator no longer shows on Installed operators.


About operator managed applications

After operator installation, to start using products, go to your OpenShift console and create an instance. Each product should have installation instructions to follow.

Permissions

To grant users access to this feature, Cluster admins can run the following command:

oc policy add-role-to-user edit <user> -n <target_project>

For more information, view documentation on OpenShift.

Data and messaging

For more information on data and messaging, refer to the Red Hat Marketplace Operator section.