From 3ac9e57efe8378b28cb9dbddb7d414e27d04ddbb Mon Sep 17 00:00:00 2001 From: Rebecca Zanzig Date: Thu, 7 Mar 2019 17:20:56 -0800 Subject: [PATCH] Add docs for new Helm `annotations` options --- website/source/docs/platform/k8s/helm.html.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/website/source/docs/platform/k8s/helm.html.md b/website/source/docs/platform/k8s/helm.html.md index fb8eb74ad8..ba27d4b603 100644 --- a/website/source/docs/platform/k8s/helm.html.md +++ b/website/source/docs/platform/k8s/helm.html.md @@ -168,6 +168,14 @@ and consider if they're appropriate for your deployment. * `priorityClassName` (`string`) - This value references an existing Kubernetes [priorityClassName](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#pod-priority) that can be assigned to server pods. + * `annotations` (`string`) - This value defines additional annotations for server pods. This should be a formatted as a multi-line string. + + ```yaml + annotations: | + "sample/annotation1": "foo" + "sample/annotation2": "bar" + ``` + * `client` - Values that configure running a Consul client on Kubernetes nodes. * `enabled` (`boolean: global.enabled`) - If true, the chart will install all the resources necessary for a Consul client on every Kubernetes node. This _does not_ require `server.enabled`, since the agents can be configured to join an external cluster. @@ -215,6 +223,14 @@ and consider if they're appropriate for your deployment. * `priorityClassName` (`string`) - This value references an existing Kubernetes [priorityClassName](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#pod-priority) that can be assigned to client pods. + * `annotations` (`string`) - This value defines additional annotations for client pods. This should be a formatted as a multi-line string. + + ```yaml + annotations: | + "sample/annotation1": "foo" + "sample/annotation2": "bar" + ``` + * `dns` - Values that configure Consul DNS service. * `enabled` (`boolean: global.enabled`) - If true, a `consul-dns` service will be created that exposes port 53 for TCP and UDP to the running Consul agents (servers and clients). This can then be used to [configure kube-dns](/docs/platform/k8s/dns.html). The Helm chart _does not_ automatically configure kube-dns.