luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

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.
This commit is contained in:
Rebecca Zanzig 2019-01-14 16:15:26 -08:00
parent 737143418d
commit c085f005e1
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
website/source/docs/platform/k8s/helm.html.md
View File

@ -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.
- <a name="v-synccatalog-k8sprefix" href="#v-synccatalog-k8sprefix">`k8sPrefix`</a> (`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.
- <a name="v-synccatalog-toconsul" href="#v-synccatalog-toconsul">`toConsul`</a> (`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.
- <a name="v-synccatalog-k8sprefix" href="#v-synccatalog-k8sprefix">`k8sPrefix`</a> (`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)
- <a name="v-synccatalog-k8stag" href="#v-synccatalog-k8stag">`k8sTag`</a> (`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)
- <a name="v-synccatalog-clusterip-sync" href="#v-synccatalog-clusterip-sync">`syncClusterIPServices`</a> (`boolean: true`) -
If true, will sync Kubernetes ClusterIP services to Consul. This can be disabled to
have the sync ignore ClusterIP-type services.
- <a name="v-synccatalog-nodeport-sync" href="#v-synccatalog-nodeport-sync">`nodePortSyncType`</a> (`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.
* <a name="v-ui" href="#v-ui">`ui`</a> - Values that configure the Consul UI.
- <a name="v-ui-enabled" href="#v-ui-enabled">`enabled`</a> (`boolean: global.enabled`) -