Skip to content

Commit 30b852a

Browse files
authored
update readme (#18)
* init draft * fixup * fix link * remove link * fixup
1 parent 40e47b9 commit 30b852a

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
1-
## amazon-network-policy-controller-k8s
1+
## Amazon Network Policy Controller for Kubernetes
22

33
Kubernetes controller for NetworkPolicy resources for the [Amazon VPC CNI](https://github.com/aws/amazon-vpc-cni-k8s/).
44

55
This controller resolves the pod addresses for the configured network policies and publishes them via the CustomResourceDefinition `policyendpoints.networking.k8s.aws` for the VPC CNI node agent to consume.
66

7-
## Security disclosures
7+
📝 EKS Customers do not need to install this controller. Review the instructions in the [EKS User Guide](https://docs.aws.amazon.com/eks/latest/userguide/cni-network-policy.html). EKS installs and manages it automatically. This controller is for self managed clusters, such as [kops](https://kops.sigs.k8s.io) clusters.
8+
9+
## Getting Started
10+
11+
The controller image is published to AWS ECR.
12+
The directory `config/default` contains a default configuration for deploying the controller.
13+
14+
The controller does not require any IAM policies. It does not make AWS API calls.
15+
16+
### Prerequisites
17+
18+
- Kubernetes Version - 1.25+
19+
- Amazon VPC CNI version - 1.14.0+
20+
21+
## Security Disclosures
822

923
If you think you’ve found a potential security issue, please do not post it in the Issues. Instead, please follow the
1024
instructions [here](https://aws.amazon.com/security/vulnerability-reporting/) or [email AWS security directly](mailto:[email protected]).

0 commit comments

Comments
 (0)