Skip to content

Commit c3142a9

Browse files
committed
Add links to pruning for disconnected OLM
1 parent f074f92 commit c3142a9

File tree

3 files changed

+31
-32
lines changed

3 files changed

+31
-32
lines changed

installing/installing-mirroring-installation-images.adoc

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,35 @@ include::modules/olm-mirroring-catalog.adoc[leveloffset=+1]
8484

8585
* xref:../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
8686

87-
include::modules/olm-mirroring-catalog-prereqs.adoc[leveloffset=+2]
87+
[id="olm-mirror-catalog-prerequisites_installing-mirroring-installation-images"]
88+
=== Prerequisites
89+
90+
Mirroring Operator catalogs for use with disconnected clusters has the following prerequisites:
91+
92+
* Workstation with unrestricted network access.
93+
* `podman` version 1.9.3 or later.
94+
* If you want to filter, or _prune_, the default catalog and selectively mirror only a subset of Operators, see the following sections:
95+
** xref:../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[Installing the opm CLI]
96+
** xref:../operators/admin/olm-restricted-networks.adoc#olm-pruning-index-image_olm-restricted-networks[Filtering a SQLite-based index image]
97+
ifndef::openshift-origin[]
98+
* If you want to mirror a Red Hat-provided catalog, run the following command on your workstation with unrestricted network access to authenticate with `registry.redhat.io`:
99+
+
100+
[source,terminal]
101+
----
102+
$ podman login registry.redhat.io
103+
----
104+
endif::[]
105+
* Access to a mirror registry that supports
106+
link:https://docs.docker.com/registry/spec/manifest-v2-2/[Docker v2-2].
107+
* On your mirror registry, decide which namespace to use for storing mirrored Operator content. For example, you might create an `olm-mirror` namespace.
108+
* If your mirror registry does not have internet access, connect removable media to your workstation with unrestricted network access.
109+
* If you are working with private registries, including `registry.redhat.io`, 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:
110+
+
111+
[source,terminal]
112+
----
113+
$ REG_CREDS=${XDG_RUNTIME_DIR}/containers/auth.json
114+
----
115+
88116
include::modules/olm-mirroring-catalog-extracting.adoc[leveloffset=+2]
89117
include::modules/olm-mirroring-catalog-colocated.adoc[leveloffset=+3]
90118
.Additional resources

modules/olm-mirroring-catalog-prereqs.adoc

Lines changed: 0 additions & 29 deletions
This file was deleted.

modules/olm-pruning-index-image.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ ifndef::openshift-origin[]
2323
endif::[]
2424

2525
[id="olm-pruning-index-image_{context}"]
26-
= Pruning a SQLite-based index image
26+
= Filtering a SQLite-based index image
2727

28-
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, which creates a copy of the source index containing only the Operators that you want.
28+
An index image, based on the Operator bundle format, is a containerized snapshot of an Operator catalog. You can filter, or _prune_, an index of all but a specified list of packages, which creates a copy of the source index containing only the Operators that you want.
2929

3030
ifeval::["{context}" != "olm-managing-custom-catalogs"]
3131
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.

0 commit comments

Comments
 (0)