• HashiCorp Developer

  • HashiCorp Cloud Platform
  • Terraform
  • Packer
  • Consul
  • Vault
  • Boundary
  • Nomad
  • Waypoint
  • Vagrant
Consul
  • Install
  • Tutorials
  • Documentation
  • API
  • CLI
  • Try Cloud(opens in new tab)
  • Sign up
Consul Home

Documentation

Skip to main contentOverview
  • What is Consul?




  • HCP Consul

    • Overview
    • Installation
    • Technical Specifications
    • Upgrades

  • Resources

  • Tutorial Library
  • Certifications
  • Community Forum
    (opens in new tab)
  • Support
    (opens in new tab)
  • GitHub
    (opens in new tab)
  1. Developer
  2. Consul
  3. Documentation
  4. Consul API Gateway
  5. Technical Specifications
  • Consul
  • v1.13.x
  • v1.12.x
  • v1.11.x
  • v1.10.x
  • v1.9.x
  • v1.8.x

ยปConsul API Gateway Technical Specifications

This topic describes the technical specifications associated with using Consul API Gateway.

Requirements

Verify that your environment meets the following requirements prior to using Consul API Gateway.

Datacenter Requirements

Your datacenter must meet the following requirements prior to configuring the Consul API Gateway:

  • Kubernetes 1.21+
  • kubectl 1.21+
  • Consul 1.11.2+
  • HashiCorp Consul Helm chart 0.47.1+
  • Consul Service Mesh must be deployed on the Kubernetes cluster that API Gateway is deployed on.
  • Envoy: Envoy proxy support is determined by the Consul version deployed. Refer to Envoy Integration for details.

TCP Port Requirements

The following table describes the TCP port requirements for each component of the API Gateway.

PortDescriptionComponent
9090Secret discovery service (SDS)Gateway controller pod
Gateway instance pod
20000Kubernetes readiness probeGateway instance pod
ConfigurablePort for scraping Prometheus metrics. Disabled by default.Gateway controller pod

Consul Server Deployments

  • Consul Editions supported: OSS and Enterprise
  • Supported Consul Server deployment types:
    • Self-Managed
    • HCP Consul

Limited Support of some Consul Features

The following table lists API Gateway limitations related to specific Consul features

Consul FeatureLimitation
Admin partitionsYou can deploy Consul API Gateway into the default admin partition only. You can route to services in other default admin partitions through peered connections. Refer to Route Traffic to Peered Services for additional information.
Routing between datacentersIf you are connecting multiple Consul datacenters to create a federated network, you can route to services in other datacenters through peered connections. Refer to Route Traffic to Peered Services for additional information.

Deployment Environments

Consul API Gateway can be deployed in the following Kubernetes-based environments:

  • Generic Kubernetes
  • AWS Elastic Kubernetes Service (EKS)
  • Google Kubernetes Engine (GKE)
  • Azure Kubernetes Service (AKS)

Kubernetes Gateway API Specification - Supported Versions

See the Release Notes for the version of Consul API Gateway being used.

Resource Allocations

The following resources are allocated for each component of the API Gateway.

Gateway Controller Pod

  • CPU: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration.
  • Memory: None. Either the the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration.

Gateway Instance Pod

  • CPU: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration.
  • Memory: None. Either the namespace or cluster default is allocated, depending on the Kubernetes cluster configuration.
Edit this page on GitHub

On this page

  1. Consul API Gateway Technical Specifications
  2. Requirements
  3. Consul Server Deployments
  4. Deployment Environments
  5. Kubernetes Gateway API Specification - Supported Versions
  6. Resource Allocations
Give Feedback(opens in new tab)
  • Certifications
  • System Status
  • Terms of Use
  • Security
  • Privacy
  • Trademark Policy
  • Trade Controls
  • Give Feedback(opens in new tab)