Chapter 3. Deploying cluster logging

Ensure that openshift-operators-redhat is selected under Installed Namespace.

You must specify the openshift-operators-redhat Namespace. To prevent possible conflicts with metrics, you should configure the Prometheus Cluster Monitoring stack to scrape metrics from the openshift-operators-redhat Namespace and not the openshift-operators Namespace. The openshift-operators Namespace might contain Community Operators, which are untrusted and could publish a metric with the same name as an OpenShift Container Platform metric, which would cause conflicts.

Select Enable operator recommended cluster monitoring on this namespace.

This option sets the openshift.io/cluster-monitoring: "true" label in the Namespace object. You must select this option to ensure that cluster monitoring scrapes the openshift-operators-redhat Namespace.

Select Enable operator recommended cluster monitoring on this namespace.

This option sets the openshift.io/cluster-monitoring: "true" label in the Namespace object. You must select this option to ensure that cluster monitoring scrapes the openshift-logging namespace.

Ensure that Cluster Logging is listed in the openshift-logging project with a Status of Succeeded.

If the Operator does not appear as installed, to troubleshoot further:

On the ClusterLoggings page, click Create ClusterLogging.

You might have to refresh the page to load the data.

In the YAML field, replace the code with the following:

apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
  name: "instance" 1
  namespace: "openshift-logging"
spec:
  managementState: "Managed"  2
  logStore:
    type: "elasticsearch"  3
    elasticsearch:
      nodeCount: 3 4
      storage:
        storageClassName: "<storage-class-name>" 5
        size: 200G
      redundancyPolicy: "SingleRedundancy"
  visualization:
    type: "kibana"  6
    kibana:
      replicas: 1
  curation:
    type: "curator"  7
    curator:
      schedule: "30 3 * * *"
  collection:
    logs:
      type: "fluentd"  8
      fluentd: {}

$ oc get deployment

cluster-logging-operator       1/1     1            1           18h
elasticsearch-cd-x6kdekli-1    0/1     1            0           6m54s
elasticsearch-cdm-x6kdekli-1   1/1     1            1           18h
elasticsearch-cdm-x6kdekli-2   0/1     1            0           6m49s
elasticsearch-cdm-x6kdekli-3   0/1     1            0           6m44s

Select the openshift-logging project.

You should see several pods for cluster logging, Elasticsearch, Fluentd, and Kibana similar to the following list:

Create a Namespace object YAML file (for example, eo-namespace.yaml) for the Elasticsearch Operator:

apiVersion: v1
kind: Namespace
metadata:
  name: openshift-operators-redhat 1
  annotations:
    openshift.io/node-selector: ""
  labels:
    openshift.io/cluster-monitoring: "true" 2

Create the Namespace:

$ oc create -f <file-name>.yaml

For example:

$ oc create -f eo-namespace.yaml

Create a Namespace object YAML file (for example, clo-namespace.yaml) for the Cluster Logging Operator:

apiVersion: v1
kind: Namespace
metadata:
  name: openshift-logging
  annotations:
    openshift.io/node-selector: ""
  labels:
    openshift.io/cluster-monitoring: "true"

Create the Namespace:

$ oc create -f <file-name>.yaml

For example:

$ oc create -f clo-namespace.yaml

Create an Operator Group object YAML file (for example, eo-og.yaml) for the Elasticsearch operator:

apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: openshift-operators-redhat
  namespace: openshift-operators-redhat 1
spec: {}

Create an Operator Group object:

$ oc create -f <file-name>.yaml

For example:

$ oc create -f eo-og.yaml

Create a Subscription object YAML file (for example, eo-sub.yaml) to subscribe a Namespace to the Elasticsearch Operator.

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: "elasticsearch-operator"
  namespace: "openshift-operators-redhat" 1
spec:
  channel: "4.4" 2
  installPlanApproval: "Automatic"
  source: "redhat-operators" 3
  sourceNamespace: "openshift-marketplace"
  name: "elasticsearch-operator"

Create the Subscription object:

$ oc create -f <file-name>.yaml

For example:

$ oc create -f eo-sub.yaml

The Elasticsearch Operator is installed to the openshift-operators-redhat Namespace and copied to each project in the cluster.

Verify the Operator installation:

oc get csv --all-namespaces

NAMESPACE                                               NAME                                         DISPLAY                  VERSION               REPLACES   PHASE
default                                                 elasticsearch-operator.4.4.0-202004222248    Elasticsearch Operator   4.4.0-202004222248               Succeeded
kube-node-lease                                         elasticsearch-operator.4.4.0-202004222248    Elasticsearch Operator   4.4.0-202004222248               Succeeded
kube-public                                             elasticsearch-operator.4.4.0-202004222248    Elasticsearch Operator   4.4.0-202004222248               Succeeded
kube-system                                             elasticsearch-operator.4.4.0-202004222248    Elasticsearch Operator   4.4.0-202004222248               Succeeded
openshift-apiserver-operator                            elasticsearch-operator.4.4.0-202004222248    Elasticsearch Operator   4.4.0-202004222248               Succeeded
openshift-apiserver                                     elasticsearch-operator.4.4.0-202004222248    Elasticsearch Operator   4.4.0-202004222248               Succeeded
openshift-authentication-operator                       elasticsearch-operator.4.4.0-202004222248    Elasticsearch Operator   4.4.0-202004222248               Succeeded
openshift-authentication                                elasticsearch-operator.4.4.0-202004222248    Elasticsearch Operator   4.4.0-202004222248               Succeeded
...

There should be an Elasticsearch Operator in each Namespace. The version number might be different than shown.

Create an OperatorGroup object YAML file (for example, clo-og.yaml) for the Cluster Logging Operator:

apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: cluster-logging
  namespace: openshift-logging 1
spec:
  targetNamespaces:
  - openshift-logging 2

Create the OperatorGroup object:

$ oc create -f <file-name>.yaml

For example:

$ oc create -f clo-og.yaml

Create a Subscription object YAML file (for example, clo-sub.yaml) to subscribe a Namespace to the Cluster Logging Operator.

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: cluster-logging
  namespace: openshift-logging
spec:
  channel: "4.4"
  name: cluster-logging
  source: redhat-operators
  sourceNamespace: openshift-marketplace

Create the Subscription object:

$ oc create -f <file-name>.yaml

For example:

$ oc create -f clo-sub.yaml

The Cluster Logging Operator is installed to the openshift-logging Namespace.

Verify the Operator installation.

There should be a Cluster Logging Operator in the openshift-logging Namespace. The Version number might be different than shown.

oc get csv -n openshift-logging

NAMESPACE                                               NAME                                         DISPLAY                  VERSION               REPLACES   PHASE
...
openshift-logging                                       clusterlogging.4.4.0-202004222248            Cluster Logging          4.4.0-202004222248              Succeeded
...

Create an instance object YAML file (for example, clo-instance.yaml) for the Cluster Logging Operator:

apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
  name: "instance" 1
  namespace: "openshift-logging"
spec:
  managementState: "Managed"  2
  logStore:
    type: "elasticsearch"  3
    elasticsearch:
      nodeCount: 3 4
      storage:
        storageClassName: "<storage-class-name>" 5
        size: 200G
      redundancyPolicy: "SingleRedundancy"
  visualization:
    type: "kibana"  6
    kibana:
      replicas: 1
  curation:
    type: "curator"  7
    curator:
      schedule: "30 3 * * *"
  collection:
    logs:
      type: "fluentd"  8
      fluentd: {}

$ oc get deployment

cluster-logging-operator       1/1     1            1           18h
elasticsearch-cd-x6kdekli-1    1/1     1            0           6m54s
elasticsearch-cdm-x6kdekli-1   1/1     1            1           18h
elasticsearch-cdm-x6kdekli-2   1/1     1            0           6m49s
elasticsearch-cdm-x6kdekli-3   1/1     1            0           6m44s

Create the instance:

$ oc create -f <file-name>.yaml

For example:

$ oc create -f clo-instance.yaml