openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

OSDOCS#12812: Remove TP, pull secret, and private catalog snippets

Browse Source 
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.
This commit is contained in:
Michael Ryan Peter
2024-12-03 11:11:05 -05:00
committed by openshift-cherrypick-robot
parent ad26a8260a
commit 98bf585958
16 changed files with 3 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
extensions/arch/catalogd.adoc
View File

@@ -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

3
extensions/arch/components.adoc
View File

@@ -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.

3
extensions/arch/operator-controller.adoc
View File

@@ -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]

8
extensions/catalogs/creating-catalogs.adoc
View File

@@ -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

8
extensions/catalogs/fbc.adoc
View File

@@ -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]

4
extensions/catalogs/managing-catalogs.adoc
View File

@@ -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]

8
extensions/catalogs/rh-catalogs.adoc
View File

@@ -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]

5
extensions/ce/crd-upgrade-safety.adoc
View File

@@ -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]
include::modules/examples-unsafe-crd-upgrades.adoc[leveloffset=+1]

8
extensions/ce/managing-ce.adoc
View File

@@ -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"]

8
extensions/ce/upgrade-edges.adoc
View File

@@ -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:

10
extensions/index.adoc
View File

@@ -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].

3
extensions/of-terms.adoc
View File

@@ -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]

15
modules/olmv1-adding-a-catalog.adoc
View File

@@ -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:

6
modules/olmv1-installing-an-operator.adoc
View File

@@ -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.

22
modules/olmv1-red-hat-catalogs.adoc
View File

@@ -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: <pull_secret_name>
pollInterval: <poll_interval_duration> <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: <pull_secret_name>
pollInterval: 24h
----
@@ -73,7 +54,6 @@ spec:
type: image
image:
ref: registry.redhat.io/redhat/community-operator-index:v{product-version}
pullSecret: <pull_secret_name>
pollInterval: 24h
----

5
operators/olm_v1/index.adoc
View File

@@ -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})]
* xref:../../extensions/index.adoc#extensions-overview[Extensions ({olmv1})]