How to define additional manifests in rancher-logging

This document (000021964) is provided subject to the disclaimer at the end of this document.

Environment

Rancher v2.8+

rancher-logging 103.0.0+up3.17.10 or posterior versions

Situation

You want to deploy additional logging resources (e.g. clusterFlows or Outputs) in the values file of rancher-logging. Although it is a best-practice to separate the deployment and configuration of the application, this is a convenient way of setting up the entire logging pipeline, as you won't need to deploy or manage these resources separately. 

Resolution

There is a parameter in the values file of the rancher-logging HelmChart called "extraManifests" that you can use to deploy additional logging resource such as Outputs and Flows. The following is an example of how to set it up:

extraManifests:
  - apiVersion: logging.banzaicloud.io/v1beta1
    kind: ClusterOutput
    metadata:
      name: example-es
      namespace: cattle-logging-system
    spec:
      elasticsearch:
        host: elasticsearch.example.com
        port: 9200
        scheme: http

Additional Information

Do NOT use the following fields in the values file of rancher-logging. The logging.* values are an artefact of the upstream chart, not tailored to Rancher, and they will be managed by another logging object if it is enabled, sometimes causing issues with the controllers.

logging:
  clusterFlows: []
  clusterOutputs: []

Disclaimer

This Support Knowledgebase provides a valuable tool for SUSE customers and parties interested in our products and solutions to acquire information, ideas and learn from one another. Materials are provided for informational, personal or non-commercial use within your organization and are presented "AS IS" WITHOUT WARRANTY OF ANY KIND.