parametesRef set to optional
This commit is contained in:
parent
bcf58d544c
commit
53ee7f376b
|
@ -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.
|
||||
|
||||
* [`controllerName`](#controllername): string | required
|
||||
* [`parametersRef`](#parametersref): object | required
|
||||
* [`parametersRef`](#parametersref): object | optional
|
||||
* [`group`](#parametersref): string | required if `parametersRef` is set
|
||||
* [`kind`](#parametersref): string | required if `parametersRef` is set
|
||||
* [`name`](#parametersref): string | required if `parametersRef` is set
|
||||
|
@ -32,7 +32,7 @@ The following outline shows how to format the configurations in the `GatewayClas
|
|||
This topic provides details about the configuration parameters.
|
||||
|
||||
### controllerName
|
||||
Specifies the name of the controller that manages the gateways generated by this class.
|
||||
Specifies the name of the controller that manages the gateways generated by this class.
|
||||
The value must always be `hashicorp.com/consul-api-gateway-controller`.
|
||||
|
||||
* Type: string
|
||||
|
@ -47,8 +47,10 @@ 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 |
|
||||
| `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.
|
||||
Specifies a human-readable description of the gateway class. We recommend using the description field to describe the gateway class's purpose.
|
||||
|
||||
* Type: string
|
||||
* Required: optional
|
||||
|
|
Loading…
Reference in New Issue