diff --git a/chart/Chart.yaml b/chart/Chart.yaml index a6ac1f48..17b71f4c 100644 --- a/chart/Chart.yaml +++ b/chart/Chart.yaml @@ -4,7 +4,7 @@ description: A Helm chart to install Sparrow type: application keywords: - monitoring -version: 0.0.3 +version: 0.0.4 appVersion: "v0.2.0" icon: https://github.com/caas-team/sparrow/blob/main/docs/img/sparrow.png sources: diff --git a/chart/README.md b/chart/README.md index 55ba3cf2..2f402ad6 100644 --- a/chart/README.md +++ b/chart/README.md @@ -1,14 +1,14 @@ # sparrow -![Version: 0.0.3](https://img.shields.io/badge/Version-0.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.2.0](https://img.shields.io/badge/AppVersion-v0.2.0-informational?style=flat-square) +![Version: 0.0.4](https://img.shields.io/badge/Version-0.0.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.2.0](https://img.shields.io/badge/AppVersion-v0.2.0-informational?style=flat-square) A Helm chart to install Sparrow ## Maintainers -| Name | Email | Url | -|---------|----------------------------------|---------------------------| -| eumel8 | | | +| Name | Email | Url | +| ---- | ------ | --- | +| eumel8 | | | | y-eight | | | ## Source Code @@ -17,50 +17,50 @@ A Helm chart to install Sparrow ## Values -| Key | Type | Default | Description | -|------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| -| affinity | object | `{}` | | -| env | object | `{}` | | -| extraArgs | object | `{"loaderFilePath":"/runconfig/checks.yaml","loaderType":"file"}` | extra command line start parameters see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md | -| fullnameOverride | string | `""` | | -| image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"ghcr.io/caas-team/sparrow"` | | -| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. | -| imagePullSecrets | list | `[]` | | -| ingress.annotations | object | `{}` | | -| ingress.className | string | `""` | | -| ingress.enabled | bool | `false` | | -| ingress.hosts[0].host | string | `"chart-example.local"` | | -| ingress.hosts[0].paths[0].path | string | `"/"` | | -| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | -| ingress.tls | list | `[]` | | -| nameOverride | string | `""` | | -| networkPolicies | object | `{"proxy":{"enabled":false}}` | define a network policy that will open egress traffic to a proxy | -| nodeSelector | object | `{}` | | -| podAnnotations | object | `{}` | | -| podLabels | object | `{}` | | -| podSecurityContext.fsGroup | int | `1000` | | -| podSecurityContext.supplementalGroups[0] | int | `1000` | | -| replicaCount | int | `1` | | -| resources | object | `{}` | | -| runtimeConfig | object | `{"health":{"interval":"20s","retry":{"count":3,"delay":"1s"},"targets":["https://www.example.com/","https://www.google.com/"],"timeout":"10s"},"latency":{"interval":"1s","retry":{"count":3,"delay":"1s"},"targets":["https://example.com/","https://google.com/"],"timeout":"3s"}}` | runtime configuration of the Sparrow see: https://github.com/caas-team/sparrow#runtime | -| 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 | `{}` | Annotations to add to the service account | -| serviceAccount.automount | bool | `true` | Automatically mount a ServiceAccount's API credentials? | -| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | -| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | -| serviceMonitor | object | `{"enabled":false,"interval":"30s","labels":{},"scrapeTimeout":"5s"}` | Configure a service monitor for prometheus-operator | -| serviceMonitor.enabled | bool | `false` | Enable the serviceMonitor | -| serviceMonitor.interval | string | `"30s"` | Sets the scrape interval | -| serviceMonitor.labels | object | `{}` | Additional label added to the service Monitor | -| serviceMonitor.scrapeTimeout | string | `"5s"` | Sets the scrape timeout | -| startupConfig | object | `{}` | startup configuration of the Sparrow see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md | -| tolerations | list | `[]` | | +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| env | object | `{}` | | +| extraArgs | object | `{"loaderFilePath":"/runconfig/checks.yaml","loaderType":"file"}` | extra command line start parameters see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"ghcr.io/caas-team/sparrow"` | | +| image.tag | string | `""` | Overrides the image tag whose default is the chart appVersion. | +| imagePullSecrets | list | `[]` | | +| ingress.annotations | object | `{}` | | +| ingress.className | string | `""` | | +| ingress.enabled | bool | `false` | | +| ingress.hosts[0].host | string | `"chart-example.local"` | | +| ingress.hosts[0].paths[0].path | string | `"/"` | | +| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | | +| ingress.tls | list | `[]` | | +| nameOverride | string | `""` | | +| networkPolicies | object | `{"proxy":{"enabled":false}}` | define a network policy that will open egress traffic to a proxy | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podLabels | object | `{}` | | +| podSecurityContext.fsGroup | int | `1000` | | +| podSecurityContext.supplementalGroups[0] | int | `1000` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| runtimeConfig | object | `{"health":{"interval":"20s","retry":{"count":3,"delay":"1s"},"targets":["https://www.example.com/","https://www.google.com/"],"timeout":"10s"},"latency":{"interval":"1s","retry":{"count":3,"delay":"1s"},"targets":["https://example.com/","https://google.com/"],"timeout":"3s"}}` | runtime configuration of the Sparrow see: https://github.com/caas-team/sparrow#runtime | +| 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 | `{}` | Annotations to add to the service account | +| serviceAccount.automount | bool | `true` | Automatically mount a ServiceAccount's API credentials? | +| serviceAccount.create | bool | `true` | Specifies whether a service account should be created | +| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | +| serviceMonitor | object | `{"enabled":false,"interval":"30s","labels":{},"scrapeTimeout":"5s"}` | Configure a service monitor for prometheus-operator | +| serviceMonitor.enabled | bool | `false` | Enable the serviceMonitor | +| serviceMonitor.interval | string | `"30s"` | Sets the scrape interval | +| serviceMonitor.labels | object | `{}` | Additional label added to the service Monitor | +| serviceMonitor.scrapeTimeout | string | `"5s"` | Sets the scrape timeout | +| startupConfig | object | `{}` | startup configuration of the Sparrow see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md | +| tolerations | list | `[]` | |