Skip to content

Commit 89b5b86

Browse files
authored
Minor update to documentation for deploy, overview, and readme.md pages (#506)
* Add linter config * Doc: Update deployment doc prefix lists Add IPv4 and IPv6 prefix list Ids to security group ingress onboarding step instead of the specific IP range used by the Lattice network. * Doc: Update development doc with prefix lists Add IPv4 and IPv6 prefix list Ids to security group ingress onboarding step instead of the specific IP range used by the Lattice network. * ci: Use mattn/goveralls instead of shogo821/goveralls * ci: Use mattn/goveralls instead of shogo821/goveralls * doc: update overview page for v1 * Doc: Update readme * doc: add link to SG docs in deploy * nit: space and wording cleanup
1 parent 5f97041 commit 89b5b86

File tree

4 files changed

+61
-15
lines changed

4 files changed

+61
-15
lines changed

README.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,62 @@
11
# AWS Gateway API Controller for VPC Lattice
22

33
<p align="center">
4-
<img src="docs/images/kubernetes_icon.svg" alt="Kubernetes logo" width="200" />
5-
<img src="docs/images/controller.png" alt="AWS Load Balancer logo" width="200" />
4+
<img src="docs/images/kubernetes_icon.svg" alt="Kubernetes logo" width="100" />
5+
<img src="docs/images/controller.png" alt="AWS Load Balancer logo" width="100" />
66
</p>
77

88
AWS Application Networking is an implementation of the Kubernetes [Gateway API](https://gateway-api.sigs.k8s.io/). This project is designed to run in a Kubernetes cluster and orchestrates AWS VPC Lattice resources using Kubernetes Custom Resource Definitions like Gateway and HTTPRoute.
99

10+
## Documentation
11+
12+
### Website
13+
14+
The API specification and detailed documentation is available on the project
15+
website: [https://www.gateway-api-controller.eks.aws.dev/][ghp].
16+
17+
### Concepts
18+
19+
To get started, please read through [API concepts][concepts] and
20+
[Security model][security-model]. These documents give the necessary background
21+
to understand the API and the use-cases it targets.
22+
23+
### Getting started
24+
25+
Once you have a good understanding of the API at a higher-level, check out
26+
[getting started][getting-started] to install your first Gateway controller and try out
27+
one of the guides.
28+
29+
### References
30+
31+
A complete API reference, please refer to:
32+
33+
- [API reference][spec]
34+
- [Go docs for the package][godoc]
35+
36+
## Contributing
37+
38+
Developer guide can be found on the [developer guide page][dev].
39+
Our Kubernetes Slack channel is [#aws-gateway-api-controller][slack].
40+
41+
### Code of conduct
42+
43+
Participation in the Kubernetes community is governed by the
44+
[Kubernetes Code of Conduct](code-of-conduct.md).
45+
1046
## Security
1147

1248
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
1349

1450
## License
1551

1652
This project is licensed under the Apache-2.0 License.
53+
54+
[ghp]: https://www.gateway-api-controller.eks.aws.dev/
55+
[dev]: https://www.gateway-api-controller.eks.aws.dev/developer/
56+
[slack]: https://kubernetes.slack.com/messages/aws-gateway-api-controller
57+
[getting-started]: https://www.gateway-api-controller.eks.aws.dev/getstarted/
58+
[spec]: https://www.gateway-api-controller.eks.aws.dev/reference/grpc-route/
59+
[concepts]: https://www.gateway-api-controller.eks.aws.dev/configure/
60+
[security-model]: https://gateway-api.sigs.k8s.io/concepts/security-model
61+
[gh_release]: https://github.com/aws/aws-application-networking-k8s/releases/tag/v0.0.18
62+
[godoc]: https://www.gateway-api-controller.eks.aws.dev/

docs/deploy.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ Run through them again for a second cluster to use with the extended example sho
1010
export AWS_REGION=us-west-2
1111
export CLUSTER_NAME=my-cluster
1212
```
13-
1. You can use an existing EKS cluster or create a new one as shown here:
13+
2. You can use an existing EKS cluster or create a new one as shown here:
1414
```bash
1515
eksctl create cluster --name $CLUSTER_NAME --region $AWS_REGION
1616
```
17-
2. First, configure security group to receive traffic from the VPC Lattice network. You must set up security groups so that they allow all Pods communicating with VPC Lattice to allow traffic from the VPC Lattice managed prefix lists. Lattice has both an IPv4 and IPv6 prefix lists available.
17+
3. Configure security group to receive traffic from the VPC Lattice network. You must set up security groups so that they allow all Pods communicating with VPC Lattice to allow traffic from the VPC Lattice managed prefix lists. See [Control traffic to resources using security groups](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) for details. Lattice has both an IPv4 and IPv6 prefix lists available.
18+
1819
```bash
1920
CLUSTER_SG=$(aws eks describe-cluster --name $CLUSTER_NAME --output json| jq -r '.cluster.resourcesVpcConfig.clusterSecurityGroupId')
2021
PREFIX_LIST_ID=$(aws ec2 describe-managed-prefix-lists --query "PrefixLists[?PrefixListName=="\'com.amazonaws.$AWS_REGION.vpc-lattice\'"].PrefixListId" | jq -r '.[]')
336 KB
Loading

docs/index.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# AWS Gateway API Controller User Guide
22

3-
The AWS Gateway API Controller lets you connect services across multiple Kubernetes clusters through the Kubernetes Gateway API interface.
4-
It is also designed to connect services running on EC2 instances, containers, and as serverless functions.
5-
It does this by leveraging Amazon VPC Lattice, which works with Kubernetes Gateway API calls to manage Kubernetes objects.
3+
The AWS Gateway API controller integrates VPC Lattice with the Kubernetes Gateway API. When installed in your cluster, the controller watches for the creation of Gateway API resources such as gateways and routes and provisions corresponding Amazon VPC Lattice objects. This enables users to configure VPC Lattice Service Networks using Kubernetes APIs, without needing to write custom code or manage sidecar proxies. The AWS Gateway API Controller is an open-source project and fully supported by Amazon.
4+
5+
AWS Gateway API Controller integrates with Amazon VPC Lattice and allows you to:
6+
7+
* Handle network connectivity seamlessly between services across VPCs and accounts.
8+
* Discover these services spanning multiple Kubernetes clusters
9+
* Implement a defense-in-depth strategy to secure communication between those services.
10+
* Observe the request/response traffic across the services.
11+
12+
This documentation describes how to set up the AWS Gateway API Controller, provides example use cases, development concepts, and API references.
613

7-
This document describes how to set up the AWS Gateway API Controller and provides example use cases.
814
With the controller deployed and running, you will be able to manage services for multiple Kubernetes clusters and other targets on AWS through the following:
915

1016
* **CLI**: Use `aws` and `eksctl` to create clusters and set up AWS policies. Then use `kubectl` and YAML files to set up Kubernetes objects.
@@ -15,10 +21,3 @@ It does this by integrating with the Kubernetes Gateway API.
1521
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/).
1622

1723
For more information on this technology, see [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io/).
18-
19-
A few things to keep in mind:
20-
21-
* 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.
22-
* Your AWS VPC CNI must be v1.8.0 or later to work with VPC Lattice.
23-
24-

0 commit comments

Comments
 (0)