status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-01-11 22:34:55 +00:00
Code Issues Projects Releases Wiki Activity

minor changes to the gatewayclass documentation

Browse Source
This commit is contained in:
trujillo-adam 2022-07-27 16:08:54 -07:00
parent 62003637df
commit 176a56839e
1 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
website/content/docs/api-gateway/configuration/gatewayclass.mdx
View File

@ -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. 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 ## 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 * [`controllerName`](#controllername): string | required
* [`parametersRef`](#parametersref): object | optional * [`parametersRef`](#parametersref): object | optional
* [`group`]([#parametersref-group): Group | required is parametersRef is set * [`group`]([#parametersref-group): string | required is `parametersRef` is set
* [`kind`](#parametersref-kind): Kind | required is parametersRef is set * [`kind`](#parametersref-kind): string | required is `parametersRef` is set
* [`name`](#parametersref-name): string | required is parametersRef is set * [`name`](#parametersref-name): string | required is `parametersRef` is set
* [`description`](#description): string | optional * [`description`](#description): string | optional
## Specification ## Specification
@ -33,41 +34,39 @@ The `GatewayClass` resource is a generic kubernetes gateway object. For configur
This topic provides details about the configuration parameters. This topic provides details about the configuration parameters.
### controllerName ### 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 * Type: string
* Required: required * Required: required
You must specify the following value:
* `'hashicorp.com/consul-api-gateway-controller'`
### parametersRef ### 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 * Type: object
* Required: required * Required: required
### parametersRef.group ### parametersRef.group
The Kubernetes group of the `parametersRef`. This value will always be the same across all deployments of Consul API Gateway. Specifies the Kubernetes group that the `parametersRef` is a member of. The value must always be `api-gateway.consul.hashicorp.com`.
* Type: Group
* Required: required
You must specify the following value: The `parametersRef.group` is always the same across all deployments of Consul API Gateway.
* `api-gateway.consul.hashicorp.com`
* Type: string
* Required: required
### parametersRef.kind ### parametersRef.kind
The Kubernetes kind of the `parametersRef`. This value will always be the same across all deployments of Consul API Gateway. Specifies the Kubernetes kind of entity that the `parametersRef` is. The value must always be `GatewayClassConfig`.
* Type: Kind
This `parametersRef.kind` is always the same across all deployments of Consul API Gateway.
* Type: string
* Required: required * Required: required
You must specify the following value:
* `GatewayClassConfig`
### parametersRef.name ### parametersRef.name
The name of the `GatewayClassConfig` object Specfies the name of the `GatewayClassConfig` object.
* Type: object * Type: object
* Required: required * Required: required
### description ### 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 * Type: string
* Required: optional * Required: optional