From 1db19651b44a97c43b5798455d0c19b37106e16a Mon Sep 17 00:00:00 2001 From: Adam Boguszewski Date: Mon, 20 Feb 2023 14:16:53 +0100 Subject: [PATCH] fix docs --- deploy/helm/sumologic/README.md | 24 ++++++++++++------------ docs/best-practices.md | 4 ++-- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/deploy/helm/sumologic/README.md b/deploy/helm/sumologic/README.md index 07e787a2a4..5e15d1bb28 100644 --- a/deploy/helm/sumologic/README.md +++ b/deploy/helm/sumologic/README.md @@ -560,17 +560,17 @@ The following table lists the configurable parameters of the Sumo Logic chart an | `tailing-sidecar-operator.fullnameOverride` | Used to override the chart's full name. | `Nil` | | `tailing-sidecar-operator.scc.create` | Create OpenShift's Security Context Constraint | `false` | | `kube-prometheus-stack.prometheus.prometheusSpec.nodeSelector` | Node selector for prometheus. [See docs/Best_Practices.md for more information.](/docs/best-practices.md) | `{}` | -| `pvcCleaner.metrics.enabled` | Flag to enable cleaning unused PVCs for otelcol metrics statefulsets. | `false` | -| `pvcCleaner.logs.enabled` | Flag to enable cleaning unused PVCs for otelcol logs statefulsets. | `false` | -| `pvcCleaner.job.image.repository` | Image repository for pvcCleaner docker containers. | `public.ecr.aws/sumologic/kubernetes-tools` | -| `pvcCleaner.job.image.tag` | Image tag for pvcCleaner docker containers. | `2.15.0` | -| `pvcCleaner.job.image.pullPolicy` | Image pullPolicy for pvcCleaner docker containers. | `IfNotPresent` | -| `pvcCleaner.job.resources` | Resource requests and limits for the pvcCleaner containers. | `{"limits": {"memory": "256Mi", "cpu": "2000m"}, "requests": {"memory": "64Mi", "cpu": "100m"}}` | -| `pvcCleaner.job.nodeSelector` | Node selector for pvcCleaner job. [See docs/best-practices.md for more information.](/docs/best-practices.md) | `{}` | -| `pvcCleaner.job.tolerations` | Add tolerations for the pvcCleaner job. | `[]` | -| `pvcCleaner.job.affinity` | Add affinity and anti-affinity for the pvcCleaner job. | `{}` | -| `pvcCleaner.job.podLabels` | Additional labels for the pvcCleaner container. | `{}` | -| `pvcCleaner.job.podAnnotations` | Additional annotations for for the pvcCleaner container. | `{}` | -| `pvcCleaner.job.schedule` | Schedule for cronJobs | `*/15 * * * *` | +| `pvcCleaner.metrics.enabled` | Flag to enable cleaning unused PVCs for otelcol metrics statefulsets. | `false` | +| `pvcCleaner.logs.enabled` | Flag to enable cleaning unused PVCs for otelcol logs statefulsets. | `false` | +| `pvcCleaner.job.image.repository` | Image repository for pvcCleaner docker containers. | `public.ecr.aws/sumologic/kubernetes-tools` | +| `pvcCleaner.job.image.tag` | Image tag for pvcCleaner docker containers. | `2.15.0` | +| `pvcCleaner.job.image.pullPolicy` | Image pullPolicy for pvcCleaner docker containers. | `IfNotPresent` | +| `pvcCleaner.job.resources` | Resource requests and limits for the pvcCleaner containers. | `{"limits": {"memory": "256Mi", "cpu": "2000m"}, "requests": {"memory": "64Mi", "cpu": "100m"}}` | +| `pvcCleaner.job.nodeSelector` | Node selector for pvcCleaner job. [See docs/best-practices.md for more information.](/docs/best-practices.md) | `{}` | +| `pvcCleaner.job.tolerations` | Add tolerations for the pvcCleaner job. | `[]` | +| `pvcCleaner.job.affinity` | Add affinity and anti-affinity for the pvcCleaner job. | `{}` | +| `pvcCleaner.job.podLabels` | Additional labels for the pvcCleaner container. | `{}` | +| `pvcCleaner.job.podAnnotations` | Additional annotations for for the pvcCleaner container. | `{}` | +| `pvcCleaner.job.schedule` | Schedule for cronJobs | `*/15 * * * *` | [values.yaml]: values.yaml diff --git a/docs/best-practices.md b/docs/best-practices.md index 08311afe75..3af58f1e63 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -175,7 +175,7 @@ To solve this problem, `pvcCleaner` can be used to remove unused PVCs: **Note:** it is recommended to enable `pvcCleaner` only for the types of telemetry which are autoscaled to avoid creating unnecessary `cronJobs`. -[pvcCleaner-script]: https://github.com/SumoLogic/sumologic-kubernetes-tools/blob/v2.15.0/src/commands/pvcCleaner +[pvcCleaner-script]: https://github.com/SumoLogic/sumologic-kubernetes-tools/blob/v2.15.0/src/commands/pvc-cleaner [Cron]: https://en.wikipedia.org/wiki/Cron ## OpenTelemetry Collector Persistent Buffer @@ -664,7 +664,7 @@ for below pods: | `otellogs` | `otellogs.daemonset.nodeSelector.kubernetes.io/os` | | `metadata` | `metadata.metrics.statefulset.nodeSelector.kubernetes.io/os` | | `metadata` | `metadata.logs.statefulset.nodeSelector.kubernetes.io/os` | -| `pvcCleaner` | `pvcCleaner.job.nodeSelector.kubernetes.io/os` | +| `pvcCleaner` | `pvcCleaner.job.nodeSelector.kubernetes.io/os` | Node selector can be changed via additional parameter in `user-values.yaml`, see an example for Fluent-Bit below: