»Install Consul API Gateway

This topic describes how to install and configure Consul API Gateway.

Requirements

Ensure that the environment you are deploying Consul API Gateway in meets the requirements listed in the Technical Specifications. This includes validating that the requirements for minimum versions of software are met. Refer to the Release Notes for the version of API Gateway you are deploying.

Installation

1. Set the version of Consul API Gateway you are installing as an environment variable. The following steps use this environment variable in commands and configurations.

   $ export VERSION=0.5.1
   

   Copy

2. Issue the following command to install the CRDs:

   $ kubectl apply --kustomize="github.com/hashicorp/consul-api-gateway/config/crd?ref=v$VERSION"
   

   Copy

3. Create a values.yaml file for your Consul API Gateway deployment by copying the following content and running it in the environment where you set the VERSION environment variable. The Consul Helm chart uses this values.yaml file to deploy the API Gateway. Available versions of the Consul and Consul API Gateway Docker images can be found on DockerHub, with additional context on version compatibility published in GitHub releases. For more options to configure your Consul API Gateway deployment through the Helm chart, refer to Helm Chart Configuration - apiGateway.

   values.yaml

   Copy

     cat <<EOF > values.yaml
       global:
         name: consul
       connectInject:
         enabled: true
       apiGateway:
         enabled: true
         image: hashicorp/consul-api-gateway:$VERSION
     EOF
   

4. Install Consul API Gateway using the standard Consul Helm chart or Consul K8s CLI specify the custom values file. Available versions of the Consul Helm chart can be found in GitHub releases.

   Consul K8s CLI (Mac Only)Helm

   ~> Note: Refer to the official Consul K8S CLI documentation to find additional settings.

   $ brew tap hashicorp/tap
   

   Copy

   $ brew install hashicorp/tap/consul-k8s
   

   Copy

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

   Copy

   Add the HashiCorp Helm repository.

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

   Copy

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

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

   Copy