consul/website/content/docs/api-gateway/tech-specs.mdx

69 lines
2.3 KiB
Plaintext
Raw Normal View History

---
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
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
2022-02-22 21:57:04 +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+
website(consul-api-gateway): add ReferencePolicy to overview docs (#12861) * website(consul-api-gateway): add ReferencePolicy to overview docs * website(consul-api-gateway): bump required Consul Helm chart version For allowing Consul API Gateway controller to read ReferencePolicy resources and UX improvement re-using connectInject.consulNamespaces config for Consul API Gateway config. * added referencepolicy documentation to route section * Update website/content/docs/api-gateway/consul-api-gateway-install.mdx Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com> * Update website/content/docs/api-gateway/consul-api-gateway-install.mdx Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com> * Update website/content/docs/api-gateway/consul-api-gateway-install.mdx Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com> * Update website/content/docs/api-gateway/consul-api-gateway-install.mdx Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com> * Update website/content/docs/api-gateway/consul-api-gateway-install.mdx Co-authored-by: Mike Morris <mikemorris@users.noreply.github.com> * Update consul-api-gateway-install.mdx * Update consul-api-gateway-install.mdx * Update website/content/docs/api-gateway/consul-api-gateway-install.mdx Co-authored-by: Nathan Coleman <nathandanielcoleman@gmail.com> * Update website/content/docs/api-gateway/consul-api-gateway-install.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/api-gateway/consul-api-gateway-install.mdx * Update website/content/docs/api-gateway/consul-api-gateway-install.mdx * Update website/content/docs/api-gateway/index.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/api-gateway/index.mdx * Update website/content/docs/api-gateway/index.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Sarah Alsmiller <sarah.alsmiller@hashicorp.com> Co-authored-by: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com> Co-authored-by: Nathan Coleman <nathandanielcoleman@gmail.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
2022-04-27 18:25:42 +00:00
- HashiCorp Consul Helm chart 0.43.0+
- Consul Service Mesh must be deployed on the Kubernetes cluster that API Gateway is deployed on.
### 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 |
2022-02-22 21:57:04 +00:00
## Consul Server Deployments
- Consul Editions supported: OSS and Enterprise
- Supported Consul Server deployment types:
- 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 Versions
2022-02-22 21:57:04 +00:00
See the Release Notes for the version of Consul API Gateway being used.
2022-02-22 21:57:04 +00:00
## Resource Allocations
The following resources are allocated for each component of the API Gateway.
2022-02-22 21:57:04 +00:00
### 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.
2022-02-22 21:57:04 +00:00
### 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.