You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
const slaMessage = `Hello @${username} 👋 Thank you for opening an issue in ACK! A maintainer will triage this issue soon.\n\nWe encourage community contributions, so if you're interested in tackling this yourself or suggesting a solution, please check out our [Contribution](https://github.com/aws-controllers-k8s/community/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/aws-controllers-k8s/community/blob/main/CODE_OF_CONDUCT.md) guidelines.\n\nYou can find more information about ACK on our [website](https://aws-controllers-k8s.github.io/community/).`;
Copy file name to clipboardExpand all lines: docs/content/docs/user-docs/features.md
+55-4Lines changed: 55 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,14 @@ toc: true
11
11
---
12
12
13
13
Currently we support 4 feature gates for our controllers.
14
+
To use these feature, ensure you enable the [feature gates](https://github.com/aws-controllers-k8s/ec2-controller/blob/b6dff777c35d03335ebb0c3ffca5ee7577e70f18/helm/values.yaml#L164-L172) during helm install, as they are disabled by default.
14
15
15
16
### ResourceAdoption
16
-
This feature allows users to adopt AWS resources by specifying the adoption policy as an annotation `services.k8s.aws/adoption-policyy` (currently only supporting `adopt` as a value), and providing the fields required for a read operation in an annotation called `services.k8s.aws/adoption-fields` in json format, and an empty spec.
17
+
This feature allows users to adopt AWS resources by specifying the adoption policy as an annotation `services.k8s.aws/adoption-policy`.
18
+
This annotation currently supports two values, `adopt` and `adopt-or-create`.
19
+
`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 to retrieve the resource from AWS
21
+
(this would be the `name` for EKS cluster, `queueURL` for SQS queues, `vpcID` for VPCs, or `arn` for SNS Topic, etc.)
17
22
Here's an example for how to adopt an EKS cluster:
18
23
19
24
```yaml
@@ -29,8 +34,54 @@ metadata:
29
34
}
30
35
```
31
36
Applying the above manifest allows users to adopt an existing EKS cluster named `my-cluster`.
32
-
After reconciliation, all the fields in the spec and status will be filled by the controleler.
33
-
This feature is currently available for the s3 controller, and we'll see more releases in the future for other controllers
37
+
After reconciliation, all the fields in the spec and status will be populated by the controller.
38
+
39
+
When you want the controller to create resources if they don't exist, you can set
40
+
`adopt-or-create`adoption policy. With this policy, as the name suggests, the controller
41
+
will adopt the resource if it exists, or create it if it doesn't.
42
+
For `adopt-or-create` the controller expects the spec to be populated by the user with all the
43
+
fields necessary for a find/create. If the read operation required field is in the status
44
+
the `adoption-fields` annotation will be used to retrieve such fields.
45
+
If the adoption is successful for `adopt-or-create`, the controller will attempt updating
46
+
your AWS resource, to ensure your ACK manifest is the source of truth.
This feature allows users to mark a resource as read only, as in, it would ensure that the resource will not call any update operation, and will not be patching anything in the spec, but instead, it will be reconciling the status and ensuring it matches the resource it points to.
Copy file name to clipboardExpand all lines: docs/content/docs/user-docs/resource-crud.md
+77-1Lines changed: 77 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,83 @@ kubectl delete -f bucket.yaml
73
73
kubectl get bucket/$BUCKET_NAME
74
74
```
75
75
76
+
77
+
## Understanding ACK Controller Conditons
78
+
79
+
80
+
ACK controllers use conditions to indicate the state of custom resources and their corresponding AWS service resources. These conditions are exposed in the `Status.Conditions` collection of each custom resource.
81
+
82
+
### Condition Types
83
+
84
+
#### ACK.Adopted
85
+
86
+
Indicates that an adopted resource custom resource has been successfully reconciled and the target has been created.
87
+
88
+
***True**: Resource has been successfully adopted
89
+
***False**: Resource adoption failed
90
+
***Unknown**: Resource adoption status cannot be determined
91
+
92
+
#### ACK.ResourceSynced
93
+
94
+
Indicates whether the state of the resource in the backend AWS service is in sync with the ACK service controller.
95
+
96
+
***True**: Resource is fully synced
97
+
***False**: Resource is out of sync
98
+
***Unknown**: Sync status cannot be determined
99
+
100
+
#### ACK.Terminal
101
+
102
+
Indicates that the custom resource Spec needs to be updated before any further sync can occur.
103
+
104
+
***True**: Resource is in terminal state
105
+
***False**: Resource is not in terminal state
106
+
***Unknown**: Terminal state cannot be determined
107
+
108
+
Possible Causes:
109
+
* Invalid arguments in input YAML
110
+
* Resource creation failed in AWS
111
+
112
+
#### ACK.Recoverable
113
+
114
+
Indicates errors that may be resolved without updating the custom resource spec.
115
+
116
+
***True**: Error is recoverable
117
+
***False**: Error is not recoverable
118
+
***Unknown**: Recovery status cannot be determined
0 commit comments