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

added required and type to parametersRef

Browse Source
This commit is contained in:
Sarah Alsmiller 2022-08-02 13:38:31 -05:00
parent 34b19663bf
commit 686b573f1a
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 ### 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. 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 | | 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 | | `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 | | `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 | | `name` | Specfies a name for the `GatewayClassConfig` object. | String | Required |
* Required: optional
### description ### description
Specifies a human-readable description of the gateway class. We recommend using the description field to describe the gateway class's purpose. Specifies a human-readable description of the gateway class. We recommend using the description field to describe the gateway class's purpose.