Get started

Get started with kgateway

Get started with kgateway, a cloud-native Layer 7 proxy that is based on the Envoy and Kubernetes Gateway API projects.

Before you begin

These quick start steps assume that you have kubectl and helm installed. For full installation instructions, see Install kgateway.

Install kgateway

  1. Use a Kubernetes cluster. For quick testing, you can use Kind.

    kind create cluster
  1. Deploy the Kubernetes Gateway API CRDs.

    kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.2.1/standard-install.yaml
  2. Deploy the kgateway CRDs by using Helm. The following command uses the latest stable release, v2.0.0. For active development, update the version to v2.1.0-main.

    helm upgrade -i --create-namespace --namespace kgateway-system --version v2.0.0 kgateway-crds oci://cr.kgateway.dev/kgateway-dev/charts/kgateway-crds
  3. Install kgateway by using Helm. The following command uses the latest stable release, v2.0.0. For active development, update the version to v2.1.0-main.

    helm upgrade -i --namespace kgateway-system --version v2.0.0 kgateway oci://cr.kgateway.dev/kgateway-dev/charts/kgateway
  4. Make sure that kgateway is running.

    kubectl get pods -n kgateway-system

    Example output:

    NAME                        READY   STATUS    RESTARTS   AGE
    kgateway-5495d98459-46dpk   1/1     Running   0          19s
    

Good job! You now have the kgateway control plane running in your cluster.

Next steps

Ready to try out more features? Check out the following guides:

No longer need kgateway? Uninstall with the following command:

helm uninstall kgateway -n kgateway-system