Install API gateway for Kubernetes

The Consul API gateway ships with Consul and is automatically installed when you install Consul on Kubernetes. Before you begin the installation process, verify that the environment you are deploying Consul and the API gateway in meets the requirements listed in the Technical Specifications. Refer to the Release Notes for any additional information about the version you are deploying.

1. The Consul Helm chart deploys the API gateway using the configuration specified in the values.yaml file. Refer to Helm Chart Configuration - connectInject.apiGateway for information about the Helm chart configuration options. Create a values.yaml file for configuring your Consul API gateway deployment and include the following settings:

   Reference configurationOpenShiftGKE Autopilot

   values.yaml

   global:
     name: consul
   connectInject:
     enabled: true
     apiGateway:
       manageExternalCRDs: true
   

   If you are installing Consul on an OpenShift Kubernetes cluster, you must include the global.openShift.enabled parameter and set it to true. Refer to OpenShift requirements for additional information.

   values.yaml

   global:
     openshift:
       enabled: true
   connectInject:
     enabled: true
     apiGateway:
       manageExternalCRDs: true
     cni:
       enabled: true
       logLevel: info
       multus: true
       cniBinDir: "/var/lib/cni/bin"
       cniNetDir: "/etc/kubernetes/cni/net.d"
   

   By default, GKE Autopilot installs Gateway API resources, so we recommend customizing the connectInject.apiGateway stanza to accommodate the pre-installed Gateway API CRDs.

   The following working example enables both Consul Service Mesh and Consul API Gateway on GKE Autopilot. Refer to connectInject.agiGateway in the Helm chart reference for additional information.

   values.yaml

   global:
     name: consul
   connectInject:
     enabled: true
     apiGateway:
       manageExternalCRDs: false
       manageNonStandardCRDs: true
     cni:
       enabled: true
       logLevel: debug
       cniBinDir: "/home/kubernetes/bin"
       cniNetDir: "/etc/cni/net.d"
   server:
     resources:
       requests:
         memory: "500Mi"
         cpu: "500m"
       limits:
         memory: "500Mi"
         cpu: "500m"
   

2. Install Consul API Gateway using the standard Consul Helm chart or Consul K8s CLI specify the custom values file. Refer to the Consul Helm chart in GitHub releases for the available versions.

   Consul K8s CLI (Mac Only)Helm

   Refer to the official Consul K8S CLI documentation to find additional settings.

   $ brew tap hashicorp/tap
   

   $ brew install hashicorp/tap/consul-k8s
   

   $ consul-k8s install -config-file=values.yaml -set global.image=hashicorp/consul:1.17.0
   

   Add the HashiCorp Helm repository.

   $ helm repo add hashicorp https://helm.releases.hashicorp.com
   

   Install Consul with API Gateway on your Kubernetes cluster by specifying the values.yaml file.

   $ helm install consul hashicorp/consul --version 1.3.0 --values values.yaml --create-namespace --namespace consul