From 3bb20bc8e207f767bda3bd478f71d39d46a1a9de Mon Sep 17 00:00:00 2001 From: Frank Kloeker Date: Sun, 3 Dec 2023 23:01:22 +0100 Subject: [PATCH] helm-docs Signed-off-by: Frank Kloeker --- chart/README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/chart/README.md b/chart/README.md index 317db81e..f090b529 100644 --- a/chart/README.md +++ b/chart/README.md @@ -20,6 +20,8 @@ A Helm chart to install Sparrow | Key | Type | Default | Description | |-----|------|---------|-------------| | affinity | object | `{}` | | +| extraArgs.loaderFilePath | string | `"/runconfig/checks.yaml"` | | +| extraArgs.loaderType | string | `"file"` | | | fullnameOverride | string | `""` | | | image.pullPolicy | string | `"IfNotPresent"` | | | image.repository | string | `"ghcr.io/caas-team/sparrow"` | | @@ -36,22 +38,31 @@ A Helm chart to install Sparrow | nodeSelector | object | `{}` | | | podAnnotations | object | `{}` | | | podLabels | object | `{}` | | -| podSecurityContext | object | `{}` | | +| podSecurityContext.fsGroup | int | `1000` | | +| podSecurityContext.supplementalGroups[0] | int | `1000` | | | replicaCount | int | `1` | | | resources | object | `{}` | | -| securityContext | object | `{}` | | +| runtimeConfig.enabled | bool | `true` | | +| runtimeConfig.healthEndpoint | bool | `false` | | +| runtimeConfig.latency.enabled | bool | `true` | | +| runtimeConfig.latency.interval | int | `1` | | +| runtimeConfig.latency.retry.count | int | `3` | | +| runtimeConfig.latency.retry.delay | int | `1` | | +| runtimeConfig.latency.timeout | int | `3` | | +| runtimeConfig.targets[0] | string | `"https://www.example.com/"` | | +| runtimeConfig.targets[1] | string | `"https://www.google.com/"` | | +| securityContext.allowPrivilegeEscalation | bool | `false` | | +| securityContext.capabilities.drop[0] | string | `"ALL"` | | +| securityContext.privileged | bool | `false` | | +| securityContext.readOnlyRootFilesystem | bool | `true` | | +| securityContext.runAsGroup | int | `1000` | | +| securityContext.runAsUser | int | `1000` | | | service.port | int | `8080` | | | service.type | string | `"ClusterIP"` | | | serviceAccount.annotations | object | `{}` | | | serviceAccount.automount | bool | `true` | | | serviceAccount.create | bool | `true` | | | serviceAccount.name | string | `""` | | -| sparrow.loaderFilePath | string | `"/runconfig/checks.yaml"` | | -| sparrow.loaderType | string | `"file"` | | -| sparrowConfig.enabled | bool | `true` | | -| sparrowConfig.healthEndpoint | bool | `false` | | -| sparrowConfig.targets[0] | string | `"https://www.telekom.de"` | | -| sparrowConfig.targets[1] | string | `"https://gitlab.devops.telekom.de"` | | | tolerations | list | `[]` | | ----------------------------------------------