Chapter 8. Logging using LokiStack

Procedure

1. Install the Loki Operator Operator:

   1. In the OpenShift Container Platform web console, click Operators OperatorHub.
   2. Choose Loki Operator from the list of available Operators, and click Install.
   3. Under Installation Mode, select All namespaces on the cluster.

   4. Under Installed Namespace, select openshift-operators-redhat.

      You must specify the openshift-operators-redhat namespace. The openshift-operators namespace might contain Community Operators, which are untrusted and might publish a metric with the same name as an OpenShift Container Platform metric, which would cause conflicts.

   5. 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.

   6. Select an Approval Strategy.

      • The Automatic strategy allows Operator Lifecycle Manager (OLM) to automatically update the Operator when a new version is available.
      • The Manual strategy requires a user with appropriate credentials to approve the Operator update.
   7. Click Install.
   8. Verify that you installed the Loki Operator. Visit the Operators Installed Operators page and look for Loki Operator.
   9. Ensure that Loki Operator is listed with Status as Succeeded in all the projects.

2. Create a Secret YAML file that uses the access_key_id and access_key_secret fields to specify your AWS credentials and bucketnames, endpoint and region to define the object storage location. For example:

   apiVersion: v1
   kind: Secret
   metadata:
     name: logging-loki-s3
     namespace: openshift-logging
   stringData:
     access_key_id: AKIAIOSFODNN7EXAMPLE
     access_key_secret: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
     bucketnames: s3-bucket-name
     endpoint: https://s3.eu-central-1.amazonaws.com
     region: eu-central-1

3. Create the LokiStack custom resource (CR):

   apiVersion: loki.grafana.com/v1
   kind: LokiStack
   metadata:
     name: logging-loki
     namespace: openshift-logging
   spec:
     size: 1x.small
     storage:
       schemas:
       - version: v12
         effectiveDate: "2022-06-01"
       secret:
         name: logging-loki-s3
         type: s3
     storageClassName: gp2
     tenants:
       mode: openshift-logging

4. Apply the LokiStack CR:

   $ oc apply -f logging-loki.yaml

5. Create a ClusterLogging custom resource (CR):

   apiVersion: logging.openshift.io/v1
   kind: ClusterLogging
   metadata:
     name: instance
     namespace: openshift-logging
   spec:
     managementState: Managed
     logStore:
       type: lokistack
       lokistack:
         name: logging-loki
     collection:
       type: vector

6. Apply the ClusterLogging CR:

   $ oc apply -f cr-lokistack.yaml

7. Enable the RedHat OpenShift Logging Console Plugin:

   1. In the OpenShift Container Platform web console, click Operators Installed Operators.
   2. Select the RedHat OpenShift Logging Operator.
   3. Under Console plugin, click Disabled.
   4. Select Enable and then Save. This change restarts the openshift-console pods.
   5. After the pods restart, you will receive a notification that a web console update is available, prompting you to refresh.
   6. After refreshing the web console, click Observe from the left main menu. A new option for Logs is available.