From c5342cfe5ff2e16be9468a193349cf9a9421730a Mon Sep 17 00:00:00 2001 From: Nathan Coleman Date: Tue, 22 Feb 2022 16:57:04 -0500 Subject: [PATCH] Add technical specifications --- .../api-gateway/api-gateway-tech-specs.mdx | 59 ++++++++++++++++++- 1 file changed, 58 insertions(+), 1 deletion(-) diff --git a/website/content/docs/api-gateway/api-gateway-tech-specs.mdx b/website/content/docs/api-gateway/api-gateway-tech-specs.mdx index a57e5cfb43..c63abd3eed 100644 --- a/website/content/docs/api-gateway/api-gateway-tech-specs.mdx +++ b/website/content/docs/api-gateway/api-gateway-tech-specs.mdx @@ -5,4 +5,61 @@ description: >- This topic describes technical specifications for Consul API Gateway. --- -# Technical Specifications \ No newline at end of file +# 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 |