Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@aboguszewski-sumo
aboguszewski-sumo committed Feb 20, 2023
1 parent e478ffb commit 1db1965
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
24 changes: 12 additions & 12 deletions deploy/helm/sumologic/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/best-practices.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down

0 comments on commit 1db1965

Please sign in to comment.