Skip to content

Commit

Permalink
docs: typos & rephrasing chart value docu
Browse files Browse the repository at this point in the history
  • Loading branch information
lvlcn-t committed Jan 19, 2024
1 parent d2b10af commit 74eaa91
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ A Helm chart to install Sparrow
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| checksConfig | object | `{"checks":{}}` | runtime configuration of the Sparrow see: https://github.com/caas-team/sparrow?tab=readme-ov-file#runtime |
| checksConfig | object | `{"checks":{}}` | Check configuration of the Sparrow read on runtime see: https://github.com/caas-team/sparrow?tab=readme-ov-file#runtime |
| env | object | `{}` | |
| envFromSecrets | list | `[]` | extra environment variables Allows you to set environment variables through secrets you defined outside of the helm chart Useful for sensitive information like the http loader token |
| extraArgs | object | `{}` | extra command line start parameters see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |
| extraArgs | object | `{}` | 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"` | |
Expand Down Expand Up @@ -62,6 +62,6 @@ A Helm chart to install Sparrow
| 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 |
| sparrowConfig | object | `{"loader":{"path":"/config/checksConfig.yaml","type":"file"},"name":"sparrow.com"}` | startup configuration of the Sparrow see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |
| sparrowConfig | object | `{"loader":{"path":"/config/checksConfig.yaml","type":"file"},"name":"sparrow.com"}` | Sparrow configuration read on startup see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md |
| tolerations | list | `[]` | |

6 changes: 3 additions & 3 deletions chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ tolerations: []

affinity: {}

# -- extra command line start parameters
# -- Extra command line start parameters
# see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md
extraArgs: {}

Expand All @@ -105,7 +105,7 @@ envFromSecrets:
# secretName: sparrow-auth
# key: SPARROW_LOADER_HTTP_TOKEN

# -- startup configuration of the Sparrow
# -- Sparrow configuration read on startup
# see: https://github.com/caas-team/sparrow/blob/main/docs/sparrow_run.md
sparrowConfig:
name: sparrow.com
Expand Down Expand Up @@ -135,7 +135,7 @@ sparrowConfig:
# baseUrl: https://gitlab.com
# projectId: ""

# -- runtime configuration of the Sparrow
# -- Check configuration of the Sparrow read on runtime
# see: https://github.com/caas-team/sparrow?tab=readme-ov-file#runtime
checksConfig:
checks: {}
Expand Down

0 comments on commit 74eaa91

Please sign in to comment.