generate helm-docs for chart

Signed-off-by: Frank Kloeker <[email protected]>

README.md

@@ -69,7 +69,20 @@ The [sparrow container images](https://github.com/caas-team/sparrow/pkgs/contain
 
 ### Helm
 
-tbd
+Sparrow can be install via Helm chart. The chart is provided in multiple registries, so can use:
+
+```sh
+helm -n sparrow upgrade -i sparrow oci://ghcr.io/caas-team/charts/sparrow --version 1.0.0 --create-namespace
+```
+or
+
+```sh
+helm -n sparrow upgrade -i sparrow oci://mtr.devops.telekom.de/caas/charts/sparrow --version 1.0.0 --create-namespace
+```
+
+Default settings are fine for a local running configuration, see also our [end2end workflow](https://github.com/caas-team/sparrow/actions/workflows/end2end.yml).
+
+See [Chart README](./chart/README.md) for available values and more details.
 
 ## Usage
 
@@ -212,4 +225,4 @@ Licensed under the **Apache License, Version 2.0** (the "License"); you may not
 
 You may obtain a copy of the License at <https://www.apache.org/licenses/LICENSE-2.0>.
 
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the [LICENSE](./LICENSE) for the specific language governing permissions and limitations under the License.
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the [LICENSE](./LICENSE) for the specific language governing permissions and limitations under the License.

chart/README.md

@@ -0,0 +1,58 @@
+# sparrow
+
+![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.0.0-SNAPSHOT-6477ffc](https://img.shields.io/badge/AppVersion-v0.0.0--SNAPSHOT--6477ffc-informational?style=flat-square)
+
+A Helm chart to install Sparrow
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| eumel8 | <[email protected]> | <https://www.telekom.com> |
+| y-eight | <[email protected]> | <https://www.telekom.com> |
+
+## Source Code
+
+* <https://github.com/caas-team/sparrow>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| fullnameOverride | string | `""` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"ghcr.io/caas-team/sparrow"` |  |
+| image.tag | string | `""` |  |
+| 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 | `""` |  |
+| nodeSelector | object | `{}` |  |
+| podAnnotations | object | `{}` |  |
+| podLabels | object | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| securityContext | object | `{}` |  |
+| 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 | `[]` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3)