Commit 84513fb1 authored by David McKay's avatar David McKay

docs: clarify docs with example link

parent c6aacd16
...@@ -41,7 +41,9 @@ license: ...@@ -41,7 +41,9 @@ license:
The meta cluster requires a shared internal secret to secure communication. This must be provided by specifying a secret name in the `values.yaml` file. The meta cluster requires a shared internal secret to secure communication. This must be provided by specifying a secret name in the `values.yaml` file.
The secret MUST container a key called `secret` that is a randomly generated string. The Kubernetes Secret MUST contain a key called `secret` that is a randomly generated string.
Please see [example resources](./example-resources.yaml) to see what this looks like.
```yaml ```yaml
meta: meta:
...@@ -53,12 +55,28 @@ meta: ...@@ -53,12 +55,28 @@ meta:
If you want to configure authentication for your data nodes, you must provide the following within your `values.yaml`: If you want to configure authentication for your data nodes, you must provide the following within your `values.yaml`:
Please see [example resources](./example-resources.yaml) to see what this looks like.
```yaml ```yaml
# A secret with keys "username" and "password" is required # A secret with keys "username" and "password" is required
auth: bootstrap:
auth:
secretName: auth secretName: auth
``` ```
#### DDL/DML (Optional)
If you wish to create databases or import data after installation, we've provided this DDL/DML hook. Your config map must contain the keys `ddl` and `dml`.
Please see [example resources](./example-resources.yaml) to see what this looks like.
```yaml
# A ConfigMap with keys "ddl" and "dml" is required
bootstrap:
ddldml:
configMap: ddl-dml
```
## Installing the Chart ## Installing the Chart
To install the chart with the release name `my-release`: To install the chart with the release name `my-release`:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment