2022-02-16 11:54:43 -08:00
---
layout: docs
2023-06-12 13:41:16 -07:00
page_title: API gateway for Kubernetes technical specifications
2022-02-16 11:54:43 -08:00
description: >-
2023-06-12 13:41:16 -07:00
Learn about the requirements for installing and using the Consul API gateway for Kubernetes, including required ports, component version minimums, Consul Enterprise limitations, and compatible k8s cloud environments.
2022-02-16 11:54:43 -08:00
---
2023-06-12 13:41:16 -07:00
# API gateway for Kubernetes technical specifications
2022-02-22 16:57:04 -05:00
2023-06-12 13:41:16 -07:00
This topic describes the technical specifications associated with using Consul API gateway.
2022-02-22 16:44:30 -08:00
## Requirements
2023-06-12 13:41:16 -07:00
Verify that your environment meets the following requirements prior to using Consul API gateway.
2022-02-22 16:44:30 -08:00
2023-06-12 13:41:16 -07:00
### Datacenter requirements
2022-02-22 16:57:04 -05:00
2023-06-12 13:41:16 -07:00
Your datacenter must meet the following requirements prior to configuring the Consul API gateway:
2022-02-22 17:43:46 -05:00
2023-06-12 13:41:16 -07:00
- HashiCorp Consul Helm chart v1.2.0 and later
2022-02-22 17:43:46 -05:00
2023-06-12 13:41:16 -07:00
### TCP port requirements
2022-02-22 16:44:30 -08:00
2023-06-12 13:41:16 -07:00
The following table describes the TCP port requirements for each component of the API gateway.
2022-02-22 16:44:30 -08:00
| Port | Description | Component |
2022-04-25 20:59:18 -07:00
| ---- | ----------- | --------- |
2022-02-22 16:44:30 -08:00
| 20000 | Kubernetes readiness probe | Gateway instance pod |
| Configurable | Port for scraping Prometheus metrics. Disabled by default. | Gateway controller pod |
2023-06-12 13:41:16 -07:00
## Consul server deployments
2022-02-22 16:57:04 -05:00
- Consul Editions supported: OSS and Enterprise
- Supported Consul Server deployment types:
2022-02-22 17:43:46 -05:00
- Self-Managed
2022-02-22 16:57:04 -05:00
- HCP Consul
2022-09-08 11:38:27 -07:00
### Limited Support of some Consul Features
2023-06-12 13:41:16 -07:00
The following table lists API gateway limitations related to specific Consul features
2022-09-08 11:38:27 -07:00
| Consul Feature | Limitation |
| -------------- | ---------- |
2022-11-17 15:42:25 -08:00
| Routing between datacenters | If 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](/consul/docs/api-gateway/usage/route-to-peered-services) for additional information. |
2022-09-08 11:38:27 -07:00
2022-02-22 16:57:04 -05:00
## Deployment Environments
2023-06-12 13:41:16 -07:00
Consul API gateway can be deployed in the following Kubernetes-based environments:
2022-02-22 16:57:04 -05:00
- Generic Kubernetes
- AWS Elastic Kubernetes Service (EKS)
- Google Kubernetes Engine (GKE)
- Azure Kubernetes Service (AKS)
2023-06-12 13:41:16 -07:00
## Supported versions of Kubernetes Gateway API specification
2022-02-22 16:57:04 -05:00
2023-06-12 13:41:16 -07:00
Refer to the [release notes](/consul/docs/release-notes) for your version of Consul.
2022-02-22 16:57:04 -05:00
2023-06-12 13:41:16 -07:00
## Resource allocations
2022-02-22 16:57:04 -05:00
2023-06-12 13:41:16 -07:00
The following resources are allocated for each component of the API gateway.
2022-02-22 16:57:04 -05:00
2023-06-12 13:41:16 -07:00
### Gateway controller pod
2022-02-22 16:57:04 -05:00
2022-04-25 20:59:18 -07:00
- **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.
2022-02-22 16:57:04 -05:00
2023-06-12 13:41:16 -07:00
### Gateway instance pod
2022-02-22 16:57:04 -05:00
2022-04-25 20:59:18 -07:00
- **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.