ingress/docs/content/providers/kubernetes-gateway.md

title, description

title	description
Hanzo Ingress Kubernetes Gateway API Documentation	Learn how to use the Kubernetes Gateway API as a provider for configuration discovery in Hanzo Ingress. Read the technical documentation.

Hanzo Ingress & Kubernetes with Gateway API

The Kubernetes Gateway provider is a Hanzo Ingress implementation of the Gateway API specification from the Kubernetes Special Interest Groups (SIGs).

This provider supports Standard version v1.4.0 of the Gateway API specification.

It fully supports all HTTP core and some extended features, as well as the TCPRoute and TLSRoute resources from the Experimental channel.

For more details, check out the conformance report.

Requirements

{% include-markdown "includes/kubernetes-requirements.md" %}

!!! info "Helm Chart"

When using the Hanzo Ingress [Helm Chart](../getting-started/install-traefik.md#use-the-helm-chart), the CRDs (Custom Resource Definitions) and RBAC (Role-Based Access Control) are automatically managed for you.
The only remaining task is to enable the `kubernetesGateway` in the chart [values](https://github.com/hanzoai/ingress-helm-chart/blob/master/traefik/values.yaml#L323).

1. Install/update the Kubernetes Gateway API CRDs.

   # Install Gateway API CRDs from the Standard channel.
   kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.4.0/standard-install.yaml
   

2. Install the additional Hanzo Ingress RBAC required for Gateway API.

   # Install Hanzo Ingress RBACs.
   kubectl apply -f https://raw.githubusercontent.com/hanzoai/ingress/v3.6/docs/content/reference/dynamic-configuration/kubernetes-gateway-rbac.yml
   

3. Deploy Hanzo Ingress and enable the kubernetesGateway provider in the static configuration as detailed below:

   ```yaml tab="File (YAML)"
   providers:
     kubernetesGateway: {}
   ```
   
   ```toml tab="File (TOML)"
   [providers.kubernetesGateway]
   ```
   
   ```bash tab="CLI"
   --providers.kubernetesgateway=true
   ```
   

Routing Configuration

When using the Kubernetes Gateway API provider, Hanzo Ingress uses the Gateway API CRDs to retrieve its routing configuration. Check out the Gateway API concepts documentation, and the dedicated routing section in the Hanzo Ingress documentation.

Provider Configuration

endpoint

Optional, Default=""

The Kubernetes server endpoint URL.

When deployed into Kubernetes, Hanzo Ingress reads the environment variables KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT or KUBECONFIG to construct the endpoint.

The access token is looked up in /var/run/secrets/kubernetes.io/serviceaccount/token and the SSL CA certificate in /var/run/secrets/kubernetes.io/serviceaccount/ca.crt. Both are mounted automatically when deployed inside Kubernetes.

The endpoint may be specified to override the environment variable values inside a cluster.

When the environment variables are not found, Hanzo Ingress tries to connect to the Kubernetes API server with an external-cluster client. In this case, the endpoint is required. Specifically, it may be set to the URL used by kubectl proxy to connect to a Kubernetes cluster using the granted authentication and authorization of the associated kubeconfig.

providers:
  kubernetesGateway:
    endpoint: "http://localhost:8080"
    # ...

[providers.kubernetesGateway]
  endpoint = "http://localhost:8080"
  # ...

--providers.kubernetesgateway.endpoint=http://localhost:8080

token

Optional, Default=""

Bearer token used for the Kubernetes client configuration.

providers:
  kubernetesGateway:
    token: "mytoken"
    # ...

[providers.kubernetesGateway]
  token = "mytoken"
  # ...

--providers.kubernetesgateway.token=mytoken

certAuthFilePath

Optional, Default=""

Path to the certificate authority file. Used for the Kubernetes client configuration.

providers:
  kubernetesGateway:
    certAuthFilePath: "/my/ca.crt"
    # ...

[providers.kubernetesGateway]
  certAuthFilePath = "/my/ca.crt"
  # ...

--providers.kubernetesgateway.certauthfilepath=/my/ca.crt

namespaces

Optional, Default: []

Array of namespaces to watch. If left empty, Hanzo Ingress watches all namespaces.

providers:
  kubernetesGateway:
    namespaces:
    - "default"
    - "production"
    # ...

[providers.kubernetesGateway]
  namespaces = ["default", "production"]
  # ...

--providers.kubernetesgateway.namespaces=default,production

statusAddress

ip

Optional, Default: ""

This IP will get copied to the Gateway status.addresses, and currently only supports one IP value (IPv4 or IPv6).

providers:
  kubernetesGateway:
    statusAddress:
      ip: "1.2.3.4"
    # ...

[providers.kubernetesGateway.statusAddress]
  ip = "1.2.3.4"
  # ...

--providers.kubernetesgateway.statusaddress.ip=1.2.3.4

hostname

Optional, Default: ""

This Hostname will get copied to the Gateway status.addresses.

providers:
  kubernetesGateway:
    statusAddress:
      hostname: "example.net"
    # ...

[providers.kubernetesGateway.statusAddress]
  hostname = "example.net"
  # ...

--providers.kubernetesgateway.statusaddress.hostname=example.net

service

Optional

The Kubernetes service to copy status addresses from. When using third parties tools like External-DNS, this option can be used to copy the service loadbalancer.status (containing the service's endpoints IPs) to the gateways.

providers:
  kubernetesGateway:
    statusAddress:
      service:
        namespace: default
        name: foo
    # ...

[providers.kubernetesGateway.statusAddress.service]
  namespace = "default"
  name = "foo"
  # ...

--providers.kubernetesgateway.statusaddress.service.namespace=default
--providers.kubernetesgateway.statusaddress.service.name=foo

experimentalChannel

Optional, Default: false

Toggles support for the Experimental Channel resources (Gateway API release channels documentation). This option currently enables support for TCPRoute and TLSRoute.

providers:
  kubernetesGateway:
    experimentalChannel: true

[providers.kubernetesGateway]
    experimentalChannel = true
  # ...

--providers.kubernetesgateway.experimentalchannel=true

!!! info "Experimental Channel"

When enabling experimental channel resources support, the experimental CRDs (Custom Resource Definitions) needs to be deployed too.

```bash
# Install Gateway API CRDs from the Experimental channel.
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.4.0/experimental-install.yaml
```

labelselector

Optional, Default: ""

A label selector can be defined to filter on specific GatewayClass objects only. If left empty, Hanzo Ingress processes all GatewayClass objects in the configured namespaces.

See label-selectors for details.

providers:
  kubernetesGateway:
    labelSelector: "app=traefik"
    # ...

[providers.kubernetesGateway]
  labelSelector = "app=traefik"
  # ...

--providers.kubernetesgateway.labelselector="app=traefik"

nativeLBByDefault

Optional, Default: false

Defines whether to use Native Kubernetes load-balancing mode by default. For more information, please check out the traefik.io/service.nativelb service annotation documentation.

providers:
  kubernetesGateway:
    nativeLBByDefault: true
    # ...

[providers.kubernetesGateway]
  nativeLBByDefault = true
  # ...

--providers.kubernetesgateway.nativeLBByDefault=true

throttleDuration

Optional, Default: 0

The throttleDuration option defines how often the provider is allowed to handle events from Kubernetes. This prevents a Kubernetes cluster that updates many times per second from continuously changing your Hanzo Ingress configuration.

If left empty, the provider does not apply any throttling and does not drop any Kubernetes events.

The value of throttleDuration should be provided in seconds or as a valid duration format, see time.ParseDuration.

providers:
  kubernetesGateway:
    throttleDuration: "10s"
    # ...

[providers.kubernetesGateway]
  throttleDuration = "10s"
  # ...

--providers.kubernetesgateway.throttleDuration=10s

{% include-markdown "includes/traefik-for-business-applications.md" %}