status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-01-23 12:11:05 +00:00
Code Issues Projects Releases Wiki Activity

Add technical specifications

Browse Source
This commit is contained in:
Nathan Coleman 2022-02-22 16:57:04 -05:00
parent 5c7b3e3b8c
commit c5342cfe5f
1 changed files with 58 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
website/content/docs/api-gateway/api-gateway-tech-specs.mdx
View File

@ -5,4 +5,61 @@ description: >-
This topic describes technical specifications for Consul API Gateway. This topic describes technical specifications for Consul API Gateway.
--- ---
# Technical Specifications # Technical Specifications
## Required Software and Supported Versions
## Consul Server Deployments
- Consul Editions supported: OSS and Enterprise
- Supported Consul Server deployment types:
- Self Managed
- 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
### 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
The tables below lists the TCP ports that are used by each component of the API Gateway.
### 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 |