Logging readme (#3493)

Co-authored-by: Manuel Recena <manuel.recena@suse.com>
pull/2646/head
Josh Meranda 2024-02-21 13:33:44 -05:00 committed by GitHub
parent 8b6084faf3
commit add8486165
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 0 additions and 114 deletions

View File

@ -32,54 +32,6 @@ Use `createCustomResource=false` with Helm v3 to avoid trying to create CRDs fro
## Values
<<<<<<< HEAD
## Uninstalling the Chart
To uninstall/delete the `my-release` deployment:
```bash
$ helm delete my-release
```
The command removes all Kubernetes components associated with the chart and deletes the release.
## Configuration
The following tables lists the configurable parameters of the logging-operator chart and their default values.
| Parameter | Description | Default |
| --------------------------------------------------- | ------------------------------------------------------ |-----------------------------------------------------------------------|
| `image.repository` | Container image repository | `ghcr.io/banzaicloud/logging-operator` |
| `image.tag` | Container image tag | `3.17.10` |
| `image.pullPolicy` | Container pull policy | `IfNotPresent` |
| `nameOverride` | Override name of app | `` |
| `fullnameOverride` | Override full name of app | `` |
| `namespaceOverride` | Override namespace of app | `` |
| `watchNamespace` | Namespace to watch for LoggingOperator CRD | `` |
| `rbac.enabled` | Create rbac service account and roles | `true` |
| `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` |
| `priorityClassName` | Operator priorityClassName | `{}` |
| `affinity` | Node Affinity | `{}` |
| `resources` | CPU/Memory resource requests/limits | `{}` |
| `tolerations` | Node Tolerations | `[]` |
| `nodeSelector` | Define which Nodes the Pods are scheduled on. | `{}` |
| `podLabels` | Define custom labels for logging-operator pods | `{}` |
| `annotations` | Define annotations for logging-operator pods | `{}` |
| `podSecurityContext` | Pod SecurityContext for Logging operator. [More info](https://kubernetes.io/docs/concepts/policy/security-context/) | `{"runAsNonRoot": true, "runAsUser": 1000, "fsGroup": 2000}` |
| `securityContext` | Container SecurityContext for Logging operator. [More info](https://kubernetes.io/docs/concepts/policy/security-context/) | `{"allowPrivilegeEscalation": false, "readOnlyRootFilesystem": true}` |
| `createCustomResource` | Create CRDs. | `true` |
| `monitoring.serviceMonitor.enabled` | Create Prometheus Operator servicemonitor. | `false` |
| `serviceAccount.annotations` | Define annotations for logging-operator ServiceAccount | `{}` |
| `global.seLinux.enabled` | Add seLinuxOptions to Logging resources, requires the [rke2-selinux RPM](https://github.com/rancher/rke2-selinux/releases) | `false` |
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example:
```bash
$ helm install --name my-release -f values.yaml banzaicloud-stable/logging-operator
```
> **Tip**: You can use the default [values.yaml](values.yaml)
=======
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| replicaCount | int | `1` | |
@ -153,7 +105,6 @@ $ helm install --name my-release -f values.yaml banzaicloud-stable/logging-opera
| testReceiver.resources.limits.memory | string | `"50Mi"` | |
| testReceiver.resources.requests.cpu | string | `"20m"` | |
| testReceiver.resources.requests.memory | string | `"25Mi"` | |
>>>>>>> 1dc8f2d8f2065eb9d4031fb13e1ca8f2ce8165e7
## Installing Fluentd and Fluent-bit via logging

View File

@ -1,65 +0,0 @@
--- charts-original/README.md
+++ charts/README.md
@@ -32,6 +32,54 @@
## Values
+<<<<<<< HEAD
+## Uninstalling the Chart
+
+To uninstall/delete the `my-release` deployment:
+
+```bash
+$ helm delete my-release
+```
+
+The command removes all Kubernetes components associated with the chart and deletes the release.
+
+## Configuration
+
+The following tables lists the configurable parameters of the logging-operator chart and their default values.
+
+| Parameter | Description | Default |
+| --------------------------------------------------- | ------------------------------------------------------ |-----------------------------------------------------------------------|
+| `image.repository` | Container image repository | `ghcr.io/banzaicloud/logging-operator` |
+| `image.tag` | Container image tag | `3.17.10` |
+| `image.pullPolicy` | Container pull policy | `IfNotPresent` |
+| `nameOverride` | Override name of app | `` |
+| `fullnameOverride` | Override full name of app | `` |
+| `namespaceOverride` | Override namespace of app | `` |
+| `watchNamespace` | Namespace to watch for LoggingOperator CRD | `` |
+| `rbac.enabled` | Create rbac service account and roles | `true` |
+| `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` |
+| `priorityClassName` | Operator priorityClassName | `{}` |
+| `affinity` | Node Affinity | `{}` |
+| `resources` | CPU/Memory resource requests/limits | `{}` |
+| `tolerations` | Node Tolerations | `[]` |
+| `nodeSelector` | Define which Nodes the Pods are scheduled on. | `{}` |
+| `podLabels` | Define custom labels for logging-operator pods | `{}` |
+| `annotations` | Define annotations for logging-operator pods | `{}` |
+| `podSecurityContext` | Pod SecurityContext for Logging operator. [More info](https://kubernetes.io/docs/concepts/policy/security-context/) | `{"runAsNonRoot": true, "runAsUser": 1000, "fsGroup": 2000}` |
+| `securityContext` | Container SecurityContext for Logging operator. [More info](https://kubernetes.io/docs/concepts/policy/security-context/) | `{"allowPrivilegeEscalation": false, "readOnlyRootFilesystem": true}` |
+| `createCustomResource` | Create CRDs. | `true` |
+| `monitoring.serviceMonitor.enabled` | Create Prometheus Operator servicemonitor. | `false` |
+| `serviceAccount.annotations` | Define annotations for logging-operator ServiceAccount | `{}` |
+| `global.seLinux.enabled` | Add seLinuxOptions to Logging resources, requires the [rke2-selinux RPM](https://github.com/rancher/rke2-selinux/releases) | `false` |
+
+Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example:
+
+```bash
+$ helm install --name my-release -f values.yaml banzaicloud-stable/logging-operator
+```
+
+> **Tip**: You can use the default [values.yaml](values.yaml)
+=======
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| replicaCount | int | `1` | |
@@ -105,6 +153,7 @@
| testReceiver.resources.limits.memory | string | `"50Mi"` | |
| testReceiver.resources.requests.cpu | string | `"20m"` | |
| testReceiver.resources.requests.memory | string | `"25Mi"` | |
+>>>>>>> 1dc8f2d8f2065eb9d4031fb13e1ca8f2ce8165e7
## Installing Fluentd and Fluent-bit via logging