-
Notifications
You must be signed in to change notification settings - Fork 83
Introduce OperatorConditions doc #83
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Introduce OperatorConditions doc #83
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really well written @awgreene ! Just had one comment and a nit otherwise lgtm
|
||
## OperatorConditions | ||
|
||
OLM introduced a new [CustomResourceDefinition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) called the [OperatorCondition](https://github.com/operator-framework/api/blob/master/crds/operators.coreos.com_operatorconditions.yaml) allowing operators to communicate conditions to OLM. There are a set of "OLM Supported Conditions" which influence OLM's management of the operator when present in the OperatorCondition's [Status.Conditions](https://github.com/operator-framework/api/blob/b55a341f6560db4adec39d69aab1ff3092ea202a/pkg/operators/v1/operatorcondition_types.go#L22) array. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably include the CRD here instead of pointing to the codebase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: There are a set of "OLM Supported Conditions": did you mean for the OLM Supported Conditions to be in bold?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: There are a set of "OLM Supported Conditions": did you mean for the OLM Supported Conditions to be in bold?
No, I'm using it as a term to refer to a subset of conditions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably include the CRD here instead of pointing to the codebase.
Done.
4498095
to
f1cde2e
Compare
/lgtm |
I don't see the doc here: https://deploy-preview-83--operator-lifecycle-manager.netlify.app/docs/advanced-tasks/ or here: https://olm.operatorframework.io/docs/advanced-tasks/ |
|
||
```yaml | ||
apiVersion: operators.coreos.com/v1 | ||
kind: Condition |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the operatorcondition
?
/QE-approved |
No description provided.