Skip to content

Commit

Permalink
add helm_extensions documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam-D-Lewis committed Oct 27, 2021
1 parent b04ecf0 commit 1818068
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/source/admin_guide/custom-helm-charts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Other Helm Charts

Arbitrary helm charts can be deployed and managed with the qhub-config.yaml file.

Prefect is a workflow automation system. QHub integrates Prefect with a
feature flag as follows (in the top level):

As an example, deployinging the redis helm chart with qhub might look like the below:

```yaml
helm_extensions:
- name: my-redis-deployment
repository: https://charts.bitnami.com/bitnami
chart: redis
version: 15.5.1
overrides:
diagnosticMode:
enabled: true
```
The `overrides` section is optional, but corresponds to the helm chart's [values.yaml](https://helm.sh/docs/chart_template_guide/values_files/) file, and allows you to override the default helm chart settings.

1 change: 1 addition & 0 deletions docs/source/admin_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ system_maintenance.md
monitoring.md
clearml.md
prefect.md
custom-helm-charts.md
faq.md
```

0 comments on commit 1818068

Please sign in to comment.