luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

added required and type to parametersRef

This commit is contained in:
Sarah Alsmiller 2022-08-02 13:38:31 -05:00
parent 7648a37a84
commit 3b93d5e232
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -41,13 +41,15 @@ The value must always be `hashicorp.com/consul-api-gateway-controller`.
### parametersRef
Defines an API object that references additional configurations required by the gateway controller. The following table describes the fields that you must include in the `parametersRef` configuration.
* Type: object
* Required: optional
| Parameter | Description | Type | Required |
| --- | --- | --- | --- |
| `group` | Specifies the Kubernetes group that the `parametersRef` is a member of. <br/>The value must always be `api-gateway.consul.hashicorp.com`.<br/>The `parametersRef.group` is always the same across all deployments of Consul API Gateway. | String | Required |
| `kind` | Specifies the type of Kubernetes object that the `parametersRef` configuration defines. <br/>The value must always be `GatewayClassConfig`. <br/> This `parametersRef.kind` is always the same across all deployments of Consul API Gateway. | String | Required |
| `name` | Specfies a name for the `GatewayClassConfig` object. | String | Required |
* Required: optional
### description
Specifies a human-readable description of the gateway class. We recommend using the description field to describe the gateway class's purpose.