Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of Updates gateway-class-config docs to include fields for privileged co… into release/1.16.x #18803

Merged
merged 2 commits into from
Sep 14, 2023
Merged

Backport of Updates gateway-class-config docs to include fields for privileged co… into release/1.16.x #18803

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef7bcd0
Updates gateway-class-config docs to include fields for privileged co…
missylbytes Sep 14, 2023
1ffd4d3
Remove errant word in docs that is breaking the build
missylbytes Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ The following outline shows how to format the configurations in the `GatewayClas
* [`consulAPIGateway`](#image-consulapigateway): string | optional
* [`envoy`](#image-envoy): string | optional
* [`logLevel`](#loglevel): string | optional
* [`matchPrivilegedContainerPorts`](#matchPrivilegedContainerPorts): integer | optional
* [`nodeSelector`](#nodeselector): string | optional
* [`openshiftSCCName`](#openshiftSCCName): string | optional
* [`serviceType`](#servicetype): string | optional
* [`useHostPorts`](#usehostports): boolean | optional

Expand Down Expand Up @@ -152,12 +154,26 @@ You can specify the following strings:
* `debug`
* `trace`

### matchPrivilegedContainerPorts
Specifies a value that Consul adds to privileged ports defined in the gateway. Privileged ports are port numbers less than 1024 and some platforms, such as Red Hat OpenShift, explicitly configure Kubernetes to avoid running containers on privileged ports. The total value of the configured port number and the `matchPriviledgedContainerPorts` value must not exceed 65535, which is the highest possible TCP port number allowed.
for gateway containers
* Type: Integer
* Required: optional

You can specify an integer between `0` and `64512`

### nodeSelector
Pods normally run on multiple nodes. You can specify a set of parameters in the `nodeSelector` that constrain the nodes on which the pod can run, enabling the pod to fit on a node. The selector must match a node's labels for the pod to be scheduled on that node. Refer to the [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) for additional information.

* Type: string
* Required: optional

### openshiftSCCName
Specifies the OpenShift security context constraint (SCC) for the `GatewayClassConfig` to use. Refer to the [OpenShift SCC documentation](https://docs.openshift.com/container-platform/4.13/authentication/managing-security-context-constraints.html#default-sccs_configuring-internal-oauth) for additional information about the available default SCCs.
* Type: string
* Required: optional
* Default: `restricted-v2`

### serviceType
Specifies the ingress methods for the gateway's Kubernetes service.
* Type: string
Expand Down