You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api-types/service-export.md
+46Lines changed: 46 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,10 @@ for example, using target groups in the VPC Lattice setup outside Kubernetes.
12
12
Note that ServiceExport is not the implementation of Kubernetes [Multicluster Service APIs](https://multicluster.sigs.k8s.io/concepts/multicluster-services-api/);
13
13
instead AWS Gateway API Controller uses its own version of the resource for the purpose of Gateway API integration.
14
14
15
+
### TargetGroupPolicy Integration
16
+
17
+
ServiceExport resources can be targeted by [`TargetGroupPolicy`](target-group-policy.md) to configure protocol, protocol version, and health check settings. When a TargetGroupPolicy is applied to a ServiceExport, the configuration is automatically propagated to all target groups across all clusters that participate in the multi-cluster service mesh, ensuring consistent behavior regardless of which cluster contains the route resource.
18
+
15
19
### Annotations (Legacy Method)
16
20
17
21
*`application-networking.k8s.aws/port`
@@ -69,3 +73,45 @@ spec:
69
73
This configuration will:
70
74
1. Export port 80 to be used with HTTP routes
71
75
2. Export port 8081 to be used with gRPC routes
76
+
77
+
### ServiceExport with TargetGroupPolicy
78
+
79
+
The following example shows how to combine ServiceExport with TargetGroupPolicy for consistent multi-cluster health check configuration:
This configuration ensures that all target groups created for the `inventory-service` across all clusters will use the same health check configuration, providing consistent health monitoring in multi-cluster deployments.
Copy file name to clipboardExpand all lines: docs/api-types/target-group-policy.md
+44-2Lines changed: 44 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,10 @@ When attaching a policy to a resource, the following restrictions apply:
12
12
- A policy can be attached to `ServiceExport`.
13
13
- The attached resource should exist in the same namespace as the policy resource.
14
14
15
+
### Multi-Cluster Health Check Configuration
16
+
17
+
In multi-cluster deployments, TargetGroupPolicy health check configurations are automatically propagated across all clusters that participate in the service mesh. When a TargetGroupPolicy is applied to a ServiceExport, all target groups created for that service across different clusters will use the same health check configuration, ensuring consistent health monitoring regardless of which cluster contains the route resource.
18
+
15
19
The policy will not take effect if:
16
20
- The resource does not exist
17
21
- The resource is not referenced by any route
@@ -32,12 +36,15 @@ However, the policy will not take effect unless the target is valid.
32
36
of VPC Lattice TargetGroup resource, except for health check updates.
33
37
- Attaching TargetGroupPolicy to an existing ServiceExport will result in a replacement of VPC Lattice TargetGroup resource, except for health check updates.
34
38
- Removing TargetGroupPolicy of a resource will roll back protocol configuration to default setting. (HTTP1/HTTP plaintext)
39
+
- In multi-cluster deployments, TargetGroupPolicy changes will automatically propagate to all clusters participating in the service mesh, ensuring consistent configuration across the deployment.
40
+
41
+
## Example Configurations
35
42
36
-
##Example Configuration
43
+
### Single Cluster Configuration
37
44
38
45
This will enable HTTPS traffic between the gateway and Kubernetes service, with customized health check configuration.
This example shows how to configure health checks for a ServiceExport in a multi-cluster deployment. The health check configuration will be automatically applied to all target groups across all clusters that participate in the service mesh.
* Implement a defense-in-depth strategy to secure communication between those services.
12
12
* Observe the request/response traffic across the services.
13
+
* Ensure consistent health check configuration across multi-cluster deployments through automatic policy propagation.
13
14
14
15
This documentation describes how to set up the AWS Gateway API Controller, provides example use cases, development concepts, and API references. AWS Gateway API Controller will provide developers the ability to publish services running on Kubernetes cluster and other compute platforms on AWS such as AWS Lambda or Amazon EC2. Once the AWS Gateway API controller deployed and running, you will be able to manage services for multiple Kubernetes clusters and other compute targets on AWS through the following:
Copy file name to clipboardExpand all lines: docs/concepts/overview.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,6 +52,8 @@ In the context of Kubernetes, Amazon VPC Lattice helps to simplify the following
52
52
-**Kubernetes multi-cluster connectivity**: Architecting multiple clusters across multiple VPCs.
53
53
After configuring your services with the AWS Gateway API Controller, you can facilitate advanced traffic management and application layer routing between services on those clusters without dealing with the underlying infrastructure.
54
54
VPC Lattice handles a lot of the details for you without needing things like sidecars.
55
+
56
+
**Multi-cluster health check consistency**: When using TargetGroupPolicy with ServiceExport resources, health check configurations are automatically propagated across all clusters participating in the service mesh. This ensures consistent health monitoring behavior regardless of which cluster contains the route resource, eliminating configuration drift and improving reliability in multi-cluster deployments.
55
57
-**Cross-platform access**: VPC Lattice allows access to serverless and Amazon EC2 features, as well as Kubernetes cluster features.
56
58
This gives you a way to have a consistent interface to multiple types of platforms.
57
59
-**Implement a defense-in-depth strategy**: Secure communication between services and networks.
Copy file name to clipboardExpand all lines: docs/faq.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,4 +16,8 @@ Your AWS VPC CNI must be v1.8.0 or later to work with VPC Lattice.
16
16
17
17
**Which versions of Gateway API are supported?**
18
18
19
-
AWS Gateway API Controller supports Gateway API CRD bundle versions `v1.1` or greater. Not all features of Gateway API are supported - for detailed features and limitation, please refer to individual API references. Please note that users are required to install Gateway API CRDs themselves as these are no longer bundled as of release `v1.1.0`. The latest Gateway API CRDs are available [here](https://gateway-api.sigs.k8s.io/). Please [follow this installation](https://gateway-api.sigs.k8s.io/guides/#installing-gateway-api) process.
19
+
AWS Gateway API Controller supports Gateway API CRD bundle versions `v1.1` or greater. Not all features of Gateway API are supported - for detailed features and limitation, please refer to individual API references. Please note that users are required to install Gateway API CRDs themselves as these are no longer bundled as of release `v1.1.0`. The latest Gateway API CRDs are available [here](https://gateway-api.sigs.k8s.io/). Please [follow this installation](https://gateway-api.sigs.k8s.io/guides/#installing-gateway-api) process.
20
+
21
+
**How do health checks work in multi-cluster deployments?**
22
+
23
+
In multi-cluster deployments, when you apply a TargetGroupPolicy to a ServiceExport, the health check configuration is automatically propagated to all target groups across all clusters that participate in the service mesh. This ensures consistent health monitoring behavior regardless of which cluster contains the route resource.
Copy file name to clipboardExpand all lines: docs/guides/advanced-configurations.md
+27Lines changed: 27 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,6 +48,33 @@ The `{index}` in the annotation corresponds to the zero-based index of the rule
48
48
49
49
Higher priority values indicate higher precedence, so requests to `/api/v2` will be matched by the first rule (priority 200) before the second rule (priority 100) is considered.
50
50
51
+
#### Configuring Health Checks for ServiceExport
52
+
53
+
When you apply a TargetGroupPolicy to a ServiceExport, the health check configuration is automatically propagated to all target groups across all clusters that participate in the service mesh:
### Configuring Health Checks for Multi-Cluster Services (Optional)
284
+
285
+
When deploying services across multiple clusters, you can ensure consistent health check configuration by applying a TargetGroupPolicy to your ServiceExport. This ensures that all target groups created for the service across different clusters use the same health check settings.
286
+
287
+
For example, to configure custom health checks for the inventory-ver2 service:
This configuration will be automatically applied to all target groups forthe inventory-ver2 service across all clustersin your multi-cluster deployment.
0 commit comments