Support

Only the configuration options described in this documentation are supported for the logging subsystem.

Do not use any other configuration options, as they are unsupported. Configuration paradigms might change across OKD releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use configurations other than those described in this documentation, your changes will be overwritten, because Operators are designed to reconcile any differences.

The logging subsystem for Red Hat OpenShift is an opinionated collector and normalizer of application, infrastructure, and audit logs. It is intended to be used for forwarding logs to various supported systems.

The logging subsystem for Red Hat OpenShift is not:

• A high scale log collection system

• Security Information and Event Monitoring (SIEM) compliant

• Historical or long term log retention or storage

• A guaranteed log sink

• Secure storage - audit logs are not stored by default

Supported API custom resource definitions

LokiStack development is ongoing. Not all APIs are currently supported.

Unsupported configurations

You must set the Red Hat OpenShift Logging Operator to the Unmanaged state to modify the following components:

• The Elasticsearch custom resource (CR)

• The Kibana deployment

• The fluent.conf file

• The Fluentd daemon set

You must set the OpenShift Elasticsearch Operator to the Unmanaged state to modify the Elasticsearch deployment files.

Explicitly unsupported cases include:

• Configuring default log rotation. You cannot modify the default log rotation configuration.

• Configuring the collected log location. You cannot change the location of the log collector output file, which by default is /var/log/fluentd/fluentd.log.

• Throttling log collection. You cannot throttle down the rate at which the logs are read in by the log collector.

• Configuring the logging collector using environment variables. You cannot use environment variables to modify the log collector.

• Configuring how the log collector normalizes logs. You cannot modify default log normalization.

Support policy for unmanaged Operators

The management state of an Operator determines whether an Operator is actively managing the resources for its related component in the cluster as designed. If an Operator is set to an unmanaged state, it does not respond to changes in configuration nor does it receive updates.

While this can be helpful in non-production clusters or during debugging, Operators in an unmanaged state are unsupported and the cluster administrator assumes full control of the individual component configurations and upgrades.

An Operator can be set to an unmanaged state using the following methods:

• Individual Operator configuration

  Individual Operators have a managementState parameter in their configuration. This can be accessed in different ways, depending on the Operator. For example, the Red Hat OpenShift Logging Operator accomplishes this by modifying a custom resource (CR) that it manages, while the Cluster Samples Operator uses a cluster-wide configuration resource.

  Changing the managementState parameter to Unmanaged means that the Operator is not actively managing its resources and will take no action related to the related component. Some Operators might not support this management state as it might damage the cluster and require manual recovery.

  Changing individual Operators to the Unmanaged state renders that particular component and functionality unsupported. Reported issues must be reproduced in Managed state for support to proceed.

• Cluster Version Operator (CVO) overrides

  The spec.overrides parameter can be added to the CVO’s configuration to allow administrators to provide a list of overrides to the CVO’s behavior for a component. Setting the spec.overrides[].unmanaged parameter to true for a component blocks cluster upgrades and alerts the administrator after a CVO override has been set:

  Disabling ownership via cluster version overrides prevents upgrades. Please remove overrides before continuing.

  Setting a CVO override puts the entire cluster in an unsupported state. Reported issues must be reproduced after removing any overrides for support to proceed.

Collecting logging data for Red Hat Support

When opening a support case, it is helpful to provide debugging information about your cluster to Red Hat Support.

You can use the must-gather tool to collect diagnostic information for project-level resources, cluster-level resources, and each of the logging subsystem components.

For prompt support, supply diagnostic information for both OKD and the logging subsystem for Red Hat OpenShift.

About the must-gather tool

The oc adm must-gather CLI command collects the information from your cluster that is most likely needed for debugging issues.

For your logging subsystem, must-gather collects the following information:

• Project-level resources, including pods, configuration maps, service accounts, roles, role bindings, and events at the project level

• Cluster-level resources, including nodes, roles, and role bindings at the cluster level

• OpenShift Logging resources in the openshift-logging and openshift-operators-redhat namespaces, including health status for the log collector, the log store, and the log visualizer

When you run oc adm must-gather, a new pod is created on the cluster. The data is collected on that pod and saved in a new directory that starts with must-gather.local. This directory is created in the current working directory.

Collecting OpenShift Logging data

You can use the oc adm must-gather CLI command to collect information about your logging subsystem.

Procedure

To collect logging subsystem information with must-gather:

1. Navigate to the directory where you want to store the must-gather information.

2. Run the oc adm must-gather command against the OpenShift Logging image:

   $ oc adm must-gather --image=quay.io/openshift/origin-cluster-logging-operator

   The must-gather tool creates a new directory that starts with must-gather.local within the current directory. For example: must-gather.local.4157245944708210408.

3. Create a compressed file from the must-gather directory that was just created. For example, on a computer that uses a Linux operating system, run the following command:

   $ tar -cvaf must-gather.tar.gz must-gather.local.4157245944708210408

4. Attach the compressed file to your support case on the Red Hat Customer Portal.