From 98bf585958aed1d7478e62dacb3ddb761fe72e6e Mon Sep 17 00:00:00 2001 From: Michael Ryan Peter Date: Tue, 3 Dec 2024 11:11:05 -0500 Subject: [PATCH] OSDOCS#12812: Remove TP, pull secret, and private catalog snippets Remove the following snippets in the OLM v1 docs: - Tech Preview - Known issue with private registries - Pull secrets Rephrase the abstract for the RH catalogs since they are now installed by default. --- extensions/arch/catalogd.adoc | 8 -------- extensions/arch/components.adoc | 3 --- extensions/arch/operator-controller.adoc | 3 --- extensions/catalogs/creating-catalogs.adoc | 8 -------- extensions/catalogs/fbc.adoc | 8 -------- extensions/catalogs/managing-catalogs.adoc | 4 ---- extensions/catalogs/rh-catalogs.adoc | 8 -------- extensions/ce/crd-upgrade-safety.adoc | 5 +---- extensions/ce/managing-ce.adoc | 8 -------- extensions/ce/upgrade-edges.adoc | 8 -------- extensions/index.adoc | 10 ---------- extensions/of-terms.adoc | 3 --- modules/olmv1-adding-a-catalog.adoc | 15 --------------- modules/olmv1-installing-an-operator.adoc | 6 ------ modules/olmv1-red-hat-catalogs.adoc | 22 +--------------------- operators/olm_v1/index.adoc | 5 +---- 16 files changed, 3 insertions(+), 121 deletions(-) diff --git a/extensions/arch/catalogd.adoc b/extensions/arch/catalogd.adoc index 9c58d77b2a..e06d7ef790 100644 --- a/extensions/arch/catalogd.adoc +++ b/extensions/arch/catalogd.adoc @@ -6,16 +6,8 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - {olmv1-first} uses the catalogd component and its resources to manage Operator and extension catalogs. -[IMPORTANT] -==== -include::snippets/olmv1-known-issue-private-registries.adoc[] -==== - include::modules/olmv1-about-catalogs.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources diff --git a/extensions/arch/components.adoc b/extensions/arch/components.adoc index 6e3ea1b43e..97a3d8345e 100644 --- a/extensions/arch/components.adoc +++ b/extensions/arch/components.adoc @@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - {olmv1-first} comprises the following component projects: Operator Controller:: xref:../../extensions/arch/operator-controller.adoc#operator-controller[Operator Controller] is the central component of {olmv1} that extends Kubernetes with an API through which users can install and manage the lifecycle of Operators and extensions. It consumes information from catalogd. diff --git a/extensions/arch/operator-controller.adoc b/extensions/arch/operator-controller.adoc index a35b403fe7..c2710f7f62 100644 --- a/extensions/arch/operator-controller.adoc +++ b/extensions/arch/operator-controller.adoc @@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - Operator Controller is the central component of {olmv1-first} and consumes the other {olmv1} component, catalogd. It extends Kubernetes with an API through which users can install Operators and extensions. include::modules/olmv1-clusterextension-api.adoc[leveloffset=+1] diff --git a/extensions/catalogs/creating-catalogs.adoc b/extensions/catalogs/creating-catalogs.adoc index 57872c3bdf..1b505f1853 100644 --- a/extensions/catalogs/creating-catalogs.adoc +++ b/extensions/catalogs/creating-catalogs.adoc @@ -6,16 +6,8 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - Catalog maintainers can create new catalogs in the file-based catalog format for use with {olmv1-first} on {product-title}. -[IMPORTANT] -==== -include::snippets/olmv1-known-issue-private-registries.adoc[] -==== - include::modules/olm-creating-fb-catalog-image.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources diff --git a/extensions/catalogs/fbc.adoc b/extensions/catalogs/fbc.adoc index 5f6a69adf4..a44f038e3c 100644 --- a/extensions/catalogs/fbc.adoc +++ b/extensions/catalogs/fbc.adoc @@ -6,16 +6,8 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - {olmv1-first} in {product-title} supports _file-based catalogs_ for discovering and sourcing cluster extensions, including Operators, on a cluster. -[IMPORTANT] -==== -include::snippets/olmv1-known-issue-private-registries.adoc[] -==== - include::modules/olm-fb-catalogs.adoc[leveloffset=+1] include::modules/olm-fb-catalogs-structure.adoc[leveloffset=+1] diff --git a/extensions/catalogs/managing-catalogs.adoc b/extensions/catalogs/managing-catalogs.adoc index bfdcbf9b0f..ed31693f80 100644 --- a/extensions/catalogs/managing-catalogs.adoc +++ b/extensions/catalogs/managing-catalogs.adoc @@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - Cluster administrators can add _catalogs_, or curated collections of Operators and Kubernetes extensions, to their clusters. Operator authors publish their products to these catalogs. When you add a catalog to your cluster, you have access to the versions, patches, and over-the-air updates of the Operators and extensions that are published to the catalog. You can manage catalogs and extensions declaratively from the CLI by using custom resources (CRs). @@ -29,6 +26,5 @@ include::modules/olmv1-about-catalogs.adoc[leveloffset=+1] * xref:../../extensions/catalogs/fbc.adoc#fbc[File-based catalogs] include::modules/olmv1-red-hat-catalogs.adoc[leveloffset=+1] -include::modules/olmv1-creating-a-pull-secret-for-catalogd.adoc[leveloffset=+1] include::modules/olmv1-adding-a-catalog.adoc[leveloffset=+1] include::modules/olmv1-deleting-catalog.adoc[leveloffset=+1] diff --git a/extensions/catalogs/rh-catalogs.adoc b/extensions/catalogs/rh-catalogs.adoc index 0aa5b54c9e..813e2529a3 100644 --- a/extensions/catalogs/rh-catalogs.adoc +++ b/extensions/catalogs/rh-catalogs.adoc @@ -6,14 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - Red Hat provides several Operator catalogs that are included with {product-title} by default. -[IMPORTANT] -==== -include::snippets/olmv1-known-issue-private-registries.adoc[] -==== - include::modules/olm-rh-catalogs.adoc[leveloffset=+1] diff --git a/extensions/ce/crd-upgrade-safety.adoc b/extensions/ce/crd-upgrade-safety.adoc index c7376637c7..f8098b61e5 100644 --- a/extensions/ce/crd-upgrade-safety.adoc +++ b/extensions/ce/crd-upgrade-safety.adoc @@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - When you update a custom resource definition (CRD) that is provided by a cluster extension, {olmv1-first} runs a CRD upgrade safety preflight check to ensure backwards compatibility with previous versions of that CRD. The CRD update must pass the validation checks before the change is allowed to progress on a cluster. [role="_additional-resources"] @@ -18,4 +15,4 @@ When you update a custom resource definition (CRD) that is provided by a cluster include::modules/prohibited-crd-upgrades.adoc[leveloffset=+1] include::modules/allowed-crd-upgrades.adoc[leveloffset=+1] include::modules/disabling-crd-preflight.adoc[leveloffset=+1] -include::modules/examples-unsafe-crd-upgrades.adoc[leveloffset=+1] \ No newline at end of file +include::modules/examples-unsafe-crd-upgrades.adoc[leveloffset=+1] diff --git a/extensions/ce/managing-ce.adoc b/extensions/ce/managing-ce.adoc index 66cdc5959d..6c6ba06d0e 100644 --- a/extensions/ce/managing-ce.adoc +++ b/extensions/ce/managing-ce.adoc @@ -6,18 +6,10 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - After a catalog has been added to your cluster, you have access to the versions, patches, and over-the-air updates of the extensions and Operators that are published to the catalog. You can manage extensions declaratively from the CLI using custom resources (CRs). -[IMPORTANT] -==== -include::snippets/olmv1-known-issue-private-registries.adoc[] -==== - include::modules/olmv1-supported-extensions.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/extensions/ce/upgrade-edges.adoc b/extensions/ce/upgrade-edges.adoc index 6577645cfb..3f91a264cc 100644 --- a/extensions/ce/upgrade-edges.adoc +++ b/extensions/ce/upgrade-edges.adoc @@ -6,18 +6,10 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - When determining upgrade edges, also known as upgrade paths or upgrade constraints, for an installed cluster extension, {olmv1-first} supports {olmv0} semantics starting in {product-title} 4.16. This support follows the behavior from {olmv0}, including `replaces`, `skips`, and `skipRange` directives, with a few noted differences. By supporting {olmv0} semantics, {olmv1} now honors the upgrade graph from catalogs accurately. -[IMPORTANT] -==== -include::snippets/olmv1-known-issue-private-registries.adoc[] -==== - .Differences from original {olmv0} implementation * If there are multiple possible successors, {olmv1} behavior differs in the following ways: diff --git a/extensions/index.adoc b/extensions/index.adoc index e271855adb..365ae5456b 100644 --- a/extensions/index.adoc +++ b/extensions/index.adoc @@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - Extensions enable cluster administrators to extend capabilities for users on their {product-title} cluster. {olm-first} has been included with {product-title} 4 since its initial release. {product-title} 4.17 includes components for a next-generation iteration of {olm} as a Generally Available (GA) feature, known during this phase as _{olmv1}_. This updated framework evolves many of the concepts that have been part of previous versions of {olm} and adds new capabilities. @@ -35,15 +32,8 @@ Earlier Technology Preview phases of {olmv1} introduced a new `Operator` API; th * The `Catalog` API, provided by the new catalogd component, serves as the foundation for {olmv1}, unpacking catalogs for on-cluster clients so that users can discover installable content, such as Kubernetes extensions and Operators. This provides increased visibility into all available Operator bundle versions, including their details, channels, and update edges. -- + -[IMPORTANT] -==== -include::snippets/olmv1-known-issue-private-registries.adoc[] -==== -+ For more information, see xref:../extensions/arch/operator-controller.adoc#operator-controller[Operator Controller] and xref:../extensions/arch/catalogd.adoc#catalogd[Catalogd]. - - Improved control over extension updates:: With improved insight into catalog content, administrators can specify target versions for installation and updates. This grants administrators more control over the target version of extension updates. For more information, see xref:../extensions/ce/managing-ce.adoc#olmv1-updating-an-operator_managing-ce[Updating an cluster extension]. diff --git a/extensions/of-terms.adoc b/extensions/of-terms.adoc index bf94748d71..fb1fc71e84 100644 --- a/extensions/of-terms.adoc +++ b/extensions/of-terms.adoc @@ -6,9 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - The following terms are related to the Operator Framework, including {olmv1-first}. include::modules/olm-terms.adoc[leveloffset=+1] diff --git a/modules/olmv1-adding-a-catalog.adoc b/modules/olmv1-adding-a-catalog.adoc index 946085180f..50e1153a25 100644 --- a/modules/olmv1-adding-a-catalog.adoc +++ b/modules/olmv1-adding-a-catalog.adoc @@ -9,21 +9,6 @@ To add a catalog to a cluster, create a catalog custom resource (CR) and apply it to the cluster. - -[IMPORTANT] -==== -include::snippets/olmv1-known-issue-private-registries.adoc[] -==== - -.Prerequisites - -// https://docs.asciidoctor.org/asciidoc/latest/directives/include-list-item-content/ -* {empty} -+ --- -include::snippets/olmv1-secure-registry-pull-secret.adoc[] --- - .Procedure . Create a catalog custom resource (CR), similar to the following example: diff --git a/modules/olmv1-installing-an-operator.adoc b/modules/olmv1-installing-an-operator.adoc index a3d22c94ff..6cc9da2312 100644 --- a/modules/olmv1-installing-an-operator.adoc +++ b/modules/olmv1-installing-an-operator.adoc @@ -9,12 +9,6 @@ You can install an extension from a catalog by creating a custom resource (CR) and applying it to the cluster. {olmv1-first} supports installing cluster extensions, including {olmv0} Operators via the `registry+v1` bundle format, that are scoped to the cluster. For more information, see _Supported extensions_. - -[IMPORTANT] -==== -include::snippets/olmv1-known-issue-private-registries.adoc[] -==== - .Prerequisites * You have added a catalog to your cluster. diff --git a/modules/olmv1-red-hat-catalogs.adoc b/modules/olmv1-red-hat-catalogs.adoc index 7772e7f97f..c3735fddd7 100644 --- a/modules/olmv1-red-hat-catalogs.adoc +++ b/modules/olmv1-red-hat-catalogs.adoc @@ -9,24 +9,7 @@ [id="olmv1-red-hat-catalogs_{context}"] = Red Hat-provided Operator catalogs in {olmv1} -{olmv1-first} does not include Red Hat-provided Operator catalogs by default. If you want to add a Red Hat-provided catalog to your cluster, create a custom resource (CR) for the catalog and apply it to the cluster. The following custom resource (CR) examples show how to create a catalog resources for {olmv1}. - -[IMPORTANT] -==== - -* {empty} -+ --- -include::snippets/olmv1-known-issue-private-registries.adoc[] --- - -* {empty} -+ --- -include::snippets/olmv1-secure-registry-pull-secret.adoc[] --- - -==== +{olmv1-first} includes the following Red Hat-provided Operator catalogs on the cluster by default. If you want to add an additional catalog to your cluster, create a custom resource (CR) for the catalog and apply it to the cluster. The following custom resource (CR) examples show the default catalogs installed on the cluster. .Example Red Hat Operators catalog [source,yaml,subs="attributes+"] @@ -40,7 +23,6 @@ spec: type: image image: ref: registry.redhat.io/redhat/redhat-operator-index:v{product-version} - pullSecret: pollInterval: <1> ---- <1> Specify the interval for polling the remote registry for newer image digests. The default value is `24h`. Valid units include seconds (`s`), minutes (`m`), and hours (`h`). To disable polling, set a zero value, such as `0s`. @@ -57,7 +39,6 @@ spec: type: image image: ref: registry.redhat.io/redhat/certified-operator-index:v{product-version} - pullSecret: pollInterval: 24h ---- @@ -73,7 +54,6 @@ spec: type: image image: ref: registry.redhat.io/redhat/community-operator-index:v{product-version} - pullSecret: pollInterval: 24h ---- diff --git a/operators/olm_v1/index.adoc b/operators/olm_v1/index.adoc index 9c52023b4b..cd071a4186 100644 --- a/operators/olm_v1/index.adoc +++ b/operators/olm_v1/index.adoc @@ -6,11 +6,8 @@ include::_attributes/common-attributes.adoc[] toc::[] -:FeatureName: {olmv1-first} -include::snippets/technology-preview.adoc[] - {olm-first} has been included with {product-title} 4 since its initial release. {product-title} 4.17 includes components for a next-generation iteration of {olm} as a Technology Preview feature, known during this phase as _{olmv1}_. This updated framework evolves many of the concepts that have been part of previous versions of {olm} and adds new capabilities. Starting in {product-title} 4.17, documentation for {olmv1} has been moved to the following new guide: -* xref:../../extensions/index.adoc#extensions-overview[Extensions ({olmv1})] \ No newline at end of file +* xref:../../extensions/index.adoc#extensions-overview[Extensions ({olmv1})]