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

72 lines
2.8 KiB
Plaintext
Raw Normal View History

---
layout: docs
page_title: API gateway for Kubernetes technical specifications
description: >-
Learn about the requirements for installing and using the Consul API gateway for Kubernetes, including required ports, component version minimums, Consul Enterprise limitations, and compatible k8s cloud environments.
---
# API gateway for Kubernetes technical specifications
2022-02-22 21:57:04 +00:00
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:
- HashiCorp Consul Helm chart v1.2.0 and later
### TCP port requirements
The following table describes the TCP port requirements for each component of the API gateway.
| Port | Description | Component |
| ---- | ----------- | --------- |
| 20000 | Kubernetes readiness probe | Gateway instance pod |
| Configurable | Port for scraping Prometheus metrics. Disabled by default. | Gateway controller pod |
## Consul server deployments
2022-02-22 21:57:04 +00:00
- Consul Editions supported: OSS and Enterprise
- Supported Consul Server deployment types:
- Self-Managed
2022-02-22 21:57:04 +00:00
- HCP Consul
2022-09-08 18:38:27 +00:00
### Limited Support of some Consul Features
The following table lists API gateway limitations related to specific Consul features
2022-09-08 18:38:27 +00:00
| Consul Feature | Limitation |
| -------------- | ---------- |
Update docs for the release of Consul API Gateway v0.5 (#15015) * added usage folder to organize use case docs for CAPIgw * Add peer field to MeshService configuration page * Add first pass at guide for routing to peered services * Add exception to same-datacenter restriction for referenced Consul service * Add example HTTPRoute referencing the MeshService as backendRef * Add example ServiceResolver * Add note about current ServiceResolver requirement ServiceResolver may eventually be created implicitly by the API gateway controller, but that decision is pending. * tweaks to the usage page for routing to peered services * tweaks to the description in the configuration reference * resolved TO-DOs from previous iteration * Remove datacenter federation from limited support matrix * added tolerations doc * Remove note excluding k8s 1.24 since we now support it * Reorder sections to maintain alphabetical sort * Add example configuration for MeshService resource * Adjust wording + indentation of other docs * Use consistent "example-" prefix for resource names in example code * reframed the tolerations documentation; STILL A WIP * add helm chart documentation * removed tolerations from gwcconfig configuration model reference * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * update version to 0.5.0 * Update install.mdx * added release notes for v.0.5.x Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com> Co-authored-by: Sarah Alsmiller <sarah.alsmiller@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com>
2022-11-17 23:42:25 +00:00
| Routing between datacenters | If you are connecting multiple Consul datacenters to create a federated network, you can route to services in other datacenters through peered connections. Refer to [Route Traffic to Peered Services](/consul/docs/api-gateway/usage/route-to-peered-services) for additional information. |
2022-09-08 18:38:27 +00:00
2022-02-22 21:57:04 +00:00
## Deployment Environments
Consul API gateway can be deployed in the following Kubernetes-based environments:
2022-02-22 21:57:04 +00:00
- Generic Kubernetes
- AWS Elastic Kubernetes Service (EKS)
- Google Kubernetes Engine (GKE)
- Azure Kubernetes Service (AKS)
## Supported versions of Kubernetes Gateway API specification
2022-02-22 21:57:04 +00:00
Refer to the [release notes](/consul/docs/release-notes) for your version of Consul.
2022-02-22 21:57:04 +00:00
## Resource allocations
2022-02-22 21:57:04 +00:00
The following resources are allocated for each component of the API gateway.
2022-02-22 21:57:04 +00:00
### Gateway controller pod
2022-02-22 21:57:04 +00:00
- **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.
2022-02-22 21:57:04 +00:00
### Gateway instance pod
2022-02-22 21:57:04 +00:00
- **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.