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

Merge pull request #12423 from andrewstucki/api-gateway-ga-docs-features

Browse Source 
Add list of support K8s Gateway API Spec features
This commit is contained in:
Andrew Stucki 2022-02-23 11:46:46 -05:00 committed by GitHub
commit 3ad7e59656
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
website/content/docs/api-gateway/kubernetes-features.mdx Normal file
View File

@ -0,0 +1,19 @@
---
layout: docs
page_title: Consul API Gateway Supported Kubernetes Features
description: >-
Consul API Gateway Supported Kubernetes Features.
---
# Consul API Gateway - Kubernetes Gateway Spec Features
The Consul API Gateway currently supports a subset of the Kubernetes [v1alpha2 Gateway API Spec](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/). The table below
specifies the supported features of the spec. For a full list of features, including the list of gateway and route statuses and an explanation on how they
are used, see the [documentation in our GitHub repo](https://github.com/hashicorp/consul-api-gateway/blob/main/dev/docs/supported-features.md).
| Kubernetes Object | Features |
| ----- | ----------------------------- |
| [`GatewayClass`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.GatewayClass) | <ul><li>Parameter specification via `GatewayClassConfig` CRD</li><li>Controller matching on `"hashicorp.com/consul-api-gateway-controller"`</li></ul> |
| [`Gateway`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.Gateway) | <ul><li>Supported protocols: `HTTP`, `HTTPS`, `TCP`</li><li>Header-based hostname matching (no SNI support)</li><li>Supported filters: header addition, removal, and setting</li><li>TLS modes supported: `terminate`</li><li>Certificate types supported: `core/v1/Secret`</li><li>Extended options: TLS version and cipher constraints</li></ul> |
| [`HTTPRoute`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.HTTPRoute) | <ul><li>Weight-based load balancing</li><li>Supported rules: path, header, query, and method-based matching</li><li>Supported filters: header addition, removal, and setting</li><li>Supported backend types: <ol><li>`core/v1/Service` (must map to a registered Consul service)</li><li>`api-gateway.consul.hashicorp.com/v1alpha1/MeshService`</li></ol></li></ul> |
| [`TCPRoute`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.TCPRoute) | <ul><li>Supported backend types: <ol><li>`core/v1/Service` (must map to a registered Consul service)</li><li>`api-gateway.consul.hashicorp.com/v1alpha1/MeshService`</li></ol></li></ul> |

4
website/data/docs-nav-data.json
View File

@ -384,6 +384,10 @@
{
"title": "Technical Specifications",
"path": "api-gateway/tech-specs"
},
{
"title": "Supported Kubernetes Features",
"path": "api-gateway/kubernetes-features"
}
]
},