banzaicloud/logging-operator repository overview

⁠ ⁠ ⁠ ⁠ ⁠

⁠logging-operator v2

Logging operator for Kubernetes based on Fluentd and Fluent-bit.

⁠What is this operator for?

This operator helps you to pack together logging information with your applications. With the help of Custom Resource Definition you can describe the behaviour of your application within its charts. The operator does the rest.

⁠Feature highlights

• Namespace isolation
• Native Kubernetes label selectors
• Secure communication (TLS)
• Configuration validation
• Multiple flow support (multiply logs for different transformations)
• Multiple output⁠ support (store the same logs in multiple storage: S3, GCS, ES, Loki and more...)
• Multiple logging system support (multiple fluentd, fluent-bit deployment on the same cluster)

⁠Motivation

The logging operator automates the deployment and configuration of a Kubernetes logging pipeline. Under the hood the operator configures a fluent-bit daemonset for collecting container logs from the node file system. Fluent-bit enriches the logs with Kubernetes metadata and transfers them to fluentd. Fluentd receives, filters and transfer logs to multiple outputs. Your logs will always be transferred on authenticated and encrypted channels.

⁠Blogs

• Logging-Operator v2⁠

⁠Blogs (general logging and operator v1)

• Advanced logging on Kubernetes⁠
• Secure logging on Kubernetes with Fluentd and Fluent Bit⁠
• Centralized logging under Kubernetes⁠
• Centralized logging on Kubernetes automated⁠
• And more...⁠

Logging-operator is a core part of the Pipeline⁠ platform, a Cloud Native application and devops platform that natively supports multi- and hybrid-cloud deployments with multiple authentication backends. Check out the developer beta:

⁠

⁠Architecture

Available custom resources:

• logging⁠ - Represents a logging system. Includes Fluentd and Fluent-bit configuration. Specifies the controlNamespace. Fluentd and Fluent-bit will be deployed in the controlNamespace
• output⁠ - Defines an Output for a logging flow. This is a namespaced resource.
• flow⁠ - Defines a logging flow with filters and outputs. You can specify selectors to filter logs by labels. Outputs can be output or clusteroutput. This is a namespaced resource.
• clusteroutput⁠ - Defines an output without namespace restriction. Only effective in controlNamespace.
• clusterflow⁠ - Defines a logging flow without namespace restriction.

The detailed CRD documentation can be found here⁠.

connection between custom resources

---

⁠Contents

• Installation
  • Deploy with Helm⁠
  • Deploy with Kuberenetes Manifests⁠
• Supported Plugins⁠
• Examples
  • S3 Output⁠
  • Elasticsearch Output⁠
  • Nginx with Elasticsearch Output⁠
  • Nginx with Loki Output⁠
  • Nginx with Kafka Output⁠
• Monitoring⁠
• Troubleshooting⁠
• Contributing⁠

---

⁠Supported Plugins

For complete list of supported plugins please check the plugins index⁠.

---

⁠Troubleshooting

If you encounter any problems that the documentation does not address, please file an issue⁠ or talk to us on the Banzai Cloud Slack channel #logging-operator⁠.

⁠Contributing

If you find this project useful here's how you can help:

• Send a pull request with your new features and bug fixes
• Help new users with issues they may encounter
• Support the development of this project and star this repo!

For more information please read the developer documentation⁠

⁠License

Copyright (c) 2017-2019 Banzai Cloud, Inc.⁠

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0⁠

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.