From 18e9f925b83d742a262a74252bdd86bdd22ebd77 Mon Sep 17 00:00:00 2001 From: Rebecca Zanzig <16315901+adilyse@users.noreply.github.com> Date: Fri, 31 Jul 2020 15:11:15 -0700 Subject: [PATCH] Add lifecycle sidecar and init container resource settings docs --- website/pages/docs/k8s/helm.mdx | 88 +++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) diff --git a/website/pages/docs/k8s/helm.mdx b/website/pages/docs/k8s/helm.mdx index 623ea67f5f..e28989f602 100644 --- a/website/pages/docs/k8s/helm.mdx +++ b/website/pages/docs/k8s/helm.mdx @@ -182,6 +182,25 @@ and consider if they're appropriate for your deployment. - `secretKey` ((#v-global-cakey-secretkey)) (`string: null`) - The key of the Kubernetes secret. + - `lifecycleSidecarContainer` ((#v-global-lifecycle)) - The lifecycle sidecar ensures the Consul services + are always registered with their local Consul clients and is used by the ingress/terminating/mesh gateways + as well as with every Connect-injected service. + + - `resources` ((#v-global-lifecycle-resources)) (`map`) - The resource requests and limits (CPU, memory, etc.) + for each of the lifecycle sidecar containers. This should be a YAML map of a Kubernetes + [ResourceRequirements](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) object. See values file for defaults. + + ```yaml + # Resources are defined as a YAML map: + resources: + requests: + memory: "25Mi" + cpu: "20m" + limits: + memory: "50Mi" + cpu: "20m" + ``` + - `server` ((#v-server)) - Values that configure running a Consul server within Kubernetes. - `enabled` ((#v-server-enabled)) (`boolean: global.enabled`) - If true, the chart will install all @@ -767,6 +786,24 @@ and consider if they're appropriate for your deployment. } ``` + - `initContainer` ((#v-connectinject-init)) - As part of the Connect injection process, a utility init container + is created that runs various startup tasks including registering the service with Consul. + + - `resources` ((#v-connectinject-init-resources)) (`map`) - The resource requests and limits (CPU, memory, etc.) + for all of the Connect-injected init containers. This should be a YAML map of a Kubernetes + [ResourceRequirements](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) object. See values file for defaults. + + ```yaml + # Resources are defined as a YAML map: + resources: + requests: + memory: "25Mi" + cpu: "20m" + limits: + memory: "50Mi" + cpu: "20m" + ``` + - `meshGateway` ((#v-meshgateway)) - Configure mesh gateways. - `enabled` ((#v-meshgateway-enabled)) (`boolean: true`) - If mesh gateways are enabled, a Deployment will be created that runs @@ -866,6 +903,23 @@ and consider if they're appropriate for your deployment. - `resources` ((#v-meshgateway-resources)) (`string`) - Resources for gateway pods. See values file for default. + - `initCopyConsulContainer` ((#v-meshgateway-init)) - A utility init container used to copy the Consul binary into a shared location. + + - `resources` ((#v-meshgateway-init-resources)) (`map`) - The resource requests and limits (CPU, memory, etc.) + for the `copy-consul-bin` init container. This should be a YAML map of a Kubernetes + [ResourceRequirements](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) object. See values file for defaults. + + ```yaml + # Resources are defined as a YAML map: + resources: + requests: + memory: "25Mi" + cpu: "50m" + limits: + memory: "150Mi" + cpu: "50m" + ``` + - `affinity` ((#v-meshgateway-affinity)) (`string`) - Affinity setting for gateway pods. See values file for default. - `tolerations` ((#v-meshgateway-tolerations)) (`string: null`) - Optional YAML string to specify tolerations. @@ -905,6 +959,23 @@ and consider if they're appropriate for your deployment. - `resources` ((#v-ingressgateways-defaults-resources)) (`string`) - Resources for gateway pods. See values file for default. + - `initCopyConsulContainer` ((#v-ingressgateways-defaults-init)) - A utility init container used to copy the Consul binary into a shared location. + + - `resources` ((#v-ingressgateways-defaults-init-resources)) (`map`) - The resource requests and limits (CPU, memory, etc.) + for the `copy-consul-bin` init container. This should be a YAML map of a Kubernetes + [ResourceRequirements](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) object. See values file for defaults. + + ```yaml + # Resources are defined as a YAML map: + resources: + requests: + memory: "25Mi" + cpu: "50m" + limits: + memory: "150Mi" + cpu: "50m" + ``` + - `affinity` ((#v-ingressgateways-defaults-affinity)) (`string`) - Affinity setting for gateway pods. See values file for default. - `tolerations` ((#v-ingressgateways-defaults-tolerations)) (`string: null`) - Optional YAML string to specify tolerations. @@ -948,6 +1019,23 @@ and consider if they're appropriate for your deployment. - `resources` ((#v-terminatinggateways-defaults-resources)) (`string`) - Resources for gateway pods. See values file for default. + - `initCopyConsulContainer` ((#v-terminatinggateways-defaults-init)) - A utility init container used to copy the Consul binary into a shared location. + + - `resources` ((#v-terminatinggateways-defaults-init-resources)) (`map`) - The resource requests and limits (CPU, memory, etc.) + for the `copy-consul-bin` init container. This should be a YAML map of a Kubernetes + [ResourceRequirements](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) object. See values file for defaults. + + ```yaml + # Resources are defined as a YAML map: + resources: + requests: + memory: "25Mi" + cpu: "50m" + limits: + memory: "150Mi" + cpu: "50m" + ``` + - `affinity` ((#v-terminatinggateways-defaults-affinity)) (`string`) - Affinity setting for gateway pods. See values file for default. - `tolerations` ((#v-terminatinggateways-defaults-tolerations)) (`string: null`) - Optional YAML string to specify tolerations.