Skip to content

Commit 5641791

Browse files
authored
Add image to user guide on Lattice/Kubernetes relationship (#51)
* Add image to user guide on Lattice/Kubernetes relationship * Added review comments * More review comments * Add title to image
1 parent a97e205 commit 5641791

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

docs/how-it-works.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ With the controller deployed and running, you will be able to manage services fo
1212

1313
While separating the application developer from the details of the underling infrastructure, the controller also provides a Kubernetes-native experience, rather than creating a lot of new AWS ways of managing services.
1414
It does this by integrating with the Kubernetes Gateway API.
15-
This lets you work with Kubernetes service-related resources using Kubernetes APIs and custom resource definitions (CRDs).
15+
This lets you work with Kubernetes service-related resources using Kubernetes APIs and custom resource definitions (CRDs) defined by the Kubernetes [networking.k8s.io specification](https://gateway-api.sigs.k8s.io/references/spec/).
1616

1717
For more information on this technology, see [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io/).
1818

1919
A few things to keep in mind:
2020
* If you are new to the VPC Lattice service, keep in mind that names you use for objects must be unique across your entire account and not just across each cluster used by that account.
2121
* Your AWS CNI must be v1.8.0 or later to work with VPC Lattice.
2222

23-
## Deploying the Gateway API Controller
23+
## Deploying the AWS Gateway API Controller
2424

2525
Follow these instructions to create a cluster and deploy the AWS Gateway API Controller.
2626
Run through them again for a second cluster to use with the extended example shown later.
@@ -43,12 +43,12 @@ Run through them again for a second cluster to use with the extended example sho
4343
{
4444
"Effect": "Allow",
4545
"Action": [
46-
"vpc-lattice:",
46+
"vpc-lattice:*",
4747
"iam:CreateServiceLinkedRole",
4848
"ec2:DescribeVpcs",
4949
"ec2:DescribeSubnets"
5050
],
51-
"Resource": ""
51+
"Resource": "*"
5252
}
5353
]
5454
}
@@ -82,10 +82,11 @@ Run through them again for a second cluster to use with the extended example sho
8282
kubectl apply -f examples/deploy-v0.0.1.yaml
8383
```
8484

85-
## Using the Gateway API Controller
85+
## Using the AWS Gateway API Controller
8686

8787
The first part of this section provides an example of setting up of service-to-service communications on a single cluster.
8888
The second section extends that example by creating another inventory service on a second cluster on a different VPC, and spreading traffic to that service across the two clusters and VPCs.
89+
Both clusters are created using `eksctl`, with both clusters created from the same account by the same cluster admin.
8990

9091
### Set up single-cluster/VPC service-to-service communications
9192

@@ -239,7 +240,7 @@ The following figure illustrates this:
239240

240241
1. Switch you credentials to use the second cluster
241242

242-
1. Create a Kubernetes inventory in the second cluster:
243+
1. Create a Kubernetes inventory-ver2 service in the second cluster:
243244
```bash
244245
kubectl apply -f examples/inventory-ver2.yaml
245246
```
@@ -336,9 +337,9 @@ With VPC Lattice you can also avoid some of these common problems:
336337
### Relationship between VPC Lattice and Kubernetes
337338

338339
As a Kubernetes user, you can have a very Kubernetes-native experience using the VPC Lattice APIs.
339-
The following figure illustrates how VPC Lattice object connect to [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io/) objects:
340+
The following figure illustrates how VPC Lattice objects connect to [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io/) objects:
340341

341-
[Image: VPCLatticeToKubernetesGatewayAPI.png]
342+
![VPC Lattice objects relation to Kubernetes objects](images/personae.png)
342343

343344
As shown in the figure, there are different personas associated with different levels of control in VPC Lattice.
344345
Notice that the Kubernetes Gateway API syntax is used to create the gateway, HTTPRoute and services, but Kubernetes gets the details of those items from VPC Lattice:

docs/images/personae.png

423 KB
Loading

0 commit comments

Comments
 (0)