mirror of https://github.com/status-im/consul.git
seperate technical specs back out
This commit is contained in:
parent
b8718a9fad
commit
a1a5148a30
|
@ -11,64 +11,7 @@ This topic describes how to use the Consul API Gateway add-on module. It include
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
Verify that your environment meets the following requirements prior to using Consul API Gateway.
|
Ensure that the environment you are deploying Consul API Gateway in meets the requirements listed in the [Technical Specifications][tech-specs]. This includes validating that the requirements for minimum versions of software are met. See the [Release Notes][rel-notes] for the version of API Gateway you are deploying.
|
||||||
|
|
||||||
### Datacenter Requirements
|
|
||||||
|
|
||||||
Your datacenter must meet the following requirements prior to configuring the Consul API Gateway:
|
|
||||||
|
|
||||||
- Kubernetes 1.21+
|
|
||||||
- Kubernetes 1.24 is not supported at this time.
|
|
||||||
- `kubectl` 1.21+
|
|
||||||
- Consul 1.11.2+
|
|
||||||
- HashiCorp Consul Helm chart 0.45.0+
|
|
||||||
- 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](/docs/connect/proxies/envoy) for details.
|
|
||||||
|
|
||||||
### TCP Port Requirements
|
|
||||||
|
|
||||||
The following table describes the TCP port requirements for each component of the API Gateway.
|
|
||||||
|
|
||||||
| Port | Description | Component |
|
|
||||||
| ---- | ----------- | --------- |
|
|
||||||
| 9090 | Secret discovery service (SDS) | Gateway controller pod <br/> Gateway instance pod |
|
|
||||||
| 20000 | Kubernetes readiness probe | Gateway instance pod |
|
|
||||||
| Configurable | Port 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
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,70 @@
|
||||||
|
---
|
||||||
|
layout: docs
|
||||||
|
page_title: Consul API Gateway Technical Specifications
|
||||||
|
description: >-
|
||||||
|
This topic describes technical specifications for 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+
|
||||||
|
- Kubernetes 1.24 is not supported at this time.
|
||||||
|
- `kubectl` 1.21+
|
||||||
|
- Consul 1.11.2+
|
||||||
|
- HashiCorp Consul Helm chart 0.45.0+
|
||||||
|
- 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](/docs/connect/proxies/envoy) for details.
|
||||||
|
|
||||||
|
### TCP Port Requirements
|
||||||
|
|
||||||
|
The following table describes the TCP port requirements for each component of the API Gateway.
|
||||||
|
|
||||||
|
| Port | Description | Component |
|
||||||
|
| ---- | ----------- | --------- |
|
||||||
|
| 9090 | Secret discovery service (SDS) | Gateway controller pod <br/> Gateway instance pod |
|
||||||
|
| 20000 | Kubernetes readiness probe | Gateway instance pod |
|
||||||
|
| Configurable | Port 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
|
||||||
|
|
||||||
|
## 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.
|
|
@ -402,6 +402,10 @@
|
||||||
"title": "Installation",
|
"title": "Installation",
|
||||||
"path": "api-gateway/install"
|
"path": "api-gateway/install"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"title": "Technical Specifications",
|
||||||
|
"path": "api-gateway/tech-specs"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"title": "Upgrades",
|
"title": "Upgrades",
|
||||||
"path": "api-gateway/upgrades"
|
"path": "api-gateway/upgrades"
|
||||||
|
|
Loading…
Reference in New Issue