luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity
open-consul/website/content/docs/api-gateway/configuration/gatewayclass.mdx

37 lines
1.4 KiB
Plaintext
Raw Normal View History

restructure documentation
2022-07-05 22:53:56 +00:00
---
layout: docs
page_title: Consul API Gateway GatewayClass
description: >-
fix render issue
2022-07-06 16:59:40 +00:00
Consul API Gateway GatewayClass
restructure documentation
2022-07-05 22:53:56 +00:00
---
# GatewayClass
The `GatewayClass` resource is used as a template for creating `Gateway` resources.
The specification includes the name of the controller (`controllerName`) and an API object containing controller-specific configuration resources within the cluster (`parametersRef`).
The value of the `controllerName` field must be set to `hashicorp.com/consul-api-gateway-controller`.
When gateways are created from a `GatewayClass`, they use the parameters specified in the `GatewayClass` at the time of instantiation.
Add the `kind: GatewayClass` option to the the gateway values file to declare a gateway class.
The following example creates a gateway class called `test-gateway-class`:
<CodeBlockConfig filename="gateway.yaml">
```yaml
apiVersion: gateway.networking.k8s.io/v1alpha2
kind: GatewayClass
metadata:
Update website/content/docs/api-gateway/configuration/gatewayclass.mdx Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
2022-07-13 21:01:45 +00:00
name: test-gateway-class
restructure documentation
2022-07-05 22:53:56 +00:00
spec:
Update website/content/docs/api-gateway/configuration/gatewayclass.mdx Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
2022-07-13 21:01:45 +00:00
controllerName: 'hashicorp.com/consul-api-gateway-controller'
parametersRef:
group: api-gateway.consul.hashicorp.com
kind: GatewayClassConfig
name: test-gateway-class-config
fix formating issue
2022-07-14 16:31:18 +00:00
```
restructure documentation
2022-07-05 22:53:56 +00:00
</CodeBlockConfig>
Refer to the [Kubernetes Gateway API documentation](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.GatewayClass) for details about configuring gateway classes.