Skip to content

Commit

Permalink
Remove out-of-date example from README
Browse files Browse the repository at this point in the history
After this change, charts/values.yaml is the authoritative example.

* Move `agentEnvs` example to values.yaml
* Update relative link to charts/values.yaml

Fixes rancher#21
  • Loading branch information
lindhe committed Aug 28, 2023
1 parent 476d5d0 commit 155335b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 37 deletions.
38 changes: 1 addition & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,43 +4,7 @@ This project contains rke2 cluster template helm chart, which can be applied wit

### How to use

The general cluster configuration options are available through [values.yaml](./charts/values.yaml).

```yaml
# cluster specific values
cluster:
# specify cluster name
name: cluster-example

# specify cluster labels
labels: {}

# specify cluster annotations
annotations: {}

# specify cloud credential secret name, do not need to be provided if using custom driver
cloudCredentialSecretName: example

# specify cloud provider, options are amazonec2, digitalocean, azure, vsphere or custom
cloudprovider: ""

kubernetesVersion: "v1.21.0-alpha2+rke2r1"

# specify extra env variables in cluster-agent deployment
# agentEnvs:
# - name: HTTP_PROXY
# value: foo.bar

# general RKE options
rke:
# enable local auth endpoint
localClusterAuthEndpoint:
enabled: false
# specify fqdn of local access endpoint
# fqdn: foo.bar.example
# specify cacert of local access endpoint
# caCerts: ""
```
The general cluster configuration options are available through [charts/values.yaml](charts/values.yaml).

To provide your own configuration, modify the original values.yaml and create your own version, and pass it to helm. For example:

Expand Down
5 changes: 5 additions & 0 deletions charts/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,8 @@ monitoring:
# specify cutsom values set
# values:
# foo: bar

# specify extra env variables in cluster-agent deployment
# agentEnvs:
# - name: HTTP_PROXY
# value: foo.bar

0 comments on commit 155335b

Please sign in to comment.