Add examples for helm chart multi-line strings

There has been some confusion about the formating of multi-line
string variables in the Helm chart. This adds examples for these
situations, hopefully clarifying things for users.
pull/5112/head
Rebecca Zanzig 2018-12-18 12:46:45 -08:00
parent 0b4a879203
commit ce82de1965
1 changed files with 31 additions and 0 deletions

View File

@ -149,6 +149,15 @@ and consider if they're appropriate for your deployment.
won't request any specific amount of resources. **Setting this is highly won't request any specific amount of resources. **Setting this is highly
recommended.** recommended.**
```yaml
# Resources are defined as a formatted multi-line string:
resources: |
requests:
memory: "10Gi"
limits:
memory: "10Gi"
```
- <a name="v-server-updatepartition" href="#v-server-updatepartition">`updatePartition`</a> (`integer: 0`) - - <a name="v-server-updatepartition" href="#v-server-updatepartition">`updatePartition`</a> (`integer: 0`) -
This value is used to carefully control a rolling update of Consul server This value is used to carefully control a rolling update of Consul server
agents. This value specifies the agents. This value specifies the
@ -204,6 +213,19 @@ and consider if they're appropriate for your deployment.
If you need to run more pods per node (for example, testing on Minikube), If you need to run more pods per node (for example, testing on Minikube),
set this value to `null`. set this value to `null`.
```yaml
# Recommended default server affinity:
affinity: |
podAntiAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
- labelSelector:
matchLabels:
app: {{ template "consul.name" . }}
release: "{{ .Release.Name }}"
component: server
topologyKey: kubernetes.io/hostname
```
* <a name="v-client" href="#v-client">`client`</a> - Values that configure * <a name="v-client" href="#v-client">`client`</a> - Values that configure
running a Consul client agent on Kubernetes nodes. running a Consul client agent on Kubernetes nodes.
@ -235,6 +257,15 @@ and consider if they're appropriate for your deployment.
[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#resourcerequirements-v1-core) object. If this isn't specified, then the pods [ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#resourcerequirements-v1-core) object. If this isn't specified, then the pods
won't request any specific amount of resources. won't request any specific amount of resources.
```yaml
# Resources are defined as a formatted multi-line string:
resources: |
requests:
memory: "10Gi"
limits:
memory: "10Gi"
```
- <a name="v-client-extraconfig" href="#v-client-extraconfig">`extraConfig`</a> (`string: "{}"`) - - <a name="v-client-extraconfig" href="#v-client-extraconfig">`extraConfig`</a> (`string: "{}"`) -
A raw string of extra JSON or HCL configuration for Consul clients. This A raw string of extra JSON or HCL configuration for Consul clients. This
will be saved as-is into a ConfigMap that is read by the Consul agents. will be saved as-is into a ConfigMap that is read by the Consul agents.