Skip to content

Commit e290b23

Browse files
committed
wip
1 parent a5a34b7 commit e290b23

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

docs/documentation/workflows.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,10 @@ Workflows are defined as a set of [dependent resources](https://javaoperatorsdk.
2222
and dependencies between them, along with some conditions that mainly helps define optional resources and
2323
pre- and post-conditions to describe expected states of a resource at a certain point in the workflow.
2424

25-
When or after a workflow executed no state is persisted regarding the workflow execution. On every reconciliation
26-
all the resources are reconciled again, in other words the whole workflow is evaluated again.
27-
2825
## Elements of Workflow
2926

3027
- **Dependent resource** (DR) - are the resources which are managed in reconcile logic.
31-
- **Depends-on relation** - if a DR B depends on another DR A, means that B will be reconciled after A is successfully
32-
reconciled and ready if readyPostCondition is used.
28+
- **Depends-on relation** - if a DR `B` depends on another DR `A`, means that `B` will be reconciled after `A`.
3329
- **Reconcile precondition** - is a condition that needs to be fulfilled before the DR is reconciled. This allows also
3430
to define optional resources, that for example only created if a flag in a custom resource `.spec` has some
3531
specific value.
@@ -40,7 +36,7 @@ all the resources are reconciled again, in other words the whole workflow is eva
4036

4137
## Defining Workflows
4238

43-
Similarly to dependent resources, there are two ways to define workflows, in managed and standalone way.
39+
Similarly to dependent resources, there are two ways to define workflows, in managed and standalone manner.
4440

4541
### Managed
4642

@@ -49,7 +45,7 @@ before the `reconcile` method is called. The result of the reconciliation is acc
4945

5046
Following sample shows a hypothetical sample, where there are two resources a Deployment and a ConfigMap, where
5147
the ConfigMap depends on the deployment. Deployment has a ready condition so, the config map is only reconciled after
52-
the Deployment and only if that is ready (see ready postcondition). The ConfigMap has a reconcile precondition, there
48+
the Deployment and only if that is ready (see ready postcondition). The ConfigMap reconcile precondition, there
5349
only reconciled if that condition holds. In addition to that contains a delete postCondition, do only considered to be
5450
deleted if that condition holds.
5551

@@ -271,4 +267,6 @@ The exceptions can be handled by [`ErrorStatusHandler`](https://github.com/java-
271267
- If a resource has owner references, it will be automatically deleted by Kubernetes garbage collector if
272268
the owner resource is marked for deletion. This might not be desirable, to make sure that delete is handled by the
273269
workflow don't use garbage collected kubernetes dependent resource, use for example [`CRUDNoGCKubernetesDependentResource`](https://github.com/java-operator-sdk/java-operator-sdk/blob/86e5121d56ed4ecb3644f2bc8327166f4f7add72/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDNoGCKubernetesDependentResource.java).
270+
- After a workflow executed no state is persisted regarding the workflow execution. On every reconciliation
271+
all the resources are reconciled again, in other words the whole workflow is evaluated again.
274272

0 commit comments

Comments
 (0)