From ccc556f084aa14851395c83e204d94c0355da880 Mon Sep 17 00:00:00 2001 From: Michael Ryan Peter Date: Thu, 1 Aug 2024 14:27:11 -0400 Subject: [PATCH] OCPBUGS#35942: Remove OLMv1 dependency resolution topics --- _topic_maps/_topic_map.yml | 2 -- {modules => _unused_topics}/olmv1-dependency-concepts.adoc | 2 +- .../olm_v1/arch => _unused_topics}/olmv1-dependency.adoc | 0 modules/olmv1-finding-operators-to-install.adoc | 5 +---- modules/olmv1-version-range-support.adoc | 4 +--- .../olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc | 5 ----- snippets/olmv1-multi-catalog-admon.adoc | 4 ++-- snippets/olmv1-tp-extension-support.adoc | 4 +++- 8 files changed, 8 insertions(+), 18 deletions(-) rename {modules => _unused_topics}/olmv1-dependency-concepts.adoc (97%) rename {operators/olm_v1/arch => _unused_topics}/olmv1-dependency.adoc (100%) diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 1598dd2cfe..1c41e78ee9 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2014,8 +2014,6 @@ Topics: File: olmv1-operator-controller - Name: RukPak File: olmv1-rukpak - - Name: Dependency resolution - File: olmv1-dependency - Name: Catalogd File: olmv1-catalogd - Name: Installing an Operator from a catalog diff --git a/modules/olmv1-dependency-concepts.adoc b/_unused_topics/olmv1-dependency-concepts.adoc similarity index 97% rename from modules/olmv1-dependency-concepts.adoc rename to _unused_topics/olmv1-dependency-concepts.adoc index 2f515aab57..8444809dc6 100644 --- a/modules/olmv1-dependency-concepts.adoc +++ b/_unused_topics/olmv1-dependency-concepts.adoc @@ -70,4 +70,4 @@ Additionally, the user wants to pin the version of A to `v0.1.0`. .Output * Resolution set: -** Unable to resolve because A `v0.1.0` requires C `v0.1.0`, which conflicts with B `latest` requiring C `v0.2.0` \ No newline at end of file +** Unable to resolve because A `v0.1.0` requires C `v0.1.0`, which conflicts with B `latest` requiring C `v0.2.0` diff --git a/operators/olm_v1/arch/olmv1-dependency.adoc b/_unused_topics/olmv1-dependency.adoc similarity index 100% rename from operators/olm_v1/arch/olmv1-dependency.adoc rename to _unused_topics/olmv1-dependency.adoc diff --git a/modules/olmv1-finding-operators-to-install.adoc b/modules/olmv1-finding-operators-to-install.adoc index 81e44f5146..0a166fbcaa 100644 --- a/modules/olmv1-finding-operators-to-install.adoc +++ b/modules/olmv1-finding-operators-to-install.adoc @@ -43,10 +43,7 @@ $ curl -L http://localhost:8080/catalogs/redhat-operators/all.json \ . Run one of the following commands to return a list of Operators and extensions in a catalog. + -[IMPORTANT] -==== -Currently, {olmv1-first} supports extensions that do not use webhooks and are configured to use the `AllNamespaces` install mode. Extensions that use webhooks or that target a single or specified set of namespaces cannot be installed. -==== +include:snippets/olmv1-tp-extension-support.adoc[] + * Get a list of all the Operators and extensions from the local catalog file by running the following command: + diff --git a/modules/olmv1-version-range-support.adoc b/modules/olmv1-version-range-support.adoc index 5ac6c14c1f..4fe71cfde6 100644 --- a/modules/olmv1-version-range-support.adoc +++ b/modules/olmv1-version-range-support.adoc @@ -10,8 +10,6 @@ In {olmv1-first}, you can specify a version range by using a comparison string in an Operator or extension's custom resource (CR). If you specify a version range in the CR, {olmv1} installs or updates to the latest version of the Operator that can be resolved within the version range. .Resolved version workflow -* The resolved version is the latest version of the Operator that satisfies the dependencies and constraints of the Operator and the environment. +* The resolved version is the latest version of the Operator that satisfies the constraints of the Operator and the environment. * An Operator update within the specified range is automatically installed if it is resolved successfully. * An update is not installed if it is outside of the specified range or if it cannot be resolved successfully. - -For more information about dependency and constraint resolution in {olmv1}, see "Dependency resolution in {olmv1}". diff --git a/operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc b/operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc index 219b264327..29b7fed4a1 100644 --- a/operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc +++ b/operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc @@ -110,11 +110,6 @@ Support for semantic versioning (semver) upgrade constraints was introduced in { * xref:../../operators/understanding/olm/olm-workflow.adoc#olm-upgrades_olm-workflow[{olmv0-caps} upgrade semantics] include::modules/olmv1-version-range-support.adoc[leveloffset=+2] - -[role="_additional-resources"] -.Additional resources -* xref:../../operators/olm_v1/arch/olmv1-dependency.adoc#olmv1-dependency[Dependency resolution in OLM 1.0] - include::modules/olmv1-version-range-comparisons.adoc[leveloffset=+2] include::modules/olmv1-about-target-versions.adoc[leveloffset=+2] include::modules/olmv1-forcing-an-update-or-rollback.adoc[leveloffset=+2] diff --git a/snippets/olmv1-multi-catalog-admon.adoc b/snippets/olmv1-multi-catalog-admon.adoc index 9d85d0cd12..df1a395680 100644 --- a/snippets/olmv1-multi-catalog-admon.adoc +++ b/snippets/olmv1-multi-catalog-admon.adoc @@ -8,6 +8,6 @@ ==== If you try to install an Operator or extension that does not have unique name, the installation might fail or lead to an unpredictable result. This occurs for the following reasons: -* If mulitple catalogs are installed on a cluster, {olmv1} does not include a mechanism to specify a catalog when you install an Operator or extension. -* Dependency resolution in {olmv1-first} requires that all of the Operators and extensions that are available to install on a cluster use a unique name for their bundles and packages. +* If mulitple catalogs are installed on a cluster, {olmv1-first} does not include a mechanism to specify a catalog when you install an Operator or extension. +* {olmv1} requires that all of the Operators and extensions that are available to install on a cluster use a unique name for their bundles and packages. ==== diff --git a/snippets/olmv1-tp-extension-support.adoc b/snippets/olmv1-tp-extension-support.adoc index a2bbb23c8e..cf42f82fa3 100644 --- a/snippets/olmv1-tp-extension-support.adoc +++ b/snippets/olmv1-tp-extension-support.adoc @@ -8,10 +8,12 @@ [IMPORTANT] ==== +{olmv1} does not support dependency resolution. If an extension declares dependencies for other APIs or packages, the dependencies must be present on the cluster before you attempt to install the extension. + Currently, {olmv1} supports the installation of extensions that meet the following criteria: * The extension must use the `AllNamespaces` install mode. * The extension must not use webhooks. Cluster extensions that use webhooks or that target a single or specified set of namespaces cannot be installed. -==== \ No newline at end of file +====