GatewayClass Resource Configuration

This topic provides describes how to configure the GatewayClass resource, a generic Kubernetes gateway object used as a template for creating Gateway resources.

Introduction

The GatewayClass 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.

The GatewayClass resource is a generic Kubernetes gateway object. For configuration specific to Consul API Gateway, see GatewayClassConfig.

Configuration model

The following outline shows how to format the configurations in the GatewayClass object. Click on a property name to view details about the configuration.

Specification

This topic provides details about the configuration parameters.

controllerName

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
  • Required: required

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
ParameterDescriptionTypeRequired
groupSpecifies the Kubernetes group that the parametersRef is a member of.
The value must always be api-gateway.consul.hashicorp.com.
The parametersRef.group is always the same across all deployments of Consul API Gateway.
StringRequired
kindSpecifies the type of Kubernetes object that the parametersRef configuration defines.
The value must always be GatewayClassConfig.
This parametersRef.kind is always the same across all deployments of Consul API Gateway.
StringRequired
nameSpecifies a name for the GatewayClassConfig object.StringRequired

description

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

Example Configuration

The following example creates a gateway class called example-gateway-class:

GatewayClass - 图1

gateway.yaml

  1. apiVersion: gateway.networking.k8s.io/v1alpha2
  2. kind: GatewayClass
  3. metadata:
  4. name: example-gateway-class
  5. spec:
  6. controllerName: 'hashicorp.com/consul-api-gateway-controller'
  7. parametersRef:
  8. group: api-gateway.consul.hashicorp.com
  9. kind: GatewayClassConfig
  10. name: example-gateway-class-config
  11. description: The gateway class is for creating test gateways class configurations

Refer to the Kubernetes Gateway API documentation for details about configuring gateway classes.