Bookmark this page

Install Operators with the Web Console

Objectives

  • Install and update operators by using the web console and the Operator Lifecycle Manager.

Installing Operators with the Web Console

The OpenShift web console provides a graphical interface to the Operator Lifecycle Manager (OLM). The OperatorHub page lists available operators and provides an interface for installing them. The Installed Operators page lists installed operators. You can inspect and uninstall operators from the Installed Operators page.

The Install Operator Wizard

Navigate to OperatorsOperatorHub to display the list of available operators. The OperatorHub page displays operators, and has filters to locate operators by category, source, provider, subscription required, and other criteria.

Figure 7.1: Available operators

Click an operator to display further information.

Important

Before installing an operator, review the operator information and consult the operator documentation. You might need to configure the operator further for successful deployment.

Click Install to begin the Install Operator wizard.

You can choose installation options in the Install Operator wizard.

Update channel

You can choose the most suitable operator update channel for your requirements. For more information, refer to the section called “Operator Update Channels”.

Installation mode

The default All namespaces on the cluster (default) installation mode should be suitable for most operators. This mode configures the operator to monitor all namespaces for custom resources.

For example, an operator that deploys database servers defines a custom resource that describes a database server. When using the All namespaces on the cluster (default) installation mode, users can create those custom resources in their namespaces. Then, the operator deploys database servers in the same namespaces, along with other user workloads.

Cluster administrators can combine this mode with self-service features and other namespace-based features, such as role-based access control and network policies, to control user usage of operators.

Installed namespace

The OLM installs the operator workload to the selected namespace in this option. Some operators install by default to the openshift-operators namespace. Other operators suggest creating a namespace.

Although users might require access to the workloads that the operator manages, typically only cluster administrators require access to the operator workload.

Update approval

The OLM updates operators automatically when new versions are available. Choose manual updates to prevent automatic updates.

For an operator that includes monitoring in its definition, the wizard displays a further option to enable the monitoring. Adding monitoring from non-Red Hat operators is not supported.

The installation mode and installed namespace options are related. Review the documentation of the operator to learn the supported options.

After you configure the installation, click Install. The web console creates subscription and operator group resources according to the selected options in the wizard. After the installation starts, the web console displays progress information.

Viewing Installed Operators

When the OLM finishes installing an operator, click View Operator to display the Operator details page. You can also view information about installed operators by navigating to OperatorsInstalled Operators.

The Installed Operators page lists the installed cluster service version (CSV) resources that correspond to installed operators.

Every version of an operator has a CSV. The OLM uses information from the CSV to install the operator. The OLM updates the status key of the CSV with installation information.

CSVs are namespaced, so the Installed Operator page has a similar namespace filter to other web console pages. Operators that were installed with the "all namespaces" mode have a CSV in all namespaces.

Note

The operator installation mode determines which namespaces the operator monitors for custom resources. This mode is a distinct option from the installed namespace option, which determines the operator workload namespace.

The Installed Operators page shows information such as the operator status and available updates. Click an operator to navigate to the Operator details page.

The Operator details page contains the following tabs, where you can view further details and perform other actions.

Details

Displays information about the CSV.

YAML

Displays the CSV in YAML format.

Subscription

In this tab, you can change installation options, such as the update channel and update approval. This tab also links to the install plans of the operator. When you configure an operator for manual updates, you approve install plans for updates in this tab.

Events

Lists events that are related to the operator.

The Operator details page also has tabs for custom resources. For each custom resource that the operator defines, a web console tab lists all resources of that type. Additionally, the All instances tab aggregates all resources of types that the operator defines.

Using Operators

Custom resources are the most common way to interact with operators. You can create custom resources by using the custom resource tabs on the Installed Operators page. Select the tab to correspond to the custom resource type to create, and then click the create button.

Custom resources use the same creation page as other Kubernetes resources. You can choose either the YAML view or the form view to configure the new resource.

In the YAML view, you use the YAML editor to compose the custom resource. The editor provides a starting template that you can customize. The YAML view also displays documentation about the custom resource schema. The oc explain command provides the same documentation.

The form view presents a set of fields in a resource. Instead of composing a full YAML definition, you can edit the fields individually. When complete, OpenShift creates a resource from the values in the form.

Fields might provide help text and further configuration help. For example, fields with a limited set of values might provide a drop-down list with the possible values. The form view might provide more guidance, but might not contain fields to customize all possible options of a custom resource.

Troubleshooting Operators

The OLM might fail to install or update operators, or operators might not work correctly.

To identify operator installation issues, examine the status and conditions of the CSV, subscription, and install plan resources.

Note

Installation issues can be operator-specific, so consult the documentation of malfunctioning operators to determine support options.

To troubleshoot further issues that cause operators to work incorrectly, first identify the operator workload. The Operator Deployments field in the Operator details page shows operator workloads. Operators might create further workloads, including workloads that follow the definitions that you provide in custom resources.

Figure 7.2: Operator deployments

Identify and troubleshoot the operator workload as with any other Kubernetes workload. The following resources are common starting points when troubleshooting:

  • The status of Kubernetes workload resources, such as deployments or stateful sets

  • Pod logs and their status

  • Events

References

For more information, refer to the Installing from OperatorHub Using the Web Console section in the Administrator Tasks chapter in the Red Hat OpenShift Container Platform 4.14 Operators documentation at https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster

For more information about monitoring configuration, refer to the Maintenance and Support for Monitoring section in the Configuring the Monitoring Stack chapter in the Red Hat OpenShift Container Platform 4.14 Monitoring documentation at https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html-single/monitoring/index#maintenance-and-support_configuring-the-monitoring-stack

Revision: do280-4.14-08d11e1