From 6fb2134e96016691af29fa84dde9725f94f93263 Mon Sep 17 00:00:00 2001 From: Rebecca Zanzig Date: Thu, 25 Oct 2018 08:41:59 -0700 Subject: [PATCH] Add connectInject `image` info into helm docs This field was added back into the helm chart, but it was not added back to the documentation. This adds it, then additionally fixes a few typos in the same file. --- website/source/docs/platform/k8s/helm.html.md | 28 ++++++++++--------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/website/source/docs/platform/k8s/helm.html.md b/website/source/docs/platform/k8s/helm.html.md index be425fd4c0..ef47b7a5e4 100644 --- a/website/source/docs/platform/k8s/helm.html.md +++ b/website/source/docs/platform/k8s/helm.html.md @@ -53,7 +53,7 @@ $ helm install --dry-run ./ ~> **Warning:** By default, the chart will install _everything_: a Consul server cluster, client agents on all nodes, feature components, etc. This provides a nice out-of-box experience for new users, but may not be -appropriate for a production setup. Considering setting the `global.enabled` +appropriate for a production setup. Consider setting the `global.enabled` value to `false` and opt-in to the various components. ## Configuration (Values) @@ -94,7 +94,7 @@ and consider if they're appropriate for your deployment. - `datacenter` (`string: "dc1"`) - The name of the datacenter that the agent cluster should register as. - This must not be changed once the cluster is bootstrapped and running, + This may not be changed once the cluster is bootstrapped and running, since Consul doesn't yet support an automatic way to change this value. @@ -153,8 +153,7 @@ and consider if they're appropriate for your deployment. 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 has the following - supports the following keys: + The value of this should be a list of objects. Each object supports the following keys: * `type` (`string: required`) - Type of the volume, must be one of "configMap" or "secret". Case sensitive. @@ -213,8 +212,7 @@ and consider if they're appropriate for your deployment. 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 has the following - supports the following keys: + The value of this should be a list of objects. Each object supports the following keys: * `type` (`string: required`) - Type of the volume, must be one of "configMap" or "secret". Case sensitive. @@ -306,6 +304,17 @@ and consider if they're appropriate for your deployment. Connect injector process to run. This will enable the injector but will require pods to opt-in with an annotation by default. + - `image` (`string: global.imageK8S`) - + The name of the Docker image (including any tag) for the + [consul-k8s](https://github.com/hashicorp/consul-k8s) binary. + + - `default` (`boolean: false`) - + If true, the injector will inject the Connect sidecar into all pods by + default. Otherwise, pods must specify the + [injection annotation](/docs/platform/k8s/connect.html#consul-hashicorp-com-connect-inject) + to opt-in to Connect injection. If this is true, pods can use the same + annotation to explicitly opt-out of injection. + - `imageConsul` (`string: global.image`) - The name of the Docker image (including any tag) for Consul. This is used for proxy service registration, Envoy configuration, etc. @@ -317,13 +326,6 @@ and consider if they're appropriate for your deployment. This defaults to letting the injector choose the Envoy image, which is usually `envoy/envoy-alpine`. - - `default` (`boolean: false`) - - If true, the injector will inject the Connect sidecar into all pods by - default. Otherwise, pods must specify the - [injection annotation](/docs/platform/k8s/connect.html#consul-hashicorp-com-connect-inject) - to opt-in to Connect injection. If this is true, pods can use the same - annotation to explicitly opt-out of injection. - - `namespaceSelector` (`string: ""`) - A [selector](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) for restricting injection to only matching namespaces. By default