Merge pull request #26509 from adellape/opm_cleanup

Author: adellape

modules/olm-building-operator-catalog-image.adoc

@@ -21,7 +21,7 @@ cluster has network access to, such as a mirror registry created during a
 restricted network cluster installation.
 
 For this example, the procedure assumes use of a mirror registry that has access
-to both your network and the internet.
+to both your network and the Internet.
 
 .Prerequisites
 
@@ -65,14 +65,16 @@ target mirror registry:
 ----
 $ podman login <registry_host_name>
 ----
-+
-Also authenticate with `registry.redhat.io` so that the base image can be pulled
+
+ifndef::openshift-origin[]
+. Authenticate with `registry.redhat.io` so that the base image can be pulled
 during the build:
 +
 [source,terminal]
 ----
 $ podman login registry.redhat.io
 ----
+endif::[]
 
 . Build a catalog image based on the `redhat-operators` catalog from Quay.io,
 tagging and pushing it to your mirror registry:

modules/olm-creating-index-image.adoc

@@ -11,7 +11,7 @@ You can create an index image using the `opm` CLI.
 
 * `opm` version 1.12.3+
 * `podman` version 1.4.4+
-* A bundle image built and pushed to a registry.
+* A bundle image built and pushed to a registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2/[Docker v2-2]
 
 .Procedure
 
@@ -20,17 +20,26 @@ You can create an index image using the `opm` CLI.
 [source,terminal]
 ----
 $ opm index add \
-    --bundles quay.io/<namespace>/test-operator:v0.1.0 \//<1>
-    --tag quay.io/<namespace>/test-catalog:latest \//<2>
+    --bundles <registry>/<namespace>/<bundle_image_name>:<tag> \//<1>
+    --tag <registry>/<namespace>/<index_image_name>:<tag> \//<2>
     [--binary-image <registry_base_image>] <3>
 ----
 <1> Comma-separated list of bundle images to add to the index.
 <2> The image tag that you want the index image to have.
 <3> Optional: An alternative registry base image to use for serving the catalog.
 
-. Push the index image to a registry:
+. Push the index image to a registry.
+
+.. If required, authenticate with your target registry:
++
+[source,terminal]
+----
+$ podman login <registry>
+----
+
+.. Push the index image:
 +
 [source,terminal]
 ----
-$ podman push quay.io/<namespace>/test-catalog:latest
+$ podman push <registry>/<namespace>/test-catalog:latest
 ----

modules/olm-mirroring-catalog.adoc

@@ -7,6 +7,7 @@
 
 _OperatorHub_ is the web console interface in {product-title} that cluster administrators use to discover and install Operators. With one click, an Operator can be pulled from its off-cluster source, installed and subscribed on the cluster, and made ready for engineering teams to self-service manage the product across deployment environments using the Operator Lifecycle Manager (OLM).
 
+ifndef::openshift-origin[]
 Cluster administrators can choose from catalogs grouped into the following categories:
 
 [cols="2a,8a",options="header"]
@@ -28,6 +29,7 @@ Cluster administrators can choose from catalogs grouped into the following categ
 |Custom Operators
 |Operators you add to the cluster yourself. If you have not added any Custom Operators, the Custom category does not appear in the web console on your OperatorHub.
 |===
+endif::[]
 
 [NOTE]
 ====

modules/olm-operatorhub-overview.adoc

@@ -7,13 +7,15 @@
 // * migration/migrating_4_2_4/deploying-cam-4-2-4.adoc
 
 ifdef::openshift-origin[]
+:catalog-name: upstream-community-operators
 :index-image-pullspec: quay.io/operator-framework/upstream-community-operators:latest
 :index-image: upstream-community-operators:latest
 :package1: couchdb-operator
 :package2: eclipse-che
 :package3: etcd
 endif::[]
 ifndef::openshift-origin[]
+:catalog-name: redhat-operators
 :index-image-pullspec: registry.redhat.io/redhat/redhat-operator-index:v4.6
 :index-image: redhat-operator-index:v4.6
 :package1: advanced-cluster-management
@@ -24,35 +26,46 @@ endif::[]
 [id="olm-pruning-index-image_{context}"]
 = Pruning an index image
 
-An index image, based on the Operator Bundle Format, is a containerized snapshot
-of an Operator catalog. You can prune an index of all but a specified list of
-packages, creating a copy of the source index containing only the Operators
-that you want.
+An index image, based on the Operator Bundle Format, is a containerized snapshot of an Operator catalog. You can prune an index of all but a specified list of packages, creating a copy of the source index containing only the Operators that you want.
 
-ifeval::["{context}" == "olm-restricted-networks"]
+ifeval::["{context}" != "olm-managing-custom-catalogs"]
 When configuring Operator Lifecycle Manager (OLM) to use mirrored content on restricted network {product-title} clusters, use this pruning method if you want to only mirror a subset of Operators from the default catalogs.
+
+For the steps in this procedure, the target registry is an existing mirror registry that is accessible by both your cluster and a workstation with unrestricted network access. This example also shows mirroring the default `{catalog-name}` catalog, but the process is the same for all catalogs.
 endif::[]
 
 .Prerequisites
 
+ifeval::["{context}" != "olm-managing-custom-catalogs"]
 * Workstation with unrestricted network access
+endif::[]
 * `podman` version 1.4.4+
 * link:https://github.com/fullstorydev/grpcurl[`grpcurl`]
 * `opm` version 1.12.3+
-* Access to mirror registry that supports
+* Access to a registry that supports
 link:https://docs.docker.com/registry/spec/manifest-v2-2/[Docker v2-2]
-* If you are working with private registries, set the `REG_CREDS` environment
-variable to the file path of your registry credentials for use in later steps.
-For example, for the `podman` CLI:
+
+.Procedure
+
+ifndef::openshift-origin[]
+ifeval::["{context}" != "olm-managing-custom-catalogs"]
+. Authenticate with `registry.redhat.io`:
 +
 [source,terminal]
 ----
-$ REG_CREDS=${XDG_RUNTIME_DIR}/containers/auth.json
+$ podman login registry.redhat.io
 ----
+endif::[]
+endif::[]
 
-.Procedure
+. Authenticate with your target registry:
++
+[source,terminal]
+----
+$ podman login <target_registry>
+----
 
-. On your workstation with unrestricted network access, run the source index image that you want to prune in a container. For example:
+. Run the source index image that you want to prune in a container. For example:
 +
 [source,terminal,subs="attributes+"]
 ----
@@ -107,21 +120,25 @@ $ grpcurl -plaintext localhost:50051 api.Registry/ListPackages > packages.out
 $ opm index prune \
     -f {index-image-pullspec} \// <1>
     -p {package1},{package2},{package3} \// <2>
-    -t <mirror_registry>:<port>/<namespace>/{index-image} <3>
+    -t <target_registry>:<port>/<namespace>/{index-image} <3>
 ----
 <1> Index to prune.
 <2> Comma-separated list of packages to keep.
 <3> Custom tag for new index image being built.
 
-. Run the following command to push the new index image to your mirror registry:
+. Run the following command to push the new index image to your target registry:
 +
 [source,text,subs="attributes+"]
 ----
-$ podman push <mirror_registry>:<port>/<namespace>/{index-image}
+$ podman push <target_registry>:<port>/<namespace>/{index-image}
 ----
 +
-where `<namespace>` is any existing namespace on the registry. For example, you might create an `olm-mirror` namespace to push all mirrored content to.
+where `<namespace>` is any existing namespace on the registry.
+ifeval::["{context}" != "olm-managing-custom-catalogs"]
+For example, you might create an `olm-mirror` namespace to push all mirrored content to.
+endif::[]
 
+:!catalog-name:
 :!index-image-pullspec:
 :!index-image:
 :!package1:

modules/olm-pruning-index-image.adoc

@@ -9,15 +9,11 @@
 [id="olm-restricted-networks-operatorhub_{context}"]
 = Disabling the default OperatorHub sources
 
-Operator catalogs that source content from Quay.io are configured for
-OperatorHub by default during an {product-title} installation. Before
-configuring OperatorHub to instead use local catalog sources in a restricted
-network environment, you must disable the default catalogs.
+Operator catalogs that source content provided by Red Hat and community projects are configured for OperatorHub by default during an {product-title} installation. Before configuring OperatorHub to instead use local catalog sources in a restricted network environment, you must disable the default catalogs.
 
 .Procedure
 
-* Disable the sources for the default catalogs by adding
-`disableAllDefaultSources: true` to the OperatorHub spec:
+* Disable the sources for the default catalogs by adding `disableAllDefaultSources: true` to the OperatorHub spec:
 +
 [source,terminal]
 ----

modules/olm-restricted-networks-configuring-operatorhub.adoc

@@ -6,7 +6,7 @@
 [id="olm-understanding-operator-catalog-images_{context}"]
 = Understanding Operator catalogs
 
-An Operator catalog is a repository of metadata that Operator Lifecycle Manager (OLM) can query to discover and install Operators and their dependencies on a cluster. OLM always installs Operators from the latest version of a catalog. As of {product-title} 4.6, Red Hat-provided catalogs are distributed using _index images_ from Quay.io.
+An Operator catalog is a repository of metadata that Operator Lifecycle Manager (OLM) can query to discover and install Operators and their dependencies on a cluster. OLM always installs Operators from the latest version of a catalog. As of {product-title} 4.6, Red Hat-provided catalogs are distributed using _index images_.
 
 An index image, based on the Operator Bundle Format, is a containerized snapshot of a catalog. It is an immutable artifact that contains the database of pointers to a set of Operator manifest content. A catalog can reference an index image to source its content for OLM on the cluster.
 
@@ -15,6 +15,7 @@ An index image, based on the Operator Bundle Format, is a containerized snapshot
 Starting in {product-title} 4.6, index images provided by Red Hat replace the App Registry catalog images, based on the deprecated Package Manifest Format, that are distributed for previous versions of {product-title} 4. While App Registry catalog images are not distributed by Red Hat for {product-title} 4.6 and later, custom catalog images based on the Package Manifest Format are still supported.
 ====
 
+ifndef::openshift-origin[]
 The following catalogs are distributed by Red Hat:
 
 .Red Hat-provided Operator catalogs
@@ -39,10 +40,10 @@ The following catalogs are distributed by Red Hat:
 |`community-operators`
 |`registry.redhat.io/redhat/community-operator-index:latest`
 |Software maintained by relevant representatives in the link:https://github.com/operator-framework/community-operators[operator-framework/community-operators] GitHub repository. No official support.
-
 |===
+endif::[]
 
-As catalogs are updated, the latest versions of Operators change, and older versions may be removed or altered. This behavior can cause problems maintaining reproducible installs over time. In addition, when OLM runs on an {product-title} cluster in a restricted network environment, it is unable to access the catalogs from Quay.io directly to pull the latest content.
+As catalogs are updated, the latest versions of Operators change, and older versions may be removed or altered. In addition, when OLM runs on an {product-title} cluster in a restricted network environment, it is unable to access the catalogs directly from the Internet to pull the latest content.
 
 As a cluster administrator, you can create your own custom index image, either based on a Red Hat-provided catalog or from scratch, which can be used to source the catalog content on the cluster. Creating and updating your own index image provides a method for customizing the set of Operators available on the cluster, while also avoiding the aforementioned restricted network environment issues.
 

modules/olm-understanding-operator-catalog-images.adoc

@@ -65,8 +65,8 @@ target mirror registry:
 ----
 $ podman login <registry_host_name>
 ----
-+
-Also authenticate with `registry.redhat.io` so that the base image can be pulled
+
+. Authenticate with `registry.redhat.io` so that the base image can be pulled
 during the build:
 +
 [source,terminal]

modules/olm-updating-operator-catalog-image.adoc

@@ -13,6 +13,7 @@ SDK.
 * Operator SDK version 0.19.4
 * `podman` version 1.4.4+
 * An Operator project generated using the Operator SDK
+* Access to a registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2/[Docker v2-2]
 
 .Procedure
 
@@ -21,7 +22,7 @@ SDK.
 [source,terminal]
 ----
 $ operator-sdk bundle create \
-    quay.io/<namespace>/test-operator:v0.1.0 \//<1>
+    <registry>/<namespace>/<bundle_image_name>:<tag> \//<1>
     -b podman <2>
 ----
 <1> The image tag that you want the bundle image to have.
@@ -31,30 +32,30 @@ $ operator-sdk bundle create \
 [NOTE]
 ====
 If your local manifests are not located in the default
-`<project_root>/deploy/olm-catalog/test-operator/manifests`, specify the
+`<project_root>/deploy/olm-catalog/<bundle_name>/manifests`, specify the
 location with the `--directory` flag.
 ====
 
 . Log in to the registry where you want to push the bundle image. For example:
 +
 [source,terminal]
 ----
-$ podman login quay.io
+$ podman login <registry>
 ----
 
 . Push the bundle image to the registry:
 +
 [source,terminal]
 ----
-$ podman push quay.io/<namespace>/test-operator:v0.1.0
+$ podman push <registry>/<namespace>/<bundle_image_name>:<tag>
 ----
 
 . Validate the bundle image in the remote registry:
 +
 [source,terminal]
 ----
 $ operator-sdk bundle validate \
-    quay.io/<namespace>/test-operator:v0.1.0 \
+    <registry>/<namespace>/<bundle_image_name>:<tag> \
     -b podman
 ----
 +