Skip to content

Commit

Permalink
added tolerations doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahalsmiller committed Nov 7, 2022
1 parent 5728d69 commit caea307
Showing 1 changed file with 41 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit caea307

Please sign in to comment.