Configuring the log store - Configuring your cluster logging deployment | Logging | OpenShift Container Platform 4.5

Forward audit logs to the log store
Configuring log retention time
Configuring CPU and memory requests for the log store
Configuring replication policy for the log store
Scaling down elasticsearch pods
Configuring persistent storage for the log store
Configuring the log store for emptyDir storage
Performing an elasticsearch rolling cluster restart
exposing the log store service as a route

OpenShift Container Platform uses elasticsearch 6 (eS) to store and organize the log data.

You can make modifications to your log store, including:

storage for your elasticsearch cluster
shard replication across data nodes in the cluster, from full replication to no replication
external access to elasticsearch data

elasticsearch is a memory-intensive application. each elasticsearch node needs 16G of memory for both memory requests and limits, unless you specify otherwise in the ClusterLogging custom resource. The initial set of OpenShift Container Platform nodes might not be large enough to support the elasticsearch cluster. You must add additional nodes to the OpenShift Container Platform cluster to run with the recommended or higher memory.

each elasticsearch node can operate with a lower memory setting, though this is not recommended for production environments.

Forward audit logs to the log store

Because the internal OpenShift Container Platform elasticsearch log store does not provide secure storage for audit logs, by default audit logs are not stored in the internal elasticsearch instance.

If you want to send the audit logs to the internal log store, for example to view the audit logs in Kibana, you must use the Log Forwarding API. The Log Fowarding API is currently a Technology Preview feature.

The internal OpenShift Container Platform elasticsearch log store does not provide secure storage for audit logs. We recommend you ensure that the system to which you forward audit logs is compliant with your organizational and governmental regulations and is properly secured. OpenShift Container Platform cluster logging does not comply with those regulations.

Procedure

To use the Log Forwarding API to forward audit logs to the internal elasticsearch instance:

If the Log Forwarding API is not enabled:

edit the ClusterLogging custom resource (CR) in the openshift-logging project:
```
$ oc edit ClusterLogging instance
```

Add the clusterlogging.openshift.io/logforwardingtechpreview annotation and set to enabled:

apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
  annotations:
    clusterlogging.openshift.io/logforwardingtechpreview: enabled (1)
  name: "instance"
  namespace: "openshift-logging"
spec:

...

  collection: (2)
    logs:
      type: "fluentd"
      fluentd: {}

1	enables and disables the Log Forwarding API. Set to `enabled` to use log forwarding.
2	The `spec.collection` block must be defined to use Fluentd in the `ClusterLogging` CR.

Create a LogForwarding CR YAML file or edit your existing CR:

Create a CR to send all log types to the internal elasticsearch instance. You can use the following example without making any changes:

apiVersion: logging.openshift.io/v1alpha1
kind: LogForwarding
metadata:
  name: instance
  namespace: openshift-logging
spec:
  disableDefaultForwarding: true
  outputs:
    - name: clo-es
      type: elasticsearch
      endpoint: 'elasticsearch.openshift-logging.svc:9200' (1)
      secret:
        name: fluentd
  pipelines:
    - name: audit-pipeline (2)
      inputSource: logs.audit
      outputRefs:
        - clo-es
    - name: app-pipeline (3)
      inputSource: logs.app
      outputRefs:
        - clo-es
    - name: infra-pipeline (4)
      inputSource: logs.infra
      outputRefs:
        - clo-es

1	The `endpoint` parameter points to the internal elasticsearch instance.
2	This parameter sends the audit logs to the specified endpoint.
3	This parameter sends the application logs to the specified endpoint.
4	This parameter sends the infrastructure logs to the specified endpoint.

You must configure a pipeline and output for all three types of logs: application, infrastructure, and audit. If you do not specify a pipeline and output for a log type, those logs are not stored and will be lost.

If you have an existing LogForwarding CR, add an output for the internal elasticsearch instance and a pipeline to that output for the audit logs. For example:

apiVersion: "logging.openshift.io/v1alpha1"
kind: "LogForwarding"
metadata:
  name: instance
  namespace: openshift-logging
spec:
  disableDefaultForwarding: true
  outputs:
   - name: elasticsearch (1)
     type: "elasticsearch"
     endpoint: elasticsearch.openshift-logging.svc:9200
     secret:
        name: fluentd
   - name: elasticsearch-insecure
     type: "elasticsearch"
     endpoint: elasticsearch-insecure.messaging.svc.cluster.local
     insecure: true
   - name: secureforward-offcluster
     type: "forward"
     endpoint: https://secureforward.offcluster.com:24224
     secret:
        name: secureforward
  pipelines:
   - name: container-logs
     inputSource: logs.app
     outputRefs:
     - secureforward-offcluster
   - name: infra-logs
     inputSource: logs.infra
     outputRefs:
     - elasticsearch-insecure
   - name: audit-logs (2)
     inputSource: logs.audit
     outputRefs:
     - elasticsearch

1	An output for the internal elasticsearch instance.
2	A pipeline for sending the audit logs to the internal elasticsearch instance.

Additional resources

For more information on the Log Forwarding API, see Forwarding logs using the Log Forwarding API.

Configuring log retention time

You can specify how long the default elasticsearch log store keeps indices using a separate retention policy for each of the three log sources: infrastructure logs, application logs, and audit logs. The retention policy, which you configure using the maxAge parameter in the Cluster Logging Custom Resource (CR), is considered for the elasticsearch roll over schedule and determines when elasticsearch deletes the rolled-over indices.

elasticsearch rolls over an index, moving the current index and creating a new index, when an index matches any of the following conditions:

The index is older than the rollover.maxAge value in the elasticsearch CR.
The index size is greater than 40 GB × the number of primary shards.
The index doc count is greater than 40960 KB × the number of primary shards.

elasticsearch deletes the rolled-over indices are deleted based on the retention policy you configure.

If you do not create a retention policy for any of the log sources, logs are deleted after seven days by default.

If you do not specify a retention policy for all three log sources, only logs from the sources with a retention policy are stored. For example, if you set a retention policy for the infrastructure and applicaiton logs, but do not set a retention policy for audit logs, the audit logs will not be retained and there will be no audit- index in elasticsearch or Kibana.

Prerequisites

Cluster logging and elasticsearch must be installed.

Procedure

To configure the log retention time:

edit the ClusterLogging CR to add or modify the retentionPolicy parameter:

apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
...
spec:
  managementState: "Managed"
  logStore:
    type: "elasticsearch"
    retentionPolicy: (1)
      application:
        maxAge: 1d
      infra:
        maxAge: 7d
      audit:
        maxAge: 7d
    elasticsearch:
      nodeCount: 3
...

1	Specify the time that elasticsearch should retain each log source. enter an integer and a time designation: weeks(w), hours(h/H), minutes(m) and seconds(s). For example, `1d` for one day. Logs older than the `maxAge` are deleted. By default, logs are retained for seven days.

You can verify the settings in the elasticsearch custom resource (CR).

For example, the Cluster Logging Operator updated the following elasticsearch CR to configure a retention policy that includes settings to roll over active indices for the infrastructure logs every eight hours and the rolled-ver indices are deleted seven days after rollover. OpenShift Container Platform checks every 15 minutes to determine if the indices need to be rolled over.

apiVersion: "logging.openshift.io/v1"
kind: "elasticsearch"
metadata:
  name: "elasticsearch"
spec:
...
  indexManagement:
    policies: (1)
      - name: infra-policy
        phases:
          delete:
            minAge: 7d (2)
          hot:
            actions:
              rollover:
                maxAge: 8h (3)
        pollInterval: 15m (4)
...

1	For each log source, the retention policy indicates when to delete and rollover logs for that source.
2	When OpenShift Container Platform deletes the rolled-over indices. This setting is the `maxAge` you set in the `ClusterLogging` CR.
3	The index age for OpenShift Container Platform to consider when rolling over the indices. This value is determined from the `maxAge` you set in the `ClusterLogging` CR.
4	When OpenShift Container Platform checks if the indices should be rolled over. This setting is the default and cannot be changed.

Modifying the elasticsearch CR is not supported. All changes to the retention policies must be made in the ClusterLogging CR.

The elasticsearch Operator deploys a cron job to roll over indices for each mapping using the defined policy, scheduled using the pollInterval.

$ oc get cronjobs

example output

NAMe                           SCHeDULe       SUSPeND   ACTIVe   LAST SCHeDULe   AGe
elasticsearch-delete-app       */15 * * * *   False     0        <none>          27s
elasticsearch-delete-audit     */15 * * * *   False     0        <none>          27s
elasticsearch-delete-infra     */15 * * * *   False     0        <none>          27s
elasticsearch-rollover-app     */15 * * * *   False     0        <none>          27s
elasticsearch-rollover-audit   */15 * * * *   False     0        <none>          27s
elasticsearch-rollover-infra   */15 * * * *   False     0        <none>          27s

Configuring CPU and memory requests for the log store

each component specification allows for adjustments to both the CPU and memory requests. You should not have to manually adjust these values as the elasticsearch Operator sets values sufficient for your environment.

In large-scale clusters, the default memory limit for the elasticsearch proxy container might not be sufficient, causing the proxy container to be OOMKilled. If you experience this issue, increase the memory requests and limits for the elasticsearch proxy.

each elasticsearch node can operate with a lower memory setting though this is not recommended for production deployments. For production use, you should have no less than the default 16Gi allocated to each pod. Preferably you should allocate as much as possible, up to 64Gi per pod.

Prerequisites

Cluster logging and elasticsearch must be installed.

Procedure

edit the ClusterLogging custom resource (CR) in the openshift-logging project:

$ oc edit ClusterLogging instance

apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
  name: "instance"
....
spec:
    logStore:
      type: "elasticsearch"
      elasticsearch:
        resources: (1)
          limits:
            memory: 16Gi
          requests:
            cpu: "1"
            memory: "64Gi"
        proxy: (2)
          resources:
            limits:
              memory: 100Mi
            requests:
              memory: 100Mi

1	Specify the CPU and memory requests for elasticsearch as needed. If you leave these values blank, the elasticsearch Operator sets default values that should be sufficient for most deployments. The default values are `16Gi` for the memory request and `1` for the CPU request.
2	Specify the CPU and memory requests for the elasticsearch proxy as needed. If you leave these values blank, the elasticsearch Operator sets default values that should be sufficient for most deployments. The default values are `256Mi` for the memory request and `100m` for the CPU request.

If you adjust the amount of elasticsearch memory, you must change both the request value and the limit value.

For example:

      resources:
        limits:
          cpu: "8"
          memory: "32Gi"
        requests:
          cpu: "8"
          memory: "32Gi"

Kubernetes generally adheres the node configuration and does not allow elasticsearch to use the specified limits. Setting the same value for the requests and limits ensures that elasticsearch can use the CPU and memory you want, assuming the node has the CPU and memory available.

Configuring replication policy for the log store

You can define how elasticsearch shards are replicated across data nodes in the cluster.

Prerequisites

Cluster logging and elasticsearch must be installed.

Procedure

edit the ClusterLogging custom resource (CR) in the openshift-logging project:

$ oc edit clusterlogging instance

apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
  name: "instance"

....

spec:
  logStore:
    type: "elasticsearch"
    elasticsearch:
      redundancyPolicy: "SingleRedundancy" (1)

Specify a redundancy policy for the shards. The change is applied upon saving the changes.

FullRedundancy. elasticsearch fully replicates the primary shards for each index to every data node. This provides the highest safety, but at the cost of the highest amount of disk required and the poorest performance.
MultipleRedundancy. elasticsearch fully replicates the primary shards for each index to half of the data nodes. This provides a good tradeoff between safety and performance.
SingleRedundancy. elasticsearch makes one copy of the primary shards for each index. Logs are always available and recoverable as long as at least two data nodes exist. Better performance than MultipleRedundancy, when using 5 or more nodes. You cannot apply this policy on deployments of single elasticsearch node.
ZeroRedundancy. elasticsearch does not make copies of the primary shards. Logs might be unavailable or lost in the event a node is down or fails. Use this mode when you are more concerned with performance than safety, or have implemented your own disk/PVC backup/restore strategy.

The number of primary shards for the index templates is equal to the number of elasticsearch data nodes.

Scaling down elasticsearch pods

Reducing the number of elasticsearch pods in your cluster can result in data loss or elasticsearch performance degradation.

If you scale down, you should scale down by one pod at a time and allow the cluster to re-balance the shards and replicas. After the elasticsearch health status returns to green, you can scale down by another pod.

If your elasticsearch cluster is set to ZeroRedundancy, you should not scale down your elasticsearch pods.

Configuring persistent storage for the log store

elasticsearch requires persistent storage. The faster the storage, the faster the elasticsearch performance.

Using NFS storage as a volume or a persistent volume (or via NAS such as Gluster) is not supported for elasticsearch storage, as Lucene relies on file system behavior that NFS does not supply. Data corruption and other problems can occur.

Prerequisites

Cluster logging and elasticsearch must be installed.

Procedure

edit the ClusterLogging CR to specify that each data node in the cluster is bound to a Persistent Volume Claim.

apiVersion: "logging.openshift.io/v1"
kind: "ClusterLogging"
metadata:
  name: "instance"

....

 spec:
    logStore:
      type: "elasticsearch"
      elasticsearch:
        nodeCount: 3
        storage:
          storageClassName: "gp2"
          size: "200G"

This example specifies each data node in the cluster is bound to a Persistent Volume Claim that requests "200G" of AWS General Purpose SSD (gp2) storage.

If you use a local volume for persistent storage, do not use a raw block volume, which is described with volumeMode: block in the LocalVolume object. elasticsearch cannot use raw block volumes.

Configuring the log store for emptyDir storage

You can use emptyDir with your log store, which creates an ephemeral deployment in which all of a pod’s data is lost upon restart.

When using emptyDir, if log storage is restarted or redeployed, you will lose data.

Prerequisites

Cluster logging and elasticsearch must be installed.

Procedure

edit the ClusterLogging CR to specify emptyDir:

 spec:
    logStore:
      type: "elasticsearch"
      elasticsearch:
        nodeCount: 3
        storage: {}

Performing an elasticsearch rolling cluster restart

Perform a rolling restart when you change the elasticsearch configmap or any of the elasticsearch-* deployment configurations.

Also, a rolling restart is recommended if the nodes on which an elasticsearch pod runs requires a reboot.

Prerequisites

Cluster logging and elasticsearch must be installed.
Install the OpenShift Container Platform es_util tool

Procedure

To perform a rolling cluster restart:

Change to the openshift-logging project:
```
$ oc project openshift-logging
```
Get the names of the elasticsearch pods:
```
$ oc get pods | grep elasticsearch-
```

Perform a shard synced flush using the OpenShift Container Platform es_util tool to ensure there are no pending operations waiting to be written to disk prior to shutting down:

$ oc exec <any_es_pod_in_the_cluster> -c elasticsearch -- es_util --query="_flush/synced" -XPOST

For example:

$ oc exec -c elasticsearch-cdm-5ceex6ts-1-dcd6c4c7c-jpw6  -c elasticsearch -- es_util --query="_flush/synced" -XPOST

example output

{"_shards":{"total":4,"successful":4,"failed":0},".security":{"total":2,"successful":2,"failed":0},".kibana_1":{"total":2,"successful":2,"failed":0}}

Prevent shard balancing when purposely bringing down nodes using the OpenShift Container Platform es_util tool:

$ oc exec <any_es_pod_in_the_cluster> -c elasticsearch -- es_util --query="_cluster/settings" -XPUT -d '{ "persistent": { "cluster.routing.allocation.enable" : "primaries" } }'

For example:

$ oc exec elasticsearch-cdm-5ceex6ts-1-dcd6c4c7c-jpw6 -c elasticsearch -- es_util --query="_cluster/settings" -XPUT -d '{ "persistent": { "cluster.routing.allocation.enable" : "primaries" } }'

example output

{"acknowledged":true,"persistent":{"cluster":{"routing":{"allocation":{"enable":"primaries"}}}},"transient":

After the command is complete, for each deployment you have for an eS cluster:

By default, the OpenShift Container Platform elasticsearch cluster blocks rollouts to their nodes. Use the following command to allow rollouts and allow the pod to pick up the changes:

$ oc rollout resume deployment/<deployment-name>

For example:

$ oc rollout resume deployment/elasticsearch-cdm-0-1

example output

deployment.extensions/elasticsearch-cdm-0-1 resumed

A new pod is deployed. After the pod has a ready container, you can move on to the next deployment.

$ oc get pods | grep elasticsearch-

example output

NAMe                                            ReADY   STATUS    ReSTARTS   AGe
elasticsearch-cdm-5ceex6ts-1-dcd6c4c7c-jpw6k    2/2     Running   0          22h
elasticsearch-cdm-5ceex6ts-2-f799564cb-l9mj7    2/2     Running   0          22h
elasticsearch-cdm-5ceex6ts-3-585968dc68-k7kjr   2/2     Running   0          22h

After the deployments are complete, reset the pod to disallow rollouts:

$ oc rollout pause deployment/<deployment-name>

For example:

$ oc rollout pause deployment/elasticsearch-cdm-0-1

example output

deployment.extensions/elasticsearch-cdm-0-1 paused

Check that the elasticsearch cluster is in a green or yellow state:

$ oc exec <any_es_pod_in_the_cluster> -c elasticsearch -- es_util --query=_cluster/health?pretty=true

If you performed a rollout on the elasticsearch pod you used in the previous commands, the pod no longer exists and you need a new pod name here.

For example:

$ oc exec elasticsearch-cdm-5ceex6ts-1-dcd6c4c7c-jpw6 -c elasticsearch -- es_util --query=_cluster/health?pretty=true

{
  "cluster_name" : "elasticsearch",
  "status" : "yellow", (1)
  "timed_out" : false,
  "number_of_nodes" : 3,
  "number_of_data_nodes" : 3,
  "active_primary_shards" : 8,
  "active_shards" : 16,
  "relocating_shards" : 0,
  "initializing_shards" : 0,
  "unassigned_shards" : 1,
  "delayed_unassigned_shards" : 0,
  "number_of_pending_tasks" : 0,
  "number_of_in_flight_fetch" : 0,
  "task_max_waiting_in_queue_millis" : 0,
  "active_shards_percent_as_number" : 100.0
}

1	Make sure this parameter value is `green` or `yellow` before proceeding.

If you changed the elasticsearch configuration map, repeat these steps for each elasticsearch pod.

After all the deployments for the cluster have been rolled out, re-enable shard balancing:

$ oc exec <any_es_pod_in_the_cluster> -c elasticsearch -- es_util --query="_cluster/settings" -XPUT -d '{ "persistent": { "cluster.routing.allocation.enable" : "all" } }'

For example:

$ oc exec elasticsearch-cdm-5ceex6ts-1-dcd6c4c7c-jpw6 -c elasticsearch -- es_util --query="_cluster/settings" -XPUT -d '{ "persistent": { "cluster.routing.allocation.enable" : "all" } }'

example output

{
  "acknowledged" : true,
  "persistent" : { },
  "transient" : {
    "cluster" : {
      "routing" : {
        "allocation" : {
          "enable" : "all"
        }
      }
    }
  }
}

exposing the log store service as a route

By default, the log store that is deployed with cluster logging is not accessible from outside the logging cluster. You can enable a route with re-encryption termination for external access to the log store service for those tools that access its data.

externally, you can access the log store by creating a reencrypt route, your OpenShift Container Platform token and the installed log store CA certificate. Then, access a node that hosts the log store service with a cURL request that contains:

The Authorization: Bearer ${token}
The elasticsearch reencrypt route and an elasticsearch API request.

Internally, you can access the log store service using the log store cluster IP, which you can get by using either of the following commands:

$ oc get service elasticsearch -o jsonpath={.spec.clusterIP} -n openshift-logging

example output

172.30.183.229

$ oc get service elasticsearch -n openshift-logging

example output

NAMe            TYPe        CLUSTeR-IP       eXTeRNAL-IP   PORT(S)    AGe
elasticsearch   ClusterIP   172.30.183.229   <none>        9200/TCP   22h

You can check the cluster IP address with a command similar to the following:

$ oc exec elasticsearch-cdm-oplnhinv-1-5746475887-fj2f8 -n openshift-logging -- curl -tlsv1.2 --insecure -H "Authorization: Bearer ${token}" "https://172.30.183.229:9200/_cat/health"

example output

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    29  100    29    0     0    108      0 --:--:-- --:--:-- --:--:--   108

Prerequisites

Cluster logging and elasticsearch must be installed.
You must have access to the project in order to be able to access to the logs.

Procedure

To expose the log store externally:

Change to the openshift-logging project:
```
$ oc project openshift-logging
```
extract the CA certificate from the log store and write to the admin-ca file:
```
$ oc extract secret/elasticsearch --to=. --keys=admin-ca
```
example output
```
admin-ca
```

Create the route for the log store service as a YAML file:

Create a YAML file with the following:

apiVersion: route.openshift.io/v1
kind: Route
metadata:
  name: elasticsearch
  namespace: openshift-logging
spec:
  host:
  to:
    kind: Service
    name: elasticsearch
  tls:
    termination: reencrypt
    destinationCACertificate: | (1)

1	Add the log store CA certifcate or use the command in the next step. You do not have to set the `spec.tls.key`, `spec.tls.certificate`, and `spec.tls.caCertificate` parameters required by some reencrypt routes.

Run the following command to add the log store CA certificate to the route YAML you created:
```
$ cat ./admin-ca | sed -e "s/^/ /" >> <file-name>.yaml
```

Create the route:

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

example output

route.route.openshift.io/elasticsearch created

Check that the elasticsearch service is exposed:

Get the token of this service account to be used in the request:
```
$ token=$(oc whoami -t)
```

Set the elasticsearch route you created as an environment variable.

$ routeeS=`oc get route elasticsearch -o jsonpath={.spec.host}`

To verify the route was successfully created, run the following command that accesses elasticsearch through the exposed route:

curl -tlsv1.2 --insecure -H "Authorization: Bearer ${token}" "https://${routeeS}"

The response appears similar to the following:

example output

{
  "name" : "elasticsearch-cdm-i40ktba0-1",
  "cluster_name" : "elasticsearch",
  "cluster_uuid" : "0eY-tJzcR3KOdpgeMJo-MQ",
  "version" : {
  "number" : "6.8.1",
  "build_flavor" : "oss",
  "build_type" : "zip",
  "build_hash" : "Unknown",
  "build_date" : "Unknown",
  "build_snapshot" : true,
  "lucene_version" : "7.7.0",
  "minimum_wire_compatibility_version" : "5.6.0",
  "minimum_index_compatibility_version" : "5.0.0"
},
  "<tagline>" : "<for search>"
}