Browse Source

Add extraEnvironmentVars and client.affinity to Helm values (#8997)

Document client.extraEnvironmentVars, server.extraEnvironmentVars, and
client.affinity Helm chart values.

Remove deprecated connectInject.imageEnvoy and meshGateway.imageEnvoy
values.
pull/9011/head
Blake Covarrubias 4 years ago committed by GitHub
parent
commit
0c6d1ff3c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 20
      website/pages/docs/k8s/helm.mdx

20
website/pages/docs/k8s/helm.mdx

@ -380,6 +380,12 @@ and consider if they're appropriate for your deployment.
"annotation-key": "annotation-value"
```
- `extraEnvironmentVars` ((#v-server-extra-environment-vars (`string: "{}"`) - extraEnvironmentVars
is a list of extra environment variables to set within the stateful set.
These could be used to include proxy settings required for cloud auto-join
feature, in case kubernetes cluster is behind egress http proxies. Additionally,
it could be used to configure custom consul parameters.
- `externalServers` ((#v-externalservers)) - Configuration for Consul servers when the servers are running outside of Kubernetes.
When running external servers, configuring these values is recommended
if setting `global.tls.enableAutoEncrypt` to true (requires consul-k8s >= 0.13.0)
@ -512,6 +518,9 @@ and consider if they're appropriate for your deployment.
beta.kubernetes.io/arch: amd64
```
- `affinity` ((#v-client-affinity)) (`string`) - This value defines the [affinity](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)
for client pods, formatted as a multi-line YAML string.
- `priorityClassName` ((#v-client-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.
@ -524,6 +533,12 @@ and consider if they're appropriate for your deployment.
"sample/annotation2": "bar"
```
- `extraEnvironmentVars` ((#v-client-extra-environment-vars (`string: "{}"`) - extraEnvironmentVars
is a list of extra environment variables to set with the pod. These could be
used to include proxy settings required for cloud auto-join feature,
in case kubernetes cluster is behind egress http proxies. Additionally, it
could be used to configure custom consul parameters.
- `dnsPolicy` ((#v-client-dnspolicy)) (`string: null`) - This value defines the [Pod DNS policy](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy)
for client pods to use.
@ -616,6 +631,7 @@ and consider if they're appropriate for your deployment.
`namespace1` and `namespace2` to be synced and registered with Consul. All other
k8s namespaces will be ignored. Note: `k8sDenyNamespaces` takes precedence over
values defined here. Requires consul-k8s v0.12+
- `k8sDenyNamespaces` ((#v-synccatalog-k8sdenynamespaces)) (`[]string: ["kube-system", "kube-public"]` - list of k8s namespaces that should not have their services synced. This list takes precedence over `k8sAllowNamespaces`. `*` is not supported because then nothing would be allowed to sync. Requires consul-k8s v0.12+.
For example, if `k8sAllowNamespaces` is `["*"]` and `k8sDenyNamespaces` is `["namespace1", "namespace2"]`, then all k8s namespaces besides `namespace1` and `namespace2` will be synced.
@ -734,8 +750,6 @@ and consider if they're appropriate for your deployment.
- `imageConsul` ((#v-connectinject-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.
- `imageEnvoy` ((#v-connectinject-imageenvoy)) (`string: ""`) - The name of the Docker image (including any tag) for the Envoy sidecar. `envoy` must be on the executable path within this image. This Envoy version must be compatible with the Consul version used by the injector. If not specified this defaults to letting the injector choose the Envoy image. Check [supported Envoy versions](/docs/connect/proxies/envoy#supported-versions) to ensure the version you are using is compatible with Consul.
- `namespaceSelector` ((#v-connectinject-namespaceselector)) (`string: ""`) - A [selector](https://
kubernetes.io/docs/concepts/overview/working-with-objects/labels/)
for restricting injection to only matching namespaces. By default all namespaces
@ -965,8 +979,6 @@ and consider if they're appropriate for your deployment.
- `additionalspec` ((#v-meshgateway-service-additionalspec)) (`string: null`) - Optional YAML string that will be appended to the Service spec.
- `imageEnvoy` ((#v-meshgateway-imageenvoy)) (`string: "envoyproxy/envoy:v1.13.0"`) - Envoy image to use. For Consul v1.7+, Envoy version 1.13+ is required.
- `hostNetwork` ((#v-meshgateway-hostnetwork)) (`boolean: false`) - If set to true, gateway Pods will run on the host network.
- `dnsPolicy` ((#v-meshgateway-dnspolicy)) (`string: null`) - `dnsPolicy` to use.

Loading…
Cancel
Save