From 5b322d84e4be7b466bad1670733a01eb94f20c3c Mon Sep 17 00:00:00 2001 From: Rebecca Zanzig Date: Tue, 5 Mar 2019 15:04:12 -0800 Subject: [PATCH] Add examples for the `extraConfig` options in the Helm chart --- website/source/docs/platform/k8s/helm.html.md | 20 +++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/website/source/docs/platform/k8s/helm.html.md b/website/source/docs/platform/k8s/helm.html.md index 5a39c5684..24a638bb1 100644 --- a/website/source/docs/platform/k8s/helm.html.md +++ b/website/source/docs/platform/k8s/helm.html.md @@ -127,7 +127,15 @@ and consider if they're appropriate for your deployment. flag to the helm chart installation command because of a limitation in the Helm templating language. - * `extraConfig` (`string: "{}"`) -A raw string of extra JSON or HCL configuration for Consul servers. This will be saved as-is into a ConfigMap that is read by the Consul server agents. This can be used to add additional configuration that isn't directly exposed by the chart. + * `extraConfig` (`string: "{}"`) - A raw string of extra JSON [configuration](/docs/agent/options.html) for Consul servers. This will be saved as-is into a ConfigMap that is read by the Consul server agents. This can be used to add additional configuration that isn't directly exposed by the chart. + + ```yaml + # ExtraConfig values are formatted as a multi-line string: + extraConfig: | + { + "log_level": "DEBUG" + } + ``` * `extraVolumes` (`array: []`) - A list of extra volumes to mount for server agents. This is useful for bringing in extra data that can be referenced by other configurations at a well known path, such as TLS certificates or Gossip encryption keys. The value of this should be a list of objects. Each object supports the following keys: @@ -185,7 +193,15 @@ and consider if they're appropriate for your deployment. memory: "10Gi" ``` - * `extraConfig` (`string: "{}"`) - 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. This can be used to add additional configuration that isn't directly exposed by the chart. + * `extraConfig` (`string: "{}"`) - A raw string of extra JSON [configuration](/docs/agent/options.html) for Consul clients. This will be saved as-is into a ConfigMap that is read by the Consul agents. This can be used to add additional configuration that isn't directly exposed by the chart. + + ```yaml + # ExtraConfig values are formatted as a multi-line string: + extraConfig: | + { + "log_level": "DEBUG" + } + ``` * `extraVolumes` (`array: []`) - A list of extra volumes to mount for client agents. This is useful for bringing in extra data that can be referenced by other configurations at a well known path, such as TLS certificates or Gossip encryption keys. The value of this should be a list of objects. Each object supports the following keys: