Skip to content

Commit 582e181

Browse files
Add docs for conditions (#2529)
Fixes #966 Description of changes: Add docs for ACK Controller conditions By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent fea3f36 commit 582e181

File tree

1 file changed

+77
-1
lines changed

1 file changed

+77
-1
lines changed

docs/content/docs/user-docs/resource-crud.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,83 @@ kubectl delete -f bucket.yaml
7373
kubectl get bucket/$BUCKET_NAME
7474
```
7575

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
119+
120+
Possible Causes:
121+
* Transient AWS service unavailability
122+
* Access denied exceptions requiring credential updates
123+
124+
#### ACK.Advisory
125+
126+
Indicates advisory information present in the resource.
127+
128+
* **True**: Advisory condition exists
129+
* **False**: No advisory condition
130+
* **Unknown**: Advisory status cannot be determined
131+
132+
Possible Causes:
133+
* Attempting to modify an immutable field after resource creation
134+
135+
#### ACK.LateInitialized
136+
137+
Indicates the status of late initialization of fields.
138+
139+
* **True**: Late initialization completed
140+
* **False**: Late initialization in progress
141+
* Not present: No late initialization needed
142+
143+
#### ACK.ReferencesResolved
144+
145+
Indicates whether all AWSResourceReference type references have been resolved.
146+
147+
* **True**: All references resolved
148+
* **False**: Reference resolution failed
149+
* **Unknown**: Resolution status cannot be determined
150+
* Not present: No references to resolve
151+
76152
## Next Steps
77153

78154
Now that you have verified ACK service controller functionality, [checkout ACK
79-
functionality for creating resources in multiple AWS regions.](../multi-region-resource-management)
155+
functionality for creating resources in multiple AWS regions.](../multi-region-resource-management)

0 commit comments

Comments
 (0)