forked from operator-framework/operator-controller
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📖 [Docs] Supported extensions (OLM v1 constraints/limitations)
Closes operator-framework#984
- Loading branch information
1 parent
f61ffb4
commit 588dfb0
Showing
3 changed files
with
26 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
## Supported extensions | ||
|
||
Currently, OLM v1 supports installing cluster extensions that meet the following criteria: | ||
|
||
* The extension must support installation via the `AllNamespaces` install mode. | ||
* The extension must not use webhooks. | ||
* The extension must not declare dependencies using the any of following file-based catalog properties: | ||
|
||
* `olm.gvk.required` | ||
* `olm.package.required` | ||
* `olm.constraint` | ||
|
||
When you install an extension, OLM v1 runs checks to validate the bundle you want to install meets these constraints. If you try to install an extension that does not meet these constraints, an error message is printed in the cluster extension's conditions. | ||
|
||
!!! important | ||
|
||
OLM v1 does not support the `OperatorConditions` API introduced in legacy OLM. | ||
|
||
Currently, there is no testing to validate against this constraint. If an extension uses the `OperatorConditions` API, the extension does not install correctly. Most extensions that rely on this API fail at start time, but some might fail during reconcilation. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters