Skip to content

Commit a2ded12

Browse files
committed
Update readme to include fast fill logic
This #318 introduced a PrecreatingMode which actually let the CVO to push the clusterOperator in manifests. This enables a new pattern for individual operators to set related objects into the clusterOperator defined in manifests/ openshift/cluster-kube-apiserver-operator#833 openshift/cluster-etcd-operator#312 openshift/cluster-kube-controller-manager-operator#398
1 parent e3c7dd1 commit a2ded12

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/dev/clusteroperator.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ There are 2 important things that need to be set in the ClusterOperator Custom R
3333
- `.metadata.name`: name for finding the live instance
3434
- `.status.versions[name=operator].version`: this is the version that the operator is expected to report. ClusterVersionOperator only respects the `.status.conditions` from instances that report their version.
3535

36+
Additionally you might choose to include some fundamental relatedObjects.
37+
The must-gather and insights operator depend on cluster operators and related objects in order to identify resources to create.
38+
Because cluster operators are delegated to the operator install and upgrade failures of new operators can fail to gather the requisite info if the cluster degrades before those steps.
39+
To mitigate this scenario the ClusterVersionOperator will do a best effort to fast-fill cluster-operators using the ClusterOperator Custom Resource in /manifests.
40+
3641
Example:
3742

3843
For a cluster operator `my-cluster-operator`, that is reporting its status using a ClusterOperator instance named `my-cluster-operator`.

0 commit comments

Comments
 (0)