2022-02-16 19:54:43 +00:00
|
|
|
---
|
|
|
|
|
layout: docs
|
|
|
|
|
page_title: Consul API Gateway Technical Specifications
|
|
|
|
|
description: >-
|
|
|
|
|
This topic describes technical specifications for Consul API Gateway.
|
|
|
|
|
---
|
|
|
|
|
|
2022-02-22 21:57:04 +00:00
|
|
|
# Technical Specifications
|
|
|
|
|
|
|
|
|
|
## Required Software and Supported Versions
|
|
|
|
|
|
2022-02-22 22:43:46 +00:00
|
|
|
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.41.0+
|
|
|
|
|
|
2022-02-22 21:57:04 +00:00
|
|
|
## Consul Server Deployments
|
|
|
|
|
|
|
|
|
|
- Consul Editions supported: OSS and Enterprise
|
|
|
|
|
- Supported Consul Server deployment types:
|
2022-02-22 22:43:46 +00:00
|
|
|
- Self-Managed
|
2022-02-22 21:57:04 +00:00
|
|
|
- HCP Consul
|
|
|
|
|
|
|
|
|
|
## 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 version of the Gateway API spec: v1alpha2
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Resource Allocations
|
|
|
|
|
|
2022-02-22 22:27:28 +00:00
|
|
|
The tables below list the resource allocations for each component of the API Gateway.
|
|
|
|
|
|
2022-02-22 21:57:04 +00:00
|
|
|
### Gateway Controller Pod
|
|
|
|
|
|
|
|
|
|
| Resource | Allocation |
|
|
|
|
|
| -------- | -------------------------------------------------------------------------------------------------------- |
|
|
|
|
|
| CPU | None specified. Will use namespace or cluster default depending on the Kubernetes cluster configuration. |
|
|
|
|
|
| Memory | None specified. Will use namespace or cluster default depending on the Kubernetes cluster configuration. |
|
|
|
|
|
|
|
|
|
|
### Gateway Instance Pod
|
|
|
|
|
|
|
|
|
|
| Resource | Allocation |
|
|
|
|
|
| -------- | -------------------------------------------------------------------------------------------------------- |
|
|
|
|
|
| CPU | None specified. Will use namespace or cluster default depending on the Kubernetes cluster configuration. |
|
|
|
|
|
| Memory | None specified. Will use namespace or cluster default depending on the Kubernetes cluster configuration. |
|
|
|
|
|
|
|
|
|
|
## TCP Ports Required
|
|
|
|
|
|
2022-02-22 22:27:28 +00:00
|
|
|
The tables below list the TCP ports that are used by each component of the API Gateway.
|
2022-02-22 21:57:04 +00:00
|
|
|
|
|
|
|
|
### Gateway Controller Pod
|
|
|
|
|
|
|
|
|
|
| Port | Used For |
|
|
|
|
|
| ---- | ------------------------------------------------------------------ |
|
|
|
|
|
| 9090 | Secret Discovery Service (SDS) |
|
|
|
|
|
| Configurable | Port for scraping Prometheus metrics. Disabled by default. |
|
|
|
|
|
|
|
|
|
|
### Gateway Instance Pod
|
|
|
|
|
|
|
|
|
|
| Port | Used For |
|
|
|
|
|
| ----- | ----------------------------- |
|
|
|
|
|
| 9090 | Secret Discovery Service (SDS) |
|
|
|
|
|
| 20000 | Kubernetes readiness probe |
|
