Awesome

<h1> <img src="https://github.com/sighupio/fury-distribution/blob/main/docs/assets/fury-epta-white.png?raw=true" align="left" width="90" style="margin-right: 15px"/> Kubernetes Fury Logging </h1>

License

Kubernetes Fury Logging provides a logging stack for the Kubernetes Fury Distribution (KFD).

If you are new to KFD please refer to the official documentation on how to get started with KFD.

Overview

Kubernetes Fury Logging uses a collection of open source tools to provide the most resilient and robust logging stack for the cluster.

The central piece of the stack is the open source search engine opensearch, combined with its analytics and visualization platform opensearch-dashboards. The logs are collected using a node-level data collection and enrichment agent fluentbit, pushing it to the OpenSearch via fluentd. The fluentbit and fluentd stack is managed by Banzai Logging Operator. We are also providing an alternative to OpenSearch: loki.

All the components are deployed in the logging namespace in the cluster.

High level diagram of the stack:

logging module

Packages

The following packages are included in the Kubernetes Fury Logging module:

Package	Version	Description
opensearch-single	`2.12.0`	Single node opensearch deployment. Not intended for production use.
opensearch-triple	`2.12.0`	Three node high-availability opensearch deployment
opensearch-dashboards	`2.12.0`	Analytics and visualization platform for Opensearch
logging-operator	`4.5.6`	Banzai logging operator, manages fluentbit/fluentd and their configurations
logging-operated	`-`	fluentd and fluentbit deployment using logging operator
configs	`-`	Logging pipeline configs to gather various types of logs and send them to OpenSearch
loki-configs	`-`	Logging pipeline configs to gather various types of logs and send them to Loki
loki-distributed	`2.9.2`	Distributed Loki deployment
minio-ha	`vRELEASE.2023-01-12T02-06-16Z`	Three nodes HA MinIO deployment

Click on each package to see its full documentation.

Compatibility

Kubernetes Version	Compatibility	Notes
`1.26.x`	:white_check_mark:	No known issues
`1.27.x`	:white_check_mark:	No known issues
`1.28.x`	:white_check_mark:	No known issues
`1.29.x`	:white_check_mark:	No known issues

Check the compatibility matrix for additional information about previous releases of the modules.

Usage

Prerequisites

Tool	Version	Description
furyctl	`>=0.25.0`	The recommended tool to download and manage KFD modules and their packages. To learn more about `furyctl` read the official documentation.
kustomize	`>=3.10.0`	Packages are customized using `kustomize`. To learn how to create your customization layer with `kustomize`, please refer to the repository.

Deployment with OpenSearch

List the packages you want to deploy and their version in a Furyfile.yml

bases:
  - name: logging/opensearch-single
    version: "v3.4.1"
  - name: logging/opensearch-dashboards
    version: "v3.4.1"
  - name: logging/logging-operator
    version: "v3.4.1"
  - name: logging/logging-operated
    version: "v3.4.1"
  - name: minio/minio-ha
    version: "v3.4.1"
  - name: logging/configs
    version: "v3.4.1"

See furyctl documentation for additional details about Furyfile.yml format.

Execute furyctl legacy vendor -H to download the packages
Inspect the download packages under ./vendor/katalog/logging.
Define a kustomization.yaml that includes the ./vendor/katalog/logging directory as resource.

resources:
- ./vendor/katalog/logging/opensearch-single
- ./vendor/katalog/logging/opensearch-dashboards
- ./vendor/katalog/logging/logging-operator
- ./vendor/katalog/logging/logging-operated
- ./vendor/katalog/logging/minio-ha
- ./vendor/katalog/logging/configs
``

5. To deploy the packages to your cluster, execute:

```bash
kustomize build . | kubectl apply --server-side -f -

Note: When installing the packages, you need to ensure that the Prometheus operator is also installed. Otherwise, the API server will reject all ServiceMonitor resources.

Deployment with Loki

List the packages you want to deploy and their version in a Furyfile.yml

bases:
  - name: logging/loki-distributed
    version: "v3.4.1"
  - name: logging/logging-operator
    version: "v3.4.1"
  - name: logging/logging-operated
    version: "v3.4.1"
  - name: minio/minio-ha
    version: "v3.4.1"
  - name: logging/configs
    version: "v3.4.1"
  - name: logging/loki-configs
    version: "v3.4.1"

See furyctl documentation for additional details about Furyfile.yml format.

Execute furyctl legacy vendor -H to download the packages
Inspect the download packages under ./vendor/katalog/logging.
Define a kustomization.yaml that includes the ./vendor/katalog/logging directory as resource.

resources:
- ./vendor/katalog/logging/loki-distributed
- ./vendor/katalog/logging/logging-operator
- ./vendor/katalog/logging/logging-operated
- ./vendor/katalog/logging/minio-ha
- ./vendor/katalog/logging/loki-configs
``

5. To deploy the packages to your cluster, execute:

```bash
kustomize build . | kubectl apply --server-side -f -

Note: When installing the packages, you need to ensure that the Prometheus operator is also installed. Otherwise, the API server will reject all ServiceMonitor resources.

Common Customisations

Setup a high-availability three-node OpenSearch

Logging module offers an out of the box, highly-available setup for opensearch instead of a single node version. To set this up, in the Furyfile and kustomization, you can replace opensearch-single with opensearch-triple.

Configure tolerations and node selectors

If you need to specify tolerations and/or node selectors, you can find some snippets in examples/tolerations and its subfolders.

Contributing

Before contributing, please read first the Contributing Guidelines.

Reporting Issues

In case you experience any problems with the module, please open a new issue.

License

This module is open-source and it's released under the following LICENSE