Chapter 5. Install the Cluster Observability Operator
The Cluster Observability Operator provides log visualization in the OpenShift Container Platform web console. Install the Cluster Observability Operator if you want to view and query logs under Observe
The COO is optional. You can collect, store, and forward logs without it by using only the Loki Operator and Red Hat OpenShift Logging Operator. Install the COO only if you need the web console visualization feature.
5.1. Install the COO by using the CLI Copy linkLink copied to clipboard!
Install the Cluster Observability Operator to enable log visualization in the OpenShift Container Platform web console by using the OpenShift CLI (oc).
Prerequisites
- You have administrator permissions.
-
You have installed the OpenShift CLI (
oc).
Procedure
Create a
Subscriptionobject for the COO:apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: cluster-observability-operator namespace: openshift-operators spec: channel: development installPlanApproval: Automatic name: cluster-observability-operator source: redhat-operators sourceNamespace: openshift-marketplacespec.channel-
Specify
developmentas the channel. spec.namespace-
The COO installs into the
openshift-operatorsnamespace, which already has a pre-existingOperatorGroup. No additional namespace orOperatorGroupconfiguration is required. spec.source-
Specify
redhat-operatorsas the value. If your OpenShift Container Platform cluster is installed on a restricted network, specify the name of theCatalogSourceobject you created when you configured OLM.
Apply the
Subscriptionobject by running the following command:$ oc apply -f <filename>.yamlVerify that the operator installed successfully by running the following command:
$ oc get csv -n openshift-operators | grep cluster-observabilityYou get an output similar to the following example:
cluster-observability-operator.v0.4.2 Cluster Observability Operator 0.4.2 Succeeded
5.2. Install the COO by using the web console Copy linkLink copied to clipboard!
Install the Cluster Observability Operator to enable log visualization in the OpenShift Container Platform web console.
Prerequisites
-
You have access to the cluster with
cluster-adminprivileges. - You have access to the OpenShift Container Platform web console.
Procedure
-
In the OpenShift Container Platform web console, navigate to Operators
OperatorHub. -
Type
Cluster Observability Operatorin the Filter by keyword box. - Select the Cluster Observability Operator tile and click Install.
On the Install Operator page:
- Select development from the Update channel list.
Select openshift-operators from the Installed Namespace list.
NoteThe COO must be installed in the
openshift-operatorsnamespace.Select an Update approval strategy:
- Automatic updates the Operator automatically when a new version is available.
- Manual requires manual approval before updates are applied.
- Click Install.
Verification
-
Navigate to Operators
Installed Operators. -
Verify that the Cluster Observability Operator is listed with a status of Succeeded in the
openshift-operatorsnamespace.