OSDOCS-17058: mirroring content CQA #117265
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| :_mod-docs-content-type: CONCEPT | ||
| [id="mirroring-image-set-full"] | ||
| = Mirroring an image set in a fully disconnected environment | ||
|
|
||
| [role="_abstract"] | ||
| To mirror an image set in a fully disconnected environment, you must first mirror the image set to a disk, then mirror the image set file on the disk to a mirror. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| :_mod-docs-content-type: CONCEPT | ||
| [id="mirroring-image-set"] | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID. |
||
| = Mirroring an image set to a mirror registry | ||
|
|
||
| [role="_abstract"] | ||
| You can use the oc-mirror CLI plugin to mirror images to a mirror registry in a partially disconnected environment or in a fully disconnected environment. | ||
|
|
||
| These procedures assume that you already have your mirror registry set up. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| :_mod-docs-content-type: CONCEPT | ||
| [id="mirroring-image-set-partial"] | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID. |
||
| = Mirroring an image set in a partially disconnected environment | ||
|
|
||
| [role="_abstract"] | ||
| In a partially disconnected environment, you can mirror an image set directly to the target mirror registry. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * disconnected/about-installing-oc-mirror-v2.adoc | ||
|
|
||
| :_mod-docs-content-type: CONCEPT | ||
| [id="mirroring-preparing-your-hosts"] | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID. |
||
| = Preparing your mirror hosts | ||
|
|
||
| [role="_abstract"] | ||
| Before you can use the oc-mirror plugin to mirror images, you must install the plugin and create a container image registry credentials file to allow the mirroring from Red Hat to your mirror. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| :_mod-docs-content-type: REFERENCE | ||
| [id="prerequisites_installing-mirroring-disconnected"] | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID. |
||
| = Prerequisites | ||
|
|
||
| [role="_abstract"] | ||
| Before you can mirror images using the oc-mirror plugin, you must meet several prerequisites. | ||
|
|
||
| The following prerequisites must be met: | ||
|
|
||
| * You must have a container image registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker v2-2] in the location that will host the {product-title} cluster, such as {quay}. | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| If you use {quay}, you must use version 3.6 or later with the oc-mirror plugin. If you have an entitlement to {quay}, see the documentation on deploying {quay} link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html/proof_of_concept_-_deploying_red_hat_quay/index[for proof-of-concept purposes] or link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index[by using the {quay} Operator]. If you need additional assistance selecting and installing a registry, contact your sales representative or Red Hat Support. | ||
| ==== | ||
| + | ||
| If you do not already have an existing solution for a container image registry, subscribers of {product-title} are provided a xref:../disconnected/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[mirror registry for Red Hat OpenShift]. The _mirror registry for Red{nbsp}Hat OpenShift_ is included with your subscription and is a small-scale container registry that can be used to mirror the required container images of {product-title} in disconnected installations. | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules). |
||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.
Collaborator
There was a problem hiding this comment. 🤖 [error] AsciiDocDITA.ContentType: The '_mod-docs-content-type' attribute definition is missing. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| :_mod-docs-content-type: CONCEPT | ||
| [id="using-oc-mirror_{context}"] | ||
| = Mirroring an image set to a mirror registry | ||
|
|
||
| [role="_abstract"] | ||
| Mirroring an image set to a mirror registry ensures that the required images are available in a secure and controlled environment, facilitating smoother deployments, updates, and maintenance tasks. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * disconnected/about-installing-oc-mirror-v2.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="prerequisites_oc-mirror-v2_{context}"] | ||
| = Prerequisites | ||
|
|
||
| [role="_abstract"] | ||
| Before you can mirror images with the oc-mirror plugin v2, you must meet several prerequisites. | ||
|
|
||
| The following prerequisites must be met: | ||
|
|
||
| * You must have a container image registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2[Docker V2-2] in the location that hosts the {product-title} cluster, such as {quay}. | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| * If you use {quay}, use version 3.6 or later with the oc-mirror plugin. See link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index[Deploying the Red{nbsp}Hat Quay Operator on {product-title} (Red{nbsp}Hat Quay documentation)]. If you need additional assistance selecting and installing a registry, contact your sales representative or Red{nbsp}Hat Support. | ||
|
|
||
| * If you do not have an existing solution for a container image registry, {product-title} subscribers receive a mirror registry for Red{nbsp}Hat OpenShift. This mirror registry is included with your subscription and serves as a small-scale container registry. You can use this registry to mirror the necessary container images of {product-title} for disconnected installations. | ||
| ==== | ||
|
|
||
| * Every machine in the provisioned clusters must have access to the mirror registry. If the registry is unreachable, tasks like installation, updating, or routine operations such as workload relocation, might fail. Mirror registries must be operated in a highly available manner, ensuring their availability aligns with the production availability of your {product-title} clusters. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID.