diff --git a/website/content/docs/api-gateway/configuration/gateway.mdx b/website/content/docs/api-gateway/configuration/gateway.mdx index 5300fe7ca..c99763bae 100644 --- a/website/content/docs/api-gateway/configuration/gateway.mdx +++ b/website/content/docs/api-gateway/configuration/gateway.mdx @@ -53,7 +53,7 @@ Specify the following parameters to declare a Gateway: ## Specification -This topic provides details about the configuration parameters +This topic provides details about the configuration parameters. ### gatewayClassName Specifies the name of the `GatewayClass` resource used for the `Gateway` instance. @@ -82,18 +82,18 @@ This parameter has the following properties: * Required: required You can specify one of the following strings: -* All: Routes in all namespaces may be attached to the Gateway. -* Same: Only routes in the same namespace as the Gateway may be attached. -* Selector: Only routes in namespaces that match the selector configuration may be attached. +* `All`: Routes in all namespaces may be attached to the `Gateway`. +* `Same`: Only routes in the same namespace as the `Gateway` may be attached. +* `Selector`: Only routes in namespaces that match the `selector` may be attached. ### listeners.allowedRoutes.namespaces.selector -The `selector` configuration matches zero or more namespaces that determine which routes are allowed to attach to the listener. +Specifies a method of matching namespaces from which routes are allowed to attach to the listener. * Type: Object -* Required: Required when from is configured to selector. +* Required: Required when `from` is configured to `Selector`. The selector configuration contains one of the following objects: -* matchExpressions -* matchLabels +* `matchExpressions` +* `matchLabels` ### listeners.allowedRoutes.namespaces.selector.matchExpressions Specifies an array of requirements for matching namespaces. If a match is found, then routes from the matching namespace(s) are allowed to attach to the `Gateway`. The following table describes members of the `matchExpressions` array: @@ -128,12 +128,12 @@ namespaceSelector: For more on labels, see [Labels and Selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ### listeners.hostname -Specifies the `listeners` hostname +Specifies the `listener`'s hostname * Type: string * Required: required ### listeners.name -Specifies the `listeners` name +Specifies the `listener`'s name * Type: string * Required: required @@ -147,16 +147,16 @@ Specifies the protocol the `listener` will use * Type: string * Required: required -Allowed values `TCP`, `HTTP`, `HTTPS` +Allowed values are `TCP`, `HTTP`, or `HTTPS` ### listeners.tls * Type: Object -* Required: required if protocol is set to HTTPS +* Required: required if `protocol` is set to `HTTPS` ### listeners.tls.certificateRefs `CertificateRefs` contains a series of references to Kubernetes objects that contains TLS certificates and private keys. These certificates are used to establish a TLS handshake for requests that match the hostname of the associated `listener`. Each reference must be a Kubernetes Secret, and, if using a Secret in a namespace other than the`Gateway`'s, must have a corresponding `ReferencePolicy` created. * Type: Object or Array -* Required: required if tls is set +* Required: required if `tls` is set ### listeners.tls.mode * Type: String @@ -167,7 +167,7 @@ Allowed values `TCP`, `HTTP`, `HTTPS` * Required: optional ## Complete configuration -The following example shows a fully configured Gateway. +The following example shows a fully configured `Gateway`. ```yaml kind: Gateway diff --git a/website/content/docs/api-gateway/configuration/gatewayclass.mdx b/website/content/docs/api-gateway/configuration/gatewayclass.mdx index 5f92df12d..1988c9a32 100644 --- a/website/content/docs/api-gateway/configuration/gatewayclass.mdx +++ b/website/content/docs/api-gateway/configuration/gatewayclass.mdx @@ -22,14 +22,13 @@ The following example creates a gateway class called `test-gateway-class`: apiVersion: gateway.networking.k8s.io/v1alpha2 kind: GatewayClass metadata: - name: test-gateway-class + name: test-gateway-class spec: - controllerName: 'hashicorp.com/consul-api-gateway-controller' - parametersRef: - group: api-gateway.consul.hashicorp.com - kind: GatewayClassConfig - name: test-gateway-class-config - ``` + controllerName: 'hashicorp.com/consul-api-gateway-controller' + parametersRef: + group: api-gateway.consul.hashicorp.com + kind: GatewayClassConfig + name: test-gateway-class-config diff --git a/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx b/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx index 3d660d1a7..ed416430d 100644 --- a/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx +++ b/website/content/docs/api-gateway/configuration/gatewayclassconfig.mdx @@ -18,16 +18,15 @@ The following example creates a gateway class configuration called `test-gateway apiVersion: api-gateway.consul.hashicorp.com/v1alpha1 kind: GatewayClassConfig metadata: - name: test-gateway-class-config + name: test-gateway-class-config spec: - useHostPorts: true - logLevel: 'trace' - consul: - scheme: 'https' - ports: - http: 8501 - grpc: 8502 - ``` + useHostPorts: true + logLevel: 'trace' + consul: + scheme: 'https' + ports: + http: 8501 + grpc: 8502 diff --git a/website/content/docs/api-gateway/usage/basic-usage.mdx b/website/content/docs/api-gateway/usage/basic-usage.mdx index e6d32e1ed..864356e57 100644 --- a/website/content/docs/api-gateway/usage/basic-usage.mdx +++ b/website/content/docs/api-gateway/usage/basic-usage.mdx @@ -16,8 +16,8 @@ description: >- ```yaml apiGateway: - managedGatewayClass: - enabled: true + enabled: true + managedGatewayClass: ```