Skip to content
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

Docs: OLM v1 limitations #984

Closed
Tracked by #959
m1kola opened this issue Jun 27, 2024 · 1 comment · Fixed by #1263
Closed
Tracked by #959

Docs: OLM v1 limitations #984

m1kola opened this issue Jun 27, 2024 · 1 comment · Fixed by #1263
Assignees
Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. v1.0 Issues related to the initial stable release of OLMv1
Milestone

Comments

@m1kola
Copy link
Member

m1kola commented Jun 27, 2024

There are a number of limitations in OLMv1 which we would like to document.

The first category of limitations is what described in this brief. When a user installs an extension we perform bundle validation we are able to check for these limitations and indicate an issue in ClusterExtension's conditions

  • We only support bundles which support install mode AllNamespaces.
  • We do not currently support bundles with webhooks.
  • We do not support bundles with dependencies declared as any of the following: olm.gvk.required, olm.package.required and olm.constraint). See this doc for more info on these FBC properties.

We also have the following limitations which is not possible to validate at the install time. Issues from this category of limitations will not be obvious from ClusterExtension's conditions since we are unable to catch them at install time based on metadata.

  • We do not support OperatorConditions API. We do not plan to support this API "as is" in OLMv1, but we are considering (issue) adding an alternative OLMv1 API (not in 1.0.0). Most of the operators who rely on this API will fail on startup, but some might fail during reconciliation (depends on operator implementation).
@m1kola m1kola added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 27, 2024
@perdasilva perdasilva added the documentation Improvements or additions to documentation label Aug 14, 2024
@perdasilva perdasilva changed the title Document OLM v1 limitations Docs: OLM v1 limitations Aug 14, 2024
@everettraven everettraven added this to the v1.0.0 milestone Aug 20, 2024
@everettraven everettraven added the v1.0 Issues related to the initial stable release of OLMv1 label Aug 27, 2024
@perdasilva perdasilva self-assigned this Sep 3, 2024
@michaelryanpeter
Copy link
Contributor

michaelryanpeter commented Sep 3, 2024

/assign

  • Also create a snippet admonition that can be reused in other parts of the docs.

michaelryanpeter added a commit to michaelryanpeter/operator-controller that referenced this issue Sep 12, 2024
michaelryanpeter added a commit to michaelryanpeter/operator-controller that referenced this issue Sep 12, 2024
michaelryanpeter added a commit to michaelryanpeter/operator-controller that referenced this issue Sep 12, 2024
michaelryanpeter added a commit to michaelryanpeter/operator-controller that referenced this issue Sep 12, 2024
michaelryanpeter added a commit to michaelryanpeter/operator-controller that referenced this issue Sep 12, 2024
michaelryanpeter added a commit to michaelryanpeter/operator-controller that referenced this issue Sep 12, 2024
michaelryanpeter added a commit to michaelryanpeter/operator-controller that referenced this issue Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. v1.0 Issues related to the initial stable release of OLMv1
Projects
Status: Done
4 participants