-
Notifications
You must be signed in to change notification settings - Fork 718
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
release chart: rancher-logging - version: 104.1.2+up4.8.0
- Loading branch information
1 parent
19e11a4
commit c2334e7
Showing
51 changed files
with
2,773 additions
and
0 deletions.
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Patterns to ignore when building packages. | ||
# This supports shell glob matching, relative path matching, and | ||
# negation (prefixed with !). Only one pattern per line. | ||
.DS_Store | ||
# Common VCS dirs | ||
.git/ | ||
.gitignore | ||
.bzr/ | ||
.bzrignore | ||
.hg/ | ||
.hgignore | ||
.svn/ | ||
# Common backup files | ||
*.swp | ||
*.bak | ||
*.tmp | ||
*.orig | ||
*~ | ||
# Various IDEs | ||
.project | ||
.idea/ | ||
*.tmproj | ||
.vscode/ | ||
|
||
ci/ | ||
README.md.gotmpl |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
annotations: | ||
catalog.cattle.io/auto-install: rancher-logging-crd=match | ||
catalog.cattle.io/certified: rancher | ||
catalog.cattle.io/deploys-on-os: windows | ||
catalog.cattle.io/display-name: Logging | ||
catalog.cattle.io/kube-version: '>= 1.26.0-0 < 1.31.0-0' | ||
catalog.cattle.io/namespace: cattle-logging-system | ||
catalog.cattle.io/permits-os: linux,windows | ||
catalog.cattle.io/provides-gvr: logging.banzaicloud.io.clusterflow/v1beta1 | ||
catalog.cattle.io/rancher-version: '>= 2.9.0-0 < 2.10.0-0' | ||
catalog.cattle.io/release-name: rancher-logging | ||
catalog.cattle.io/type: cluster-tool | ||
catalog.cattle.io/ui-component: logging | ||
catalog.cattle.io/upstream-version: 4.8.0 | ||
apiVersion: v2 | ||
appVersion: 4.8.0 | ||
description: Logging operator for Kubernetes based on Fluentd and Fluentbit. | ||
home: https://kube-logging.github.io | ||
icon: file://assets/logos/rancher-logging.svg | ||
keywords: | ||
- logging | ||
- fluentd | ||
- fluentbit | ||
kubeVersion: '>=1.26.0-0' | ||
name: rancher-logging | ||
sources: | ||
- https://github.com/kube-logging/logging-operator | ||
- https://github.com/kube-logging/helm-charts/tree/main/charts/logging-operator | ||
type: application | ||
version: 104.1.2+up4.8.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
# logging-operator | ||
|
||
![type: application](https://img.shields.io/badge/type-application-informational?style=flat-square) ![kube version: >=1.22.0-0](https://img.shields.io/badge/kube%20version->=1.22.0--0-informational?style=flat-square) [![artifact hub](https://img.shields.io/badge/artifact%20hub-logging--operator-informational?style=flat-square)](https://artifacthub.io/packages/helm/kube-logging/logging-operator) | ||
|
||
Logging operator for Kubernetes based on Fluentd and Fluentbit. | ||
|
||
**Homepage:** <https://kube-logging.github.io> | ||
|
||
## TL;DR; | ||
|
||
```bash | ||
helm install --generate-name --wait oci://ghcr.io/kube-logging/helm-charts/logging-operator | ||
``` | ||
|
||
or to install with a specific version: | ||
|
||
```bash | ||
helm install --generate-name --wait oci://ghcr.io/kube-logging/helm-charts/logging-operator --version $VERSION | ||
``` | ||
|
||
## Introduction | ||
|
||
This chart bootstraps a [Logging Operator](https://github.com/kube-logging/logging-operator) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. | ||
|
||
## Prerequisites | ||
|
||
- Kubernetes 1.19+ | ||
|
||
## Installing CRDs | ||
|
||
Use `createCustomResource=false` with Helm v3 to avoid trying to create CRDs from the `crds` folder and from templates at the same time. | ||
|
||
## Values | ||
|
||
| Key | Type | Default | Description | | ||
|-----|------|---------|-------------| | ||
| replicaCount | int | `1` | | | ||
| image.repository | string | `"ghcr.io/kube-logging/logging-operator"` | Name of the image repository to pull the container image from. | | ||
| image.tag | string | `""` | Image tag override for the default value (chart appVersion). | | ||
| image.pullPolicy | string | `"IfNotPresent"` | [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#updating-images) for updating already existing images on a node. | | ||
| env | list | `[]` | | | ||
| volumes | list | `[]` | | | ||
| volumeMounts | list | `[]` | | | ||
| extraArgs[0] | string | `"-enable-leader-election=true"` | | | ||
| imagePullSecrets | list | `[]` | | | ||
| nameOverride | string | `""` | A name in place of the chart name for `app:` labels. | | ||
| fullnameOverride | string | `""` | A name to substitute for the full names of resources. | | ||
| namespaceOverride | string | `""` | A namespace override for the app. | | ||
| annotations | object | `{}` | Define annotations for logging-operator pods. | | ||
| createCustomResource | bool | `false` | Deploy CRDs used by Logging Operator. | | ||
| http.port | int | `8080` | HTTP listen port number. | | ||
| http.service | object | `{"annotations":{},"clusterIP":"None","labels":{},"type":"ClusterIP"}` | Service definition for query http service. | | ||
| rbac.enabled | bool | `true` | Create rbac service account and roles. | | ||
| monitoring.serviceMonitor.enabled | bool | `false` | Create a Prometheus Operator ServiceMonitor object. | | ||
| monitoring.serviceMonitor.additionalLabels | object | `{}` | | | ||
| monitoring.serviceMonitor.metricRelabelings | list | `[]` | | | ||
| monitoring.serviceMonitor.relabelings | list | `[]` | | | ||
| podSecurityContext | object | `{}` | Pod SecurityContext for Logging operator. [More info](https://kubernetes.io/docs/concepts/policy/security-context/) # SecurityContext holds pod-level security attributes and common container settings. # This defaults to non root user with uid 1000 and gid 2000. *v1.PodSecurityContext false # ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ | | ||
| securityContext | object | `{}` | Container SecurityContext for Logging operator. [More info](https://kubernetes.io/docs/concepts/policy/security-context/) | | ||
| priorityClassName | object | `{}` | Operator priorityClassName. | | ||
| serviceAccount.annotations | object | `{}` | Define annotations for logging-operator ServiceAccount. | | ||
| resources | object | `{}` | CPU/Memory resource requests/limits | | ||
| nodeSelector | object | `{}` | | | ||
| tolerations | list | `[]` | Node Tolerations | | ||
| affinity | object | `{}` | Node Affinity | | ||
| podLabels | object | `{}` | Define which Nodes the Pods are scheduled on. | | ||
| logging | object | `{"allowClusterResourcesFromAllNamespaces":false,"clusterDomain":"cluster.local.","clusterFlows":[],"clusterOutputs":[],"controlNamespace":"","defaultFlow":{},"enableRecreateWorkloadOnImmutableFieldChange":false,"enabled":false,"errorOutputRef":"","eventTailer":{},"flowConfigCheckDisabled":false,"flowConfigOverride":"","fluentbit":{},"fluentbitDisabled":false,"fluentd":{},"fluentdDisabled":false,"globalFilters":[],"hostTailer":{},"loggingRef":"","nodeAgents":{},"skipInvalidResources":false,"syslogNG":{},"watchNamespaceSelector":{},"watchNamespaces":[]}` | Logging resources configuration. | | ||
| logging.enabled | bool | `false` | Logging resources are disabled by default | | ||
| logging.loggingRef | string | `""` | Reference to the logging system. Each of the loggingRefs can manage a fluentbit daemonset and a fluentd statefulset. | | ||
| logging.flowConfigCheckDisabled | bool | `false` | Disable configuration check before applying new fluentd configuration. | | ||
| logging.skipInvalidResources | bool | `false` | Whether to skip invalid Flow and ClusterFlow resources | | ||
| logging.flowConfigOverride | string | `""` | Override generated config. This is a raw configuration string for troubleshooting purposes. | | ||
| logging.fluentbitDisabled | bool | `false` | Flag to disable fluentbit completely | | ||
| logging.fluentbit | object | `{}` | Fluent-bit configurations https://kube-logging.github.io/docs/configuration/crds/v1beta1/fluentbit_types/ | | ||
| logging.fluentdDisabled | bool | `false` | Flag to disable fluentd completely | | ||
| logging.fluentd | object | `{}` | Fluentd configurations https://kube-logging.github.io/docs/configuration/crds/v1beta1/fluentd_types/ | | ||
| logging.syslogNG | object | `{}` | Syslog-NG statefulset configuration | | ||
| logging.defaultFlow | object | `{}` | Default flow for unmatched logs. This Flow configuration collects all logs that didn’t match any other Flow. | | ||
| logging.errorOutputRef | string | `""` | GlobalOutput name to flush ERROR events to | | ||
| logging.globalFilters | list | `[]` | Global filters to apply on logs before any match or filter mechanism. | | ||
| logging.watchNamespaces | list | `[]` | Limit namespaces to watch Flow and Output custom resources. | | ||
| logging.watchNamespaceSelector | object | `{}` | Limit namespaces to watch Flow and Output custom resources. | | ||
| logging.clusterDomain | string | `"cluster.local."` | Cluster domain name to be used when templating URLs to services | | ||
| logging.controlNamespace | string | `""` | Namespace for cluster wide configuration resources like ClusterFlow and ClusterOutput. This should be a protected namespace from regular users. Resources like fluentbit and fluentd will run in this namespace as well. | | ||
| logging.allowClusterResourcesFromAllNamespaces | bool | `false` | Allow configuration of cluster resources from any namespace. Mutually exclusive with ControlNamespace restriction of Cluster resources | | ||
| logging.nodeAgents | object | `{}` | NodeAgent Configuration | | ||
| logging.configCheck | object | `{}` | configCheck provides possibility for timeout-based configuration checks https://kube-logging.dev/docs/whats-new/#timeout-based-configuration-checks | | ||
| logging.enableRecreateWorkloadOnImmutableFieldChange | bool | `false` | EnableRecreateWorkloadOnImmutableFieldChange enables the operator to recreate the fluentbit daemonset and the fluentd statefulset (and possibly other resource in the future) in case there is a change in an immutable field that otherwise couldn’t be managed with a simple update. | | ||
| logging.clusterFlows | list | `[]` | ClusterFlows to deploy | | ||
| logging.clusterOutputs | list | `[]` | ClusterOutputs to deploy | | ||
| logging.eventTailer.enabled | bool | `false` | | | ||
| logging.eventTailer.name | string | `"event-tailer"` | | | ||
| logging.eventTailer.image.repository | string | `nil` | repository of eventTailer image | | ||
| logging.eventTailer.image.tag | string | `nil` | tag of eventTailer image | | ||
| logging.eventTailer.image.pullPolicy | string | `nil` | pullPolicy of eventTailer image | | ||
| logging.eventTailer.image.imagePullSecrets | list | `[]` | imagePullSecrets of eventTailer image | | ||
| logging.eventTailer.pvc.enabled | bool | `true` | enable pvc for | | ||
| logging.eventTailer.pvc.accessModes | list | `["ReadWriteOnce"]` | storage class for event tailer pvc | | ||
| logging.eventTailer.pvc.volumeMode | string | `"Filesystem"` | storage class for event tailer pvc | | ||
| logging.eventTailer.pvc.storage | string | `"1Gi"` | storage for event tailer pvc | | ||
| logging.eventTailer.pvc.storageClassName | string | `nil` | storage class for event tailer pvc | | ||
| logging.eventTailer.workloadMetaOverrides | string | `nil` | workloadMetaOverrides | | ||
| logging.eventTailer.workloadOverrides | string | `nil` | workloadOverrides | | ||
| logging.eventTailer.containerOverrides | string | `nil` | containerOverrides | | ||
| logging.hostTailer.enabled | bool | `false` | HostTailer | | ||
| logging.hostTailer.name | string | `"hosttailer"` | name of HostTailer | | ||
| logging.hostTailer.image.repository | string | `nil` | repository of eventTailer image | | ||
| logging.hostTailer.image.tag | string | `nil` | tag of eventTailer image | | ||
| logging.hostTailer.image.pullPolicy | string | `nil` | pullPolicy of eventTailer image | | ||
| logging.hostTailer.image.imagePullSecrets | list | `[]` | imagePullSecrets of eventTailer image | | ||
| logging.hostTailer.workloadMetaOverrides | string | `nil` | workloadMetaOverrides of HostTailer | | ||
| logging.hostTailer.workloadOverrides | string | `nil` | workloadOverrides of HostTailer | | ||
| logging.hostTailer.fileTailers | list | `[]` | configure fileTailers of HostTailer example: - name: sample-file path: /var/log/sample-file disabled: false buffer_max_size: buffer_chunk_size: skip_long_lines: read_from_head: false containerOverrides: image: | | ||
| logging.hostTailer.systemdTailers | list | `[]` | configure systemdTailers of HostTailer example: - name: system-sample disabled: false systemdFilter: kubelet.service maxEntries: 20 containerOverrides: image: | | ||
| testReceiver.enabled | bool | `false` | | | ||
| testReceiver.image | string | `"fluent/fluent-bit"` | | | ||
| testReceiver.pullPolicy | string | `"IfNotPresent"` | | | ||
| testReceiver.port | int | `8080` | | | ||
| testReceiver.args[0] | string | `"-i"` | | | ||
| testReceiver.args[1] | string | `"http"` | | | ||
| testReceiver.args[2] | string | `"-p"` | | | ||
| testReceiver.args[3] | string | `"port=8080"` | | | ||
| testReceiver.args[4] | string | `"-o"` | | | ||
| testReceiver.args[5] | string | `"stdout"` | | | ||
| testReceiver.resources.limits.cpu | string | `"100m"` | | | ||
| testReceiver.resources.limits.memory | string | `"50Mi"` | | | ||
| testReceiver.resources.requests.cpu | string | `"20m"` | | | ||
| testReceiver.resources.requests.memory | string | `"25Mi"` | | | ||
| extraManifests | list | `[]` | Extra manifests to deploy as an array | | ||
|
||
## Installing Fluentd and Fluent-bit via logging | ||
|
||
The chart does **not** install `logging` resource to deploy Fluentd (or Syslog-ng) and Fluent-bit on the cluster by default, but | ||
it can be enabled by setting the `logging.enabled` value to true. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Rancher Logging | ||
|
||
This chart is based off of the upstream [Banzai Logging Operator](https://banzaicloud.com/docs/one-eye/logging-operator/) chart. The chart deploys a logging operator and CRDs, which allows users to configure complex logging pipelines with a few simple custom resources. There are two levels of logging, which allow you to collect all logs in a cluster or from a single namespace. | ||
|
||
For more information on how to use the feature, refer to our [docs](https://rancher.com/docs/rancher/v2.x/en/logging/v2.7/). | ||
|
||
## Upgrading to Kubernetes v1.25+ | ||
|
||
Starting in Kubernetes v1.25, [Pod Security Policies](https://kubernetes.io/docs/concepts/security/pod-security-policy/) have been removed from the Kubernetes API. | ||
|
||
As a result, **before upgrading to Kubernetes v1.25** (or on a fresh install in a Kubernetes v1.25+ cluster), users are expected to perform an in-place upgrade of this chart with `global.cattle.psp.enabled` set to `false` if it has been previously set to `true`. | ||
|
||
> **Note:** | ||
> In this chart release, any previous field that was associated with any PSP resources have been removed in favor of a single global field: `global.cattle.psp.enabled`. | ||
> **Note:** | ||
> If you upgrade your cluster to Kubernetes v1.25+ before removing PSPs via a `helm upgrade` (even if you manually clean up resources), **it will leave the Helm release in a broken state within the cluster such that further Helm operations will not work (`helm uninstall`, `helm upgrade`, etc.).** | ||
> | ||
> If your charts get stuck in this state, please consult the Rancher docs on how to clean up your Helm release secrets. | ||
Upon setting `global.cattle.psp.enabled` to false, the chart will remove any PSP resources deployed on its behalf from the cluster. This is the default setting for this chart. | ||
|
||
As a replacement for PSPs, [Pod Security Admission](https://kubernetes.io/docs/concepts/security/pod-security-admission/) should be used. Please consult the Rancher docs for more details on how to configure your chart release namespaces to work with the new Pod Security Admission and apply Pod Security Standards. | ||
|
||
## Namespace-level logging | ||
|
||
To collect logs from a single namespace, users create flows and these flows are connected to outputs or cluster outputs. | ||
|
||
## Cluster-level logging | ||
|
||
To collect logs from an entire cluster, users create cluster flows and cluster outputs. | ||
|
||
## CRDs | ||
|
||
- [Cluster Flow](https://banzaicloud.com/docs/one-eye/logging-operator/crds/v1beta1/clusterflow_types/) - A cluster flow is a CRD (`ClusterFlow`) that defines what logs to collect from the entire cluster. The cluster flow must be deployed in the same namespace as the logging operator. | ||
- [Cluster Output](https://banzaicloud.com/docs/one-eye/logging-operator/crds/v1beta1/clusteroutput_types/) - A cluster output is a CRD (`ClusterOutput`) that defines how to connect to logging providers so they can start collecting logs. The cluster output must be deployed in the same namespace as the logging operator. The convenience of using a cluster output is that either a cluster flow or flow can send logs to those providers without needing to define specific outputs in each namespace for each flow. | ||
- [Flow](https://banzaicloud.com/docs/one-eye/logging-operator/crds/v1beta1/flow_types/) - A flow is a CRD (`Flow`) that defines what logs to collect from the namespace that it is deployed in. | ||
- [Output](https://banzaicloud.com/docs/one-eye/logging-operator/crds/v1beta1/output_types/) - An output is a CRD (`Output`) that defines how to connect to logging providers so logs can be sent to the provider. | ||
|
||
For more information on how to configure the Helm chart, refer to the Helm README. | ||
|
||
## Systemd Configuration | ||
Some Kubernetes distributions log to journald. In order to collect these logs the `systemdLogPath` needs to be defined. While the `/run/log/journal` directory is used by default, some Linux distributions do not default to this path. For example Ubuntu defaults to `/var/log/journal`. To determine your `systemdLogPath` run `cat /etc/systemd/journald.conf | grep -E ^\#?Storage | cut -d"=" -f2` on one of your nodes. If `persistent` is returned your `systemdLogPath` should be `/var/log/journal`. If `volatile` is returned `systemdLogPath` should be `/run/log/journal`. If `auto` is returned check if `/var/log/journal` exists, and if it does then use `/var/log/journal`, otherwise use `/run/log/journal`. | ||
|
||
If any value not described here is returned, Rancher Logging will not be able to collect control plane logs. To address this issue set `Storage=volatile` in journald.conf, reboot your machine, and set `systemdLogPath` to `/run/log/journal`. |
Empty file.
Oops, something went wrong.