status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

parametesRef set to optional

This commit is contained in:
Sarah Alsmiller 2022-07-29 10:12:45 -05:00
parent 4cb021aebd
commit d26be4b253
1 changed files with 5 additions and 3 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

@ -21,7 +21,7 @@ The `GatewayClass` resource is a generic Kubernetes gateway object. For configur
The following outline shows how to format the configurations in the `GatewayClass` object. Click on a property name to view details about the configuration. 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 | required * [`parametersRef`](#parametersref): object | optional
* [`group`](#parametersref): string | required if `parametersRef` is set * [`group`](#parametersref): string | required if `parametersRef` is set
* [`kind`](#parametersref): string | required if `parametersRef` is set * [`kind`](#parametersref): string | required if `parametersRef` is set
* [`name`](#parametersref): string | required if `parametersRef` is set * [`name`](#parametersref): string | required if `parametersRef` is set
@ -47,6 +47,8 @@ Defines an API object that references additional configurations required by the
| `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.