Skip to content

Commit

Permalink
[DOC] Update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Akshay Iyyadurai Balasundaram <[email protected]>
  • Loading branch information
ibakshay committed Nov 8, 2024
1 parent 97ac588 commit 1ff5ae1
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions charts/perses/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Perses helm chart

![Version: 0.6.1](https://img.shields.io/badge/Version-0.6.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.49.0](https://img.shields.io/badge/AppVersion-v0.49.0-informational?style=flat-square)
![Version: 0.7.1](https://img.shields.io/badge/Version-0.7.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.49.0](https://img.shields.io/badge/AppVersion-v0.49.0-informational?style=flat-square)

## Installing the Chart

Expand Down Expand Up @@ -41,6 +41,7 @@ helm delete my-release
| config.security.cookie | object | `{"same_site":"lax","secure":false}` | cookie config |
| config.security.enableAuth | bool | `false` | Enable Authentication |
| config.security.readOnly | bool | `false` | Configure Perses instance as readonly |
| datasources | list | `[]` | Configure datasources DEPRECATED: This field will be removed in the future release. Please use the 'sidecar' configuration to provision datasources. ref: https://github.com/perses/perses/blob/90beed356243208f14cf2249bebb6f6222cb77ae/docs/datasource.md |
| fullnameOverride | string | `""` | Override fully qualified app name |
| image.name | string | `"persesdev/perses"` | Perses image repository and name |
| image.pullPolicy | string | `"IfNotPresent"` | Default image pull policy |
Expand Down Expand Up @@ -77,11 +78,11 @@ helm delete my-release
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
| 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 |
| sidecar | object | `{"enabled":true,"image":{"repository":"kiwigrid/k8s-sidecar","tag":"1.28.0"},"label":"perses-resource","labelValue":"true"}` | Sidecar configuration that watches for ConfigMaps with the specified label/labelValue and loads them into Perses provisioning |
| sidecar.enabled | bool | `true` | Enable the sidecar container for ConfigMap provisioning |
| sidecar | object | `{"enabled":false,"image":{"repository":"kiwigrid/k8s-sidecar","tag":"1.28.0"},"label":"perses.dev/resource","labelValue":"true"}` | Sidecar configuration that watches for ConfigMaps with the specified label/labelValue and loads them into Perses provisioning |
| sidecar.enabled | bool | `false` | Enable the sidecar container for ConfigMap provisioning |
| sidecar.image.repository | string | `"kiwigrid/k8s-sidecar"` | Container image repository for the sidecar |
| sidecar.image.tag | string | `"1.28.0"` | Container image tag for the sidecar |
| sidecar.label | string | `"perses-resource"` | Label key to watch for ConfigMaps containing Perses resources |
| sidecar.label | string | `"perses.dev/resource"` | Label key to watch for ConfigMaps containing Perses resources |
| sidecar.labelValue | string | `"true"` | Label value to watch for ConfigMaps containing Perses resources |
| volumeMounts | list | `[]` | Additional VolumeMounts on the output StatefulSet definition. |
| volumes | list | `[]` | Additional volumes on the output StatefulSet definition. |
Expand Down

0 comments on commit 1ff5ae1

Please sign in to comment.