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.
Create a
values.yaml
file for configuring your Consul API gateway deployment and include the following settings:values.yamlThe 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.If you are installing Consul on an OpenShift Kubernetes cluster, you must include the
global.openShift.enabled
parameter and set it totrue
:values.yamlRefer to OpenShift requirements for additional information.
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.