From c085f005e1cb437b29f99be041f2cabe3a71d7d8 Mon Sep 17 00:00:00 2001 From: Rebecca Zanzig Date: Mon, 14 Jan 2019 16:15:26 -0800 Subject: [PATCH] Add documentation about the two additional Helm chart options Adds info about `k8stag` and `nodePortSyncType` options that were added in consul-helm v0.5.0. Additionally moves the k8sprefix to match the order in the Helm chart values file, while also clarifying that it only affects one sync direction. --- website/source/docs/platform/k8s/helm.html.md | 23 +++++++++++++++---- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/website/source/docs/platform/k8s/helm.html.md b/website/source/docs/platform/k8s/helm.html.md index 46b62bc9c..4a42546cb 100644 --- a/website/source/docs/platform/k8s/helm.html.md +++ b/website/source/docs/platform/k8s/helm.html.md @@ -316,11 +316,6 @@ and consider if they're appropriate for your deployment. the service must be [annotated](/docs/platform/k8s/service-sync.html#sync-enable-disable) properly to sync. In either case an annotation can override the default. - - `k8sPrefix` (`string: ""`) - - A prefix to prepend to all services registered in Kubernetes from Consul. - This defaults to `""` where no prefix is prepended; Consul services are - synced with the same name to Kubernetes. - - `toConsul` (`boolean: true`) - If true, will sync Kubernetes services to Consul. This can be disabled to have a one-way sync. @@ -329,10 +324,28 @@ and consider if they're appropriate for your deployment. If true, will sync Consul services to Kubernetes. This can be disabled to have a one-way sync. + - `k8sPrefix` (`string: ""`) - + A prefix to prepend to all services registered in Kubernetes from Consul. + This defaults to `""` where no prefix is prepended; Consul services are + synced with the same name to Kubernetes. (Consul -> Kubernetes sync only) + + - `k8sTag` (`string: null`) - + An optional tag that is applied to all of the Kubernetes services + that are synced into Consul. If nothing is set, this defaults to "k8s". + (Kubernetes -> Consul sync only) + - `syncClusterIPServices` (`boolean: true`) - If true, will sync Kubernetes ClusterIP services to Consul. This can be disabled to have the sync ignore ClusterIP-type services. + - `nodePortSyncType` (`string: ExternalFirst`) - + Configures the type of syncing that happens for NodePort services. + The only valid options are: `ExternalOnly`, `InternalOnly`, and `ExternalFirst`. + `ExternalOnly` will only use a node's ExternalIP address for the sync, otherwise the + service will not be synced. `InternalOnly` uses the node's InternalIP address. + `ExternalFirst` will preferentially use the node's ExternalIP address, but + if it doesn't exist, it will use the node's InternalIP address instead. + * `ui` - Values that configure the Consul UI. - `enabled` (`boolean: global.enabled`) -