Skip to content

Commit 0a4fe9e

Browse files
committed
Replace bucket example with EKS cluster
1 parent d5f3af2 commit 0a4fe9e

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

docs/content/docs/user-docs/features.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To use these feature, ensure you enable the [feature gates](https://github.com/a
1717
This feature allows users to adopt AWS resources by specifying the adoption policy as an annotation `services.k8s.aws/adoption-policy`.
1818
This annotation currenlty supports two values, `adopt` and `adopt-or-create`.
1919
`adopt` adoption policy strictly adopts resources as they are in AWS, and it is highly recommended to provide an empty spec (as it will be overriden
20-
if adoption is successful) and `services.k8s.aws/adoption-fields` annotation with all the fields necessary for to retrieve the resource from AWS
20+
if adoption is successful) and `services.k8s.aws/adoption-fields` annotation with all the fields necessary to retrieve the resource from AWS
2121
(this would be the `name` for EKS cluster, `queueURL` for SQS queues, `vpcID` for VPCs, or `arn` for SNS Topic, etc.)
2222
Here's an example for how to adopt an EKS cluster:
2323

@@ -44,17 +44,26 @@ fields necessary for a find/create. If the read operation required field is in t
4444
the `adoption-fields` annotation will be used to retrieve such fields.
4545
If the adoption is successful for `adopt-or-create`, the controller will attempt updating
4646
your AWS resource, to ensure your ACK manifest is the source of truth.
47-
Here's a sample manifests:
48-
S3 Bucket
47+
Here are some sample manifests:
48+
EKS Cluster
4949
```yaml
50-
apiVersion: s3.services.k8s.aws/v1alpha1
51-
kind: Bucket
50+
apiVersion: eks.services.k8s.aws/v1alpha1
51+
kind: Cluster
5252
metadata:
53-
name: mybucket
53+
name: my-cluster
5454
annotations:
55-
services.k8s.aws/adoption-policy: adopt-or-create
55+
services.k8s.aws/adoption-policy: "adopt-or-create"
5656
spec:
57-
name: mybucket
57+
name: my-cluster
58+
roleARN: arn:role:123456789/myrole
59+
version: "1.32"
60+
resourcesVPCConfig:
61+
endpointPrivateAccess: true
62+
endpointPublicAccess: true
63+
subnetIDs:
64+
- subnet-312ensdj2313dnsa2
65+
- subnet-1e323124ewqe43213
66+
5867
```
5968
VPC
6069
```yaml

0 commit comments

Comments
 (0)