Skip to content

Getting started with Gateway APIs

v1alpha1 has been deprecated

Please upgrade to v1alpha2, v1alpha1 will be removed from Gateway API in an upcoming release.

1. Install a Gateway controller OR install the Gateway API CRDs manually


2. Try out one of the available guides:

Installing a Gateway controller

There are multiple projects that support the Gateway API. By installing a Gateway controller in your Kubernetes cluster, you can try out the guides above. This will demonstrate that the desired routing configuration is actually being implemented by your Gateway resources (and the network infrastructure that your Gateway resources represent). Note that many of the Gateway controller setups will install and remove the Gateway API CRDs for you.

Installing Gateway API CRDs manually

The following command will install the Gateway API CRDs. This includes the GatewayClass, Gateway, HTTPRoute, TCPRoute, and more. Note that a running Gateway controller in your Kubernetes cluster is required to actually act on these resources. Installing the CRDs will just allow you to see and apply the resources, though they won't do anything.

kubectl kustomize "" \
| kubectl apply -f -

After you're done, you can clean up after yourself by uninstalling the Gateway API CRDs. The following command will remove all GatewayClass, Gateway, and associated resources in your cluster. If these resources are in-use or if they were installed by a Gateway controller, then do not uninstall them. This will uninstall the Gateway API CRDs for the entire cluster. Do not do this if they might be in-use by someone else as this will break anything using these resources.

kubectl kustomize "" \
| kubectl delete -f -
Back to top