Skip to content

Commit e021bb4

Browse files
chore(docs): add status description of RGD (#619)
this adds a small example doc for the reported status on the RGD Signed-off-by: Jakob Möller <[email protected]>
1 parent ea6885a commit e021bb4

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

website/docs/docs/concepts/00-resource-group-definitions.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,3 +208,58 @@ resources:
208208
```
209209

210210
As part of processing the Resource Graph, the instance reconciler waits for the `externalRef` object to be present and reads the object from the cluster as a node in the graph. Subsequent resources can use data from this node.
211+
212+
## ResourceGraphDefinition Status Reporting
213+
214+
The `status` section of a `ResourceGraphDefinition` provides information about the state of the graph and it's generated `CustomResourceDefinition` and controller.
215+
216+
`status` includes a stable `Ready` condition (as well as a set of technical `status.conditions` that provide more detailed information about the state of the graph and its resources).
217+
218+
:::info
219+
220+
When the `Ready` condition `status` is `True`, it indicates that the ResourceGraphDefinition is valid and you can use it to create [instances](./15-instances.md).
221+
222+
:::
223+
224+
:::warning
225+
226+
Try to only rely on the `Ready` condition, as other condition types may change frequently and are more technical in nature, can change their API over time and are generally more indicative of KRO's internal state.
227+
228+
:::
229+
230+
Additionally, the ResourceGraphDefinition contains a `topologicalOrder` field that provides a list of resources in the order they should be processed. This is useful for understanding the dependencies between resources and their apply order.
231+
232+
Generally a status in `ResourceGraphDefinition` may look like
233+
234+
```yaml
235+
status:
236+
conditions:
237+
- lastTransitionTime: "2025-08-06T17:26:41Z"
238+
message: resource graph and schema are valid
239+
observedGeneration: 1
240+
reason: Valid
241+
status: "True"
242+
type: ResourceGraphAccepted
243+
- lastTransitionTime: "2025-08-06T17:26:41Z"
244+
message: kind DeploymentService has been accepted and ready
245+
observedGeneration: 1
246+
reason: Ready
247+
status: "True"
248+
type: KindReady
249+
- lastTransitionTime: "2025-08-06T17:26:41Z"
250+
message: controller is running
251+
observedGeneration: 1
252+
reason: Running
253+
status: "True"
254+
type: ControllerReady
255+
- lastTransitionTime: "2025-08-06T17:26:41Z"
256+
message: ""
257+
observedGeneration: 1
258+
reason: Ready
259+
status: "True"
260+
type: Ready
261+
state: Active
262+
topologicalOrder:
263+
- configmap
264+
- deployment
265+
```

0 commit comments

Comments
 (0)