From 176a56839ead54867e52d90a7740511417b9ae56 Mon Sep 17 00:00:00 2001 From: trujillo-adam Date: Wed, 27 Jul 2022 16:08:54 -0700 Subject: [PATCH] minor changes to the gatewayclass documentation --- .../configuration/gatewayclass.mdx | 41 +++++++++---------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/website/content/docs/api-gateway/configuration/gatewayclass.mdx b/website/content/docs/api-gateway/configuration/gatewayclass.mdx index 918b872523..f231fed999 100644 --- a/website/content/docs/api-gateway/configuration/gatewayclass.mdx +++ b/website/content/docs/api-gateway/configuration/gatewayclass.mdx @@ -17,15 +17,16 @@ The value of the `controllerName` field must be set to `hashicorp.com/consul-api When gateways are created from a `GatewayClass`, they use the parameters specified in the `GatewayClass` at the time of instantiation. -The `GatewayClass` resource is a generic kubernetes gateway object. For configuration specific to Consul API Gateway, see [GatewayClassConfig](/docs/api-gateway/configuration/gatewayclassconfig). +The `GatewayClass` resource is a generic Kubernetes gateway object. For configuration specific to Consul API Gateway, see [GatewayClassConfig](/docs/api-gateway/configuration/gatewayclassconfig). ## Configuration model +The following outline shows how to format the configurations in the `GatewayClass` object. Click on a property name to view details about the configuration. * [`controllerName`](#controllername): string | required * [`parametersRef`](#parametersref): object | optional - * [`group`]([#parametersref-group): Group | required is parametersRef is set - * [`kind`](#parametersref-kind): Kind | required is parametersRef is set - * [`name`](#parametersref-name): string | required is parametersRef is set + * [`group`]([#parametersref-group): string | required is `parametersRef` is set + * [`kind`](#parametersref-kind): string | required is `parametersRef` is set + * [`name`](#parametersref-name): string | required is `parametersRef` is set * [`description`](#description): string | optional ## Specification @@ -33,41 +34,39 @@ The `GatewayClass` resource is a generic kubernetes gateway object. For configur This topic provides details about the configuration parameters. ### controllerName -The name of the controller that is managing the gateways of this class. +Specifies the name of the controller that manages the gateways generated by this class. The value must alwasy be `'hashicorp.com/consul-api-gateway-controller'`. + * Type: string * Required: required -You must specify the following value: -* `'hashicorp.com/consul-api-gateway-controller'` - ### parametersRef -An object that defines additional configuration required by the gateway controller. +Defines an object that specifies additional configurations required by the gateway controller. * Type: object * Required: required ### parametersRef.group -The Kubernetes group of the `parametersRef`. This value will always be the same across all deployments of Consul API Gateway. -* Type: Group -* Required: required +Specifies the Kubernetes group that the `parametersRef` is a member of. The value must always be `api-gateway.consul.hashicorp.com`. -You must specify the following value: -* `api-gateway.consul.hashicorp.com` +The `parametersRef.group` is always the same across all deployments of Consul API Gateway. + +* Type: string +* Required: required ### parametersRef.kind -The Kubernetes kind of the `parametersRef`. This value will always be the same across all deployments of Consul API Gateway. -* Type: Kind +Specifies the Kubernetes kind of entity that the `parametersRef` is. The value must always be `GatewayClassConfig`. + +This `parametersRef.kind` is always the same across all deployments of Consul API Gateway. + +* Type: string * Required: required -You must specify the following value: -* `GatewayClassConfig` - ### parametersRef.name -The name of the `GatewayClassConfig` object +Specfies the name of the `GatewayClassConfig` object. * Type: object * Required: required ### description -Helps describe a gateway class with more details +Specifies a human-readable description of the gateway class. We recommend including a description so that a record exists that describes the gateway class's purpose. * Type: string * Required: optional