Skip to content

Commit 8dbfbb6

Browse files
authored
Update README.md (#22)
1 parent 460f4b7 commit 8dbfbb6

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,36 @@ Kubernetes Github project.
88

99
[ack-issues]: https://github.com/aws-controllers-k8s/community/issues
1010

11+
❗❗ ACK EC2-Controller is released in the [*PREVIEW* Phase](https://aws-controllers-k8s.github.io/community/docs/community/releases/#preview) and is still in development. **Not recommended for production use.** ❗❗
12+
13+
## Install the Controller
14+
15+
Start with the [Install an ACK Controller](https://aws-controllers-k8s.github.io/community/docs/user-docs/install/) section to install the controller into a cluster and setup necessary IAM Permissions.
16+
17+
*Note: it is recommended and assumed your local terminal has kubectl and AWS credentials configured to use the hosting cluster and AWS account, respectively.*
18+
19+
## Create/Delete an ACK Resource
20+
21+
* Navigate to [test resources]() for a list of resource `yaml` templates
22+
* Copy the file to the local terminal and substitute `$` values. Ex: [vpc.yaml](https://github.com/aws-controllers-k8s/ec2-controller/blob/main/test/e2e/resources/vpc.yaml)
23+
24+
```
25+
apiVersion: ec2.services.k8s.aws/v1alpha1
26+
kind: VPC
27+
metadata:
28+
name: My-ACK-Resource
29+
spec:
30+
cidrBlock: 172.31.0.0/16
31+
```
32+
33+
* Create a VPC: `kubectl apply -f vpc.yaml`
34+
* Check its status: `kubectl describe vpc/My-ACK-Resource`
35+
* Delete the VPC: `kubectl delete -f vpc.yaml`
36+
37+
## Uninstall the Controller
38+
39+
Navigate to [Uninstall an ACK Controller](https://aws-controllers-k8s.github.io/community/docs/user-docs/cleanup/) section and substitute service values with `ec2`
40+
1141
## Contributing
1242

1343
We welcome community contributions and pull requests.

0 commit comments

Comments
 (0)