docs: Add helm example docs

danihodovic · May 28, 2024 · a7674c8 · a7674c8
1 parent bbc2be5
commit a7674c8
Showing 1 changed file with 67 additions and 49 deletions.
diff --git a/charts/celery-exporter/README.md b/charts/celery-exporter/README.md
@@ -6,60 +6,78 @@ Prometheus exporter for Celery
 
 **Homepage:** <https://github.com/danihodovic/celery-exporter>
 
+## Installation
+
+Add the helm repository:
+
+```bash
+helm repo add danihodovic https://danihodovic.github.io/helm-charts
+```
+
+Install the chart:
+
+```bash
+helm install celery-exporter danihodovic/celery-exporter
+```
+
+
+You'll need to set the enviroment variable `CELERY_BROKER_URL` to the broker url of your celery instance.
+
+For example:
+
+```bash
+helm install celery-exporter danihodovic/celery-exporter --set env[0].name=CELERY_BROKER_URL,env[0].value=redis://redis:6379/0
+```
+
 ## Maintainers
 
-| Name        | Email | Url |
-| ----------- | ----- | --- |
-| danihodovic |       |     |
-| adinhodovic |       |     |
+| Name | Email | Url |
+| ---- | ------ | --- |
+| danihodovic |  |  |
+| adinhodovic |  |  |
 
 ## Source Code
 
-- <https://github.com/danihodovic/celery-exporter>
+* <https://github.com/danihodovic/celery-exporter>
 
 ## Values
 
-| Key                                | Type   | Default                         | Description |
-| ---------------------------------- | ------ | ------------------------------- | ----------- |
-| affinity                           | object | `{}`                            |             |
-| fullnameOverride                   | string | `""`                            |             |
-| image.pullPolicy                   | string | `"IfNotPresent"`                |             |
-| image.repository                   | string | `"danihodovic/celery-exporter"` |             |
-| image.tag                          | string | `""`                            |             |
-| imagePullSecrets                   | list   | `[]`                            |             |
-| ingress.annotations                | object | `{}`                            |             |
-| ingress.className                  | string | `""`                            |             |
-| ingress.enabled                    | bool   | `false`                         |             |
-| ingress.hosts[0].host              | string | `"celery-exporter.example"`     |             |
-| ingress.hosts[0].paths[0].path     | string | `"/"`                           |             |
-| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"`      |             |
-| ingress.tls                        | list   | `[]`                            |             |
-| nameOverride                       | string | `""`                            |             |
-| nodeSelector                       | object | `{}`                            |             |
-| podAnnotations                     | object | `{}`                            |             |
-| podSecurityContext                 | object | `{}`                            |             |
-| replicaCount                       | int    | `1`                             |             |
-| resources                          | object | `{}`                            |             |
-| securityContext                    | object | `{}`                            |             |
-| service.port                       | int    | `9808`                          |             |
-| service.type                       | string | `"ClusterIP"`                   |             |
-| serviceAccount.annotations         | object | `{}`                            |             |
-| serviceAccount.create              | bool   | `true`                          |             |
-| serviceAccount.name                | string | `""`                            |             |
-| serviceMonitor.additionalLabels    | object | `{}`                            |             |
-| serviceMonitor.enabled             | bool   | `false`                         |             |
-| serviceMonitor.metricRelabelings   | list   | `[]`                            |             |
-| serviceMonitor.namespace           | string | `""`                            |             |
-| serviceMonitor.namespaceSelector   | object | `{}`                            |             |
-| serviceMonitor.relabelings         | list   | `[]`                            |             |
-| serviceMonitor.scrapeInterval      | string | `"30s"`                         |             |
-| serviceMonitor.targetLabels        | list   | `[]`                            |             |
-| tolerations                        | list   | `[]`                            |             |
-| livenessProbe.timeoutSeconds       | object | `5`                             |             |
-| livenessProbe.failureThreshold     | object | `5`                             |             |
-| livenessProbe.periodSeconds        | object | `10`                            |             |
-| livenessProbe.successThreshold     | object | `1`                             |             |
-| readinessProbe.timeoutSeconds      | object | `5`                             |             |
-| readinessProbe.failureThreshold    | object | `5`                             |             |
-| readinessProbe.periodSeconds       | object | `10`                            |             |
-| readinessProbe.namespaceSelector   | object | `1`                             |             |
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| env | list | `[]` |  |
+| fullnameOverride | string | `""` |  |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"danihodovic/celery-exporter"` |  |
+| image.tag | string | `""` |  |
+| imagePullSecrets | list | `[]` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `""` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.hosts[0].host | string | `"celery-exporter.example"` |  |
+| ingress.hosts[0].paths[0].path | string | `"/"` |  |
+| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` |  |
+| ingress.tls | list | `[]` |  |
+| livenessProbe | object | `{}` |  |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` |  |
+| podAnnotations | object | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| readinessProbe | object | `{}` |  |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| securityContext | object | `{}` |  |
+| service.port | int | `9808` |  |
+| service.type | string | `"ClusterIP"` |  |
+| serviceAccount.annotations | object | `{}` |  |
+| serviceAccount.create | bool | `true` |  |
+| serviceAccount.name | string | `""` |  |
+| serviceMonitor.additionalLabels | object | `{}` |  |
+| serviceMonitor.enabled | bool | `false` |  |
+| serviceMonitor.metricRelabelings | list | `[]` |  |
+| serviceMonitor.namespace | string | `""` |  |
+| serviceMonitor.namespaceSelector | object | `{}` |  |
+| serviceMonitor.relabelings | list | `[]` |  |
+| serviceMonitor.scrapeInterval | string | `"30s"` |  |
+| serviceMonitor.targetLabels | list | `[]` |  |
+| tolerations | list | `[]` |  |