github.com/banzaicloud/operator-tools@v0.28.10/pkg/helm/testdata/templates/logging-operator/README.md (about) 1 2 # Logging operator Chart 3 4 [Logging operator](https://github.com/banzaicloud/logging-operator) Managed centralized logging component fluentd and fluent-bit instance on cluster. 5 6 ## tl;dr: 7 8 ```bash 9 $ helm repo add banzaicloud-stable https://kubernetes-charts.banzaicloud.com 10 $ helm repo update 11 $ helm install banzaicloud-stable/logging-operator 12 ``` 13 14 ## Introduction 15 16 This chart bootstraps a [Logging Operator](https://github.com/banzaicloud/logging-operator) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. 17 18 ## Prerequisites 19 20 - Kubernetes 1.8+ with Beta APIs enabled 21 22 ## Installing the Chart 23 24 To install the chart with the release name `my-release`: 25 26 ```bash 27 $ helm install --name my-release banzaicloud-stable/logging-operator 28 ``` 29 30 ### CRDs 31 Use `createCustomResource=false` with Helm v3 to avoid trying to create CRDs from the `crds` folder and from templates at the same time. 32 33 The command deploys **Logging operator** on the Kubernetes cluster with the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. 34 35 ## Uninstalling the Chart 36 37 To uninstall/delete the `my-release` deployment: 38 39 ```bash 40 $ helm delete my-release 41 ``` 42 43 The command removes all Kubernetes components associated with the chart and deletes the release. 44 45 ## Configuration 46 47 The following tables lists the configurable parameters of the logging-operator chart and their default values. 48 49 | Parameter | Description | Default | 50 | --------------------------------------------------- | ------------------------------------------------------ | ------------------------------ | 51 | `image.repository` | Container image repository | `ghcr.io/banzaicloud/logging-operator` | 52 | `image.tag` | Container image tag | `3.7.1` | 53 | `image.pullPolicy` | Container pull policy | `IfNotPresent` | 54 | `nameOverride` | Override name of app | `` | 55 | `fullnameOverride` | Override full name of app | `` | 56 | `namespaceOverride` | Override namespace of app | `` | 57 | `watchNamespace` | Namespace to watch for LoggingOperator CRD | `` | 58 | `rbac.enabled` | Create rbac service account and roles | `true` | 59 | `rbac.psp.enabled` | Must be used with `rbac.enabled` true. If true, creates & uses RBAC resources required in the cluster with [Pod Security Policies](https://kubernetes.io/docs/concepts/policy/pod-security-policy/) enabled. | `false` | 60 | `priorityClassName` | Operator priorityClassName | `{}` | 61 | `affinity` | Node Affinity | `{}` | 62 | `resources` | CPU/Memory resource requests/limits | `{}` | 63 | `tolerations` | Node Tolerations | `[]` | 64 | `nodeSelector` | Define which Nodes the Pods are scheduled on. | `{}` | 65 | `annotations` | Define annotations for logging-operator pods | `{}` | 66 | `podSecurityContext` | Pod SecurityContext for Logging operator. [More info](https://kubernetes.io/docs/concepts/policy/security-context/) | `{"runAsNonRoot": true, "runAsUser": 1000, "fsGroup": 2000}` | 67 | `securityContext` | Container SecurityContext for Logging operator. [More info](https://kubernetes.io/docs/concepts/policy/security-context/) | `{"allowPrivilegeEscalation": false, "readOnlyRootFilesystem": true}` | 68 | `createCustomResource` | Create CRDs. | `true` | 69 | `monitoring.serviceMonitor.enabled` | Create Prometheus Operator servicemonitor. | `false` | 70 71 Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example: 72 73 ```bash 74 $ helm install --name my-release -f values.yaml banzaicloud-stable/logging-operator 75 ``` 76 77 > **Tip**: You can use the default [values.yaml](values.yaml) 78 79 ## Installing Fluentd and Fluent-bit via logging 80 81 The previous chart does **not** install `logging` resource to deploy Fluentd and Fluent-bit on cluster. To install them please use the [Logging Operator Logging](https://github.com/banzaicloud/logging-operator/tree/master/charts/logging-operator-logging) chart. 82 83 ## tl;dr: 84 85 ```bash 86 $ helm repo add banzaicloud-stable https://kubernetes-charts.banzaicloud.com 87 $ helm repo update 88 $ helm install banzaicloud-stable/logging-operator-logging 89 ``` 90 91 ## Configuration 92 93 The following tables lists the configurable parameters of the logging-operator-logging chart and their default values. 94 ## tl;dr: 95 96 ```bash 97 $ helm repo add banzaicloud-stable https://kubernetes-charts.banzaicloud.com 98 $ helm repo update 99 $ helm install banzaicloud-stable/logging-operator-logging 100 ``` 101 102 ## Configuration 103 104 The following tables lists the configurable parameters of the logging-operator-logging chart and their default values. 105 106 | Parameter | Description | Default | 107 | --------------------------------------------------- | ------------------------------------------------------ | ------------------------------ | 108 | `tls.enabled` | Enabled TLS communication between components | true | 109 | `tls.fluentdSecretName` | Specified secret name, which contain tls certs | This will overwrite automatic Helm certificate generation. | 110 | `tls.fluentbitSecretName` | Specified secret name, which contain tls certs | This will overwrite automatic Helm certificate generation. | 111 | `tls.sharedKey` | Shared key between nodes (fluentd-fluentbit) | [autogenerated] | 112 | `fluentbit.enabled` | Install fluent-bit | true | 113 | `fluentbit.namespace` | Specified fluentbit installation namespace | same as operator namespace | 114 | `fluentbit.image.tag` | Fluentbit container image tag | `1.6.1` | 115 | `fluentbit.image.repository` | Fluentbit container image repository | `fluent/fluent-bit` | 116 | `fluentbit.image.pullPolicy` | Fluentbit container pull policy | `IfNotPresent` | 117 | `fluentd.enabled` | Install fluentd | true | 118 | `fluentd.image.tag` | Fluentd container image tag | `v1.11.4-alpine-1` | 119 | `fluentd.image.repository` | Fluentd container image repository | `ghcr.io/banzaicloud/fluentd` | 120 | `fluentd.image.pullPolicy` | Fluentd container pull policy | `IfNotPresent` | 121 | `fluentd.volumeModImage.tag` | Fluentd volumeModImage container image tag | `latest` | 122 | `fluentd.volumeModImage.repository` | Fluentd volumeModImage container image repository | `busybox` | 123 | `fluentd.volumeModImage.pullPolicy` | Fluentd volumeModImage container pull policy | `IfNotPresent` | 124 | `fluentd.configReloaderImage.tag` | Fluentd configReloaderImage container image tag | `v0.2.2` | 125 | `fluentd.configReloaderImage.repository` | Fluentd configReloaderImage container image repository | `jimmidyson/configmap-reload` | 126 | `fluentd.configReloaderImage.pullPolicy` | Fluentd configReloaderImage container pull policy | `IfNotPresent` | 127 | `fluentd.fluentdPvcSpec.accessModes` | Fluentd persistence volume access modes | `[ReadWriteOnce]` | 128 | `fluentd.fluentdPvcSpec.resources.requests.storage` | Fluentd persistence volume size | `21Gi` | 129 | `fluentd.fluentdPvcSpec.storageClassName` | Fluentd persistence volume storageclass | `"""` |