From caea307e8b65d043ec605fe744d0db5da1ebba35 Mon Sep 17 00:00:00 2001 From: Sarah Alsmiller Date: Mon, 7 Nov 2022 17:21:15 -0600 Subject: [PATCH] added tolerations doc --- .../configuration/gatewayclassconfig.mdx | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx b/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx index 2aba347737e5..e93f193a500c 100644 --- a/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx +++ b/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx @@ -39,6 +39,7 @@ The following outline shows how to format the configurations in the `GatewayClas * [`envoy`](#image-envoy): string | optional * [`logLevel`](#loglevel): string | optional * [`nodeSelector`](#nodeselector): string | optional +* [`tolerations`](#tolerations): array of objects | optional * [`serviceType`](#servicetype): string | optional * [`useHostPorts`](#usehostports): boolean | optional @@ -158,6 +159,46 @@ Pods normally run on multiple nodes. You can specify a set of parameters in the * Type: string * Required: optional +### tolerations +When opperating Kubernetes, it is possible to apply a taint to a node running pods. Tolerations allow you to specify which pods are allowed to run on those tained nodes. Refer to the [Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) for additional information. + +* Type: Array of Objects +* Required: optional + +You can create an array of the following object to specify a toleration +#### toleration.key +The key value of the taint being described + +* Type: string +* Required: yes + +#### toleration.operator +The operation being applied to the taints being allowed. + +* Type: string +* Required: yes +* Default: Equal + +You can specify the following strings +* `Equal` +* `Exists` +#### toleration.value +If the operator is "Equal", the value being matched + +* Type: string +* Required: If operator is set to "Equal" + +#### toleration.effect +The effect the taint should cause the pod + +* Type: string +* Required: no + +You can specify the following strings: +* `NoExecute` +* `NoSchedule` +* `PreferNoSchedule` + ### serviceType Specifies the ingress methods for the gateway's Kubernetes service. * Type: string