From 8b3bbcabbcae45cc7304b7efc38c3f2c66917ba1 Mon Sep 17 00:00:00 2001 From: Ashwin Venkatesh Date: Thu, 21 Jan 2021 15:01:24 -0500 Subject: [PATCH] Update docs with fields for ingress support for consul UI --- website/content/docs/k8s/helm.mdx | 37 +++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/website/content/docs/k8s/helm.mdx b/website/content/docs/k8s/helm.mdx index 7493c6cae1..c91eec23af 100644 --- a/website/content/docs/k8s/helm.mdx +++ b/website/content/docs/k8s/helm.mdx @@ -759,6 +759,43 @@ and consider if they're appropriate for your deployment. This should be a multi-line string mapping directly to a Kubernetes ServiceSpec object. + - `ingress` ((#v-ui-ingress)) - Configure Ingress for the Consul UI. + If `global.tls.enabled` is set to `true`, the Ingress will expose + the port 443 on the UI service. Please ensure the Ingress Controller + supports SSL pass-through and it is enabled to ensure traffic forwarded + to port 443 has not been TLS terminated. + + - `enabled` ((#v-ui-ingress-enabled)) (`boolean: false`) - This will create an Ingress resource for the Consul UI. + + - `hosts` ((#v-ui-ingress-hosts)) (`array`) - hosts is a list of host name to create Ingress rules. + + ```yaml + hosts: + - host: foo.bar + paths: + - /example + - /test + ``` + + - `tls` ((#v-ui-ingress-tls)) (`array`) - tls is a list of hosts and secret name in an Ingress + which tells the Ingress controller to secure the channel. + + ```yaml + tls: + - hosts: + - chart-example.local + secretName: testsecret-tls + ``` + + - `annotations` ((#v-ui-ingress-annotations)) (`string: null`) - Annotations to apply to the UI ingress. + + Example: + + ```yaml + annotations: | + 'annotation-key': annotation-value + ``` + - `syncCatalog` ((#v-synccatalog)) - Configure the catalog sync process to sync K8S with Consul services. This can run bidirectional (default) or unidirectionally (Consul to K8S or K8S to Consul only).