Skip to content

Commit e5b558e

Browse files
authored
Merge pull request #38019 from chinmayi-chandrasekar/BZ1910284_mirroring_operator_catalog_REG_CREDS
BZ1910284: add clarification regarding REG_CREDS
2 parents f9f44a4 + 1c19fcf commit e5b558e

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

modules/olm-mirroring-catalog-colocated.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ $ oc adm catalog mirror \
4040
<1> Specify the index image for the catalog that you want to mirror. For example, this might be a pruned index image that you created previously, or one of the source index images for the default catalogs, such as `{index-image-pullspec}`.
4141
<2> Specify the target registry and namespace to mirror the Operator contents to, where `<namespace>` is any existing namespace on the registry. For example, you might create an `olm-mirror` namespace to push all mirrored content to.
4242
<3> Optional: If required, specify the location of your registry credentials file.
43+
`{REG_CREDS}` is required for `registry.redhat.io`.
4344
<4> Optional: If you do not want to configure trust for the target registry, add the `--insecure` flag.
4445
<5> Optional: Specify which platform and architecture of the index image to select when multiple variants are available. Images are passed as `'<platform>/<arch>[/<variant>]'`. This does not apply to images referenced by the index. Valid values are `linux/amd64`, `linux/ppc64le`, `linux/s390x`, and `.*`
4546
<6> Optional: Generate only the manifests required for mirroring, and do not actually mirror the image content to a registry. This option can be useful for reviewing what will be mirrored, and it allows you to make any changes to the mapping list if you require only a subset of packages. You can then use the `mapping.txt` file with the `oc image mirror` command to mirror the modified list of images in a later step. This flag is intended for only advanced selective mirroring of content from the catalog; the `opm index prune` command, if you used it previously to prune the index image, is suitable for most catalog management use cases.

modules/olm-mirroring-catalog-prereqs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ endif::[]
2121
link:https://docs.docker.com/registry/spec/manifest-v2-2/[Docker v2-2].
2222
* Decide which namespace on your mirror registry you will use to store the mirrored Operator content. For example, you might create an `olm-mirror` namespace.
2323
* If your mirror registry does not have internet access, connect removable media to your workstation with unrestricted network access.
24-
* 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:
24+
* 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:
2525
+
2626
[source,terminal]
2727
----

0 commit comments

Comments
 (0)