oncall-engine/helm/README.md
Michael Derynck 0efe51d310
Update helm chart for newer grafana + enable externalServiceAccounts (#4876)
# What this PR does
Updates the helm chart and docker compose files with the required
changes to support the plugin initialization changes. Updated
instructions on the README.md show how to setup & intialize OnCall
without needing to go to the configuration page, this is currently the
preferred method.

## Which issue(s) this PR closes

Related to [issue link here]

<!--
*Note*: If you want the issue to be auto-closed once the PR is merged,
change "Related to" to "Closes" in the line above.
If you have more than one GitHub issue that this PR closes, be sure to
preface
each issue link with a [closing
keyword](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue).
This ensures that the issue(s) are auto-closed once the PR has been
merged.
-->

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated
- [ ] Documentation added (or `pr:no public docs` PR label added if not
required)
- [ ] Added the relevant release notes label (see labels prefixed w/
`release:`). These labels dictate how your PR will
    show up in the autogenerated release notes.

---------

Co-authored-by: GitHub Actions <actions@github.com>
2024-09-05 12:18:07 -06:00

60 lines
1.7 KiB
Markdown

# How to run the chart locally
1. Create the cluster with [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
> Make sure ports 30001, 30002 (Grafana, optional) are available
```bash
kind create cluster --image kindest/node:v1.24.7 --config kind.yml
```
2. (Optional) Build oncall image locally and load it to kind cluster
```bash
docker build ../engine -t oncall/engine:latest --target dev
kind load docker-image oncall/engine:latest
```
Also make sure to add the following lines to your `simple.yml` (you may also need to enable `devMode`):
```yaml
image:
repository: oncall/engine
tag: latest
pullPolicy: IfNotPresent
oncall:
devMode: true
```
Alternatively you can also pass an extra `--values ./local_image.yml` in the command below.
3. Install the helm chart
```bash
helm install helm-testing \
--wait \
--values ./simple.yml \
./oncall
```
4. Get credentials
```bash
echo "\n\nOpen Grafana on localhost:30002 with credentials - user: admin, password: $(kubectl get secret --namespace default helm-testing-grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo)"
echo "Open Plugins -> Grafana OnCall -> fill form: backend url: http://host.docker.internal:30001"
```
5. Clean up
If you happen to `helm uninstall helm-testing` be sure to delete all the Persistent Volume Claims, as Postgres stores
the auto-generated password on disk, and the next `helm install` will fail.
```bash
kubectl delete pvc --all
kubectl delete pv --all
```
This, of course, will delete all the PVs and PVCs also :-)
```bash
kind delete cluster
```