From 3c6bf3eb4748e504cd92c14baa77ec0171f6449c Mon Sep 17 00:00:00 2001 From: Rebecca Zanzig Date: Tue, 20 Nov 2018 10:56:11 -0800 Subject: [PATCH] Update type for `resources` variables These were changed to multi-line strings to match the affinity definition. --- website/source/docs/platform/k8s/helm.html.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/website/source/docs/platform/k8s/helm.html.md b/website/source/docs/platform/k8s/helm.html.md index a232f13623..e5d8ae09e1 100644 --- a/website/source/docs/platform/k8s/helm.html.md +++ b/website/source/docs/platform/k8s/helm.html.md @@ -142,9 +142,9 @@ and consider if they're appropriate for your deployment. CA and set of certificates. Additional Connect settings can be configured by setting the `server.extraConfig` value. - - `resources` (`object: {}`) - + - `resources` (`string: null`) - The resource requests (CPU, memory, etc.) for each of the server agents. - This should be an object mapping directly to a Kubernetes + This should be a multi-line string mapping directly to a Kubernetes [ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#resourcerequirements-v1-core) object. If this isn't specified, then the pods won't request any specific amount of resources. **Setting this is highly recommended.** @@ -216,11 +216,25 @@ and consider if they're appropriate for your deployment. The name of the Docker image (including any tag) for the containers running Consul client agents. + - `join` (`array: null`) - + A list of valid [`-retry-join` values](/docs/agent/options.html#retry-join). + If this is `null` (default), + then the clients will attempt to automatically join the server cluster + running within Kubernetes. This means that with `server.enabled` set to true, + clients will automatically join that cluster. If `server.enabled` is not + true, then a value must be specified so the clients can join a valid cluster. + - `grpc` (`boolean: false`) - If true, agents will enable their GRPC listener on port 8502 and expose it to the host. This will use slightly more resources, but is required for [Connect](/docs/platform/k8s/connect.html). + - `resources` (`string: null`) - + The resource requests (CPU, memory, etc.) for each of the client agents. + This should be a multi-line string mapping directly to a Kubernetes + [ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#resourcerequirements-v1-core) object. If this isn't specified, then the pods + won't request any specific amount of resources. + - `extraConfig` (`string: "{}"`) - A raw string of extra JSON or HCL configuration for Consul clients. This will be saved as-is into a ConfigMap that is read by the Consul agents. @@ -245,20 +259,6 @@ and consider if they're appropriate for your deployment. configuration files from this volume with `-config-dir`. This defaults to false. - - `join` (`array: null`) - - A list of valid [`-retry-join` values](/docs/agent/options.html#retry-join). - If this is `null` (default), - then the clients will attempt to automatically join the server cluster - running within Kubernetes. This means that with `server.enabled` set to true, - clients will automatically join that cluster. If `server.enabled` is not - true, then a value must be specified so the clients can join a valid cluster. - - - `resources` (`object: {}`) - - The resource requests (CPU, memory, etc.) for each of the client agents. - This should be an object mapping directly to a Kubernetes - [ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#resourcerequirements-v1-core) object. If this isn't specified, then the pods - won't request any specific amount of resources. - * `dns` - Values that configure the Consul DNS service. - `enabled` (`boolean: global.enabled`) -