The Consul API Gateway is a dedicated ingress solution for intelligently routing traffic to applications running on a Consul Service Mesh. Currently it only runs on Kubernetes and is implemented as a Kubernetes Gateway Controller but, in future releases, it will work across multiple scheduler and runtime ecosystems.
The Consul API Gateway must be installed on a Kubernetes cluster with the Consul K8s service mesh deployed on it. The installed version of Consul must be
v1.11-beta2 or greater.
The Consul Helm chart must be used, with specific settings, to install Consul on the Kubernetes cluster. This can be done with the following commands:
helm repo add hashicorp https://helm.releases.hashicorp.com cat <<EOF | helm install consul hashicorp/consul --version 0.36.0 -f - global: name: consul image: "hashicorp/consul:1.11.0-beta2" tls: enabled: true connectInject: enabled: true controller: enabled: true EOF
Install the Tech Preview
To install the Consul API Gateway controller and a base Kubernetes
GatewayClass that leverages the API Gateway, run the following commands:
kubectl apply -k "github.com/hashicorp/consul-api-gateway/config/crd?ref=v0.1.0-techpreview" kubectl apply -k "github.com/hashicorp/consul-api-gateway/config?ref=v0.1.0-techpreview"
You should now be able to deploy a Gateway by referencing the gateway class
default-consul-gateway-class in a Kubernetes
Configuring and Deploying API Gateways
Consul API Gateways are configured and deployed via the Kubernetes Gateway API standard. The Kubernetes Gateway API webite explains the design of the standard, examples of how to use it and the complete specification of the API.
The Consul API Gateway Tech Preview supports current version (
v1alpha2) of the Gateway API.
Supported Features: Please see Supported Features for a list of K8s Gateway API features supported by the current release of Consul API Gateway.
Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance.