charts/README.md.gotmpl at main · obot-platform/charts · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}

{{ template "chart.description" . }}
{{ template "chart.homepageLine" . }}

{{ template "chart.maintainersSection" . }}

{{ template "chart.sourcesSection" . }}

{{ template "chart.requirementsSection" . }}

## Installation

To install the chart with the release name `obot`:
```
helm repo add obot https://charts.obot.ai
helm install obot obot/obot
```

### Note
This chart defaults to the open source version of Obot.
If you want to use the enterprise version of Obot instead, set `image.repository` to `ghcr.io/obot-platform/obot-enterprise`. To install this version, you must create an imagePullSecret and configure that in the chart.

{{ template "chart.valuesSection" . }}

## Updating this repo
This repo will be updated automatically whenever there is a release of Obot (and by extension, the helm chart). The GitHub Actions that control this can be found [here](https://github.com/obot-platform/obot/blob/main/.github/workflows/release.yml#L62).

You can manually update the documentation in this readme using `helm-docs`. If you have both the `charts` and `obot` repos checked out in the same folder, you can use this command:
```
helm-docs -c ../obot/chart -o '../../charts/README.md' --template-files '../../charts/README.md.gotmpl'
```
The template for the readme is `./README.md.gotmpl`