Skip to content
This repository was archived by the owner on Aug 2, 2021. It is now read-only.

Commit 38efc69

Browse files
committed
Add note on api compatibility
1 parent 5ee1f7c commit 38efc69

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/when-to-update-my-operator.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,6 @@ For example:
2323
$ kubectl delete pods -n olm -l olm.catalogSource=operatorhubio-catalog
2424
2525
```
26-
The operators that were installed from the catalog will be updated automatically or manually, depending on the value of `installPlanApproval` in the Subscription for the operator. For more information on approving manual updates to operators, please see [How do I approve an update?](openshift/coming-soon.md)
26+
The operators that were installed from the catalog will be updated automatically or manually, depending on the value of `installPlanApproval` in the Subscription for the operator. For more information on approving manual updates to operators, please see [How do I approve an update?](openshift/coming-soon.md)
27+
28+
> Note: If you are changing the schema of a CustomResourceDefinition, please review the [kuberenetes sig-architecture's notes](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api_changes.md#on-compatibility) and review [this document](https://sdk.operatorframework.io/docs/migrating-existing-apis/) provided by the Operator-SDK teamon API compatibility.

0 commit comments

Comments
 (0)