-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSDOCS-13626: updates oc mirror to v2 MicroShift #97064
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
62 changes: 27 additions & 35 deletions
62
microshift_running_apps/microshift_operators/microshift-operators-oc-mirror.adoc
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 |
---|---|---|
@@ -1,57 +1,49 @@ | ||
:_mod-docs-content-type: ASSEMBLY | ||
[id="microshift-operators-oc-mirror"] | ||
= Creating custom catalogs using the oc-mirror plugin | ||
= Creating custom Operator catalogs using the oc-mirror plugin | ||
include::_attributes/attributes-microshift.adoc[] | ||
:context: microshift-operators-oc-mirror | ||
|
||
toc::[] | ||
|
||
You can create custom catalogs with widely available Operators and mirror them by using the oc-mirror OpenShift CLI (oc) plugin. | ||
You can create custom catalogs with widely available Operators and mirror them by using the oc-mirror {oc-first} plugin. | ||
|
||
[id="microshift-olm-red-hat-ops-mirror_{context}"] | ||
== Using Red Hat-provided Operator catalogs and mirror registries | ||
You can filter and prune catalogs to get specific Operators and mirror them by using the oc-mirror OpenShift CLI (oc) plugin. You can also use Operators in disconnected settings or embedded in {op-system-ostree-first} images. To read more details about how to configure your systems for mirroring, use the links in the following "Additional resources" section. If you are ready to deploy Operators from Red Hat-provided Operator catalogs, mirror them, or to embed them in {op-system-ostree} images, start with the following section, "Inspecting catalog contents by using the oc-mirror plugin." | ||
|
||
//additional resources for deploying operators in disconnected environments | ||
[role="_additional-resources"] | ||
.Additional resources | ||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] | ||
* xref:../../microshift_install_get_ready/microshift-deploy-with-mirror-registry.adoc#microshift-configuring-hosts-for-mirror_microshift-deployment-mirror[Configuring hosts for mirror registry access] | ||
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts] | ||
* xref:../../microshift_install_get_ready/microshift-deploy-with-mirror-registry.adoc#microshift-get-mirror-reg-container-image-list_microshift-deploy-with-mirror-registry[Getting the mirror registry container image list] | ||
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-in-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use] | ||
include::modules/microshift-olm-rh-ops-mirror.adoc[leveloffset=+1] | ||
|
||
include::modules/microshift-oc-mirror-about-con.adoc[leveloffset=+1] | ||
|
||
//additional resources for preqeq to using oc mirror | ||
[role="_additional-resources"] | ||
.Additional resources | ||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#prerequisites_installing-mirroring-disconnected[Installing the oc mirror plugin] | ||
include::modules/microshift-oc-mirror-connectivity.adoc[leveloffset=+2] | ||
|
||
include::modules/microshift-oc-mirror-list-ops-catalogs.adoc[leveloffset=+2] | ||
include::modules/microshift-oc-mirror-list-ops-catalogs.adoc[leveloffset=+1] | ||
|
||
//First, make the image sets | ||
include::modules/microshift-oc-mirror-creating-imageset-config.adoc[leveloffset=+2] | ||
include::modules/microshift-oc-mirror-creating-imageset-config.adoc[leveloffset=+1] | ||
|
||
//OCP module, reference for valid imageset parameters for microshift; see conditionals | ||
include::modules/oc-mirror-imageset-config-params.adoc[leveloffset=+3] | ||
include::modules/oc-mirror-imageset-config-parameters-v2.adoc[leveloffset=+2] | ||
|
||
//additional resources for creating image sets | ||
[role="_additional-resources"] | ||
.Additional resources | ||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#oc-mirror-image-set-examples_installing-mirroring-disconnected[Imageset configuration examples] | ||
//mirroring from mirror to mirror | ||
include::modules/microshift-oc-mirror-to-mirror.adoc[leveloffset=+1] | ||
|
||
// OCP module, mirroring from mirror to mirror | ||
include::modules/oc-mirror-mirror-to-mirror.adoc[leveloffset=+2] | ||
//Convert the imageset file and add configuration to CRI-O | ||
include::modules/microshift-oc-mirror-transform-imageset-to-crio.adoc[leveloffset=+1] | ||
|
||
//additional resources for microshift mirror to mirror module | ||
//Apply changes to cluster so it can use Operators | ||
include::modules/microshift-oc-mirror-install-catalog-cluster.adoc[leveloffset=+1] | ||
|
||
[id="Additional-resources_microshift-operators-oc-mirror_{context}"] | ||
[role="_additional-resources"] | ||
.Additional resources | ||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#mirroring-image-set-partial[Mirroring an image set in a partially disconnected environment] | ||
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/installing/disconnected-installation-mirroring#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment] | ||
== Additional resources | ||
|
||
//Convert the imageset file and add configuration to CRI-O | ||
include::modules/microshift-oc-mirror-transform-imageset-to-crio.adoc[leveloffset=+2] | ||
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/disconnected_environments/mirroring-in-disconnected-environments#installation-oc-mirror-installing-plugin_about-installing-oc-mirror-v2[Installing the oc mirror plugin] | ||
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/disconnected_environments/mirroring-in-disconnected-environments#oc-mirror-migration-v1-to-v2[Migrating from oc-mirror plugin v1 to v2] | ||
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/disconnected_environments/mirroring-in-disconnected-environments#oc-mirror-custom-resources-v2_about-installing-oc-mirror-v2[About custom resources generated by oc-mirror plugin v2] | ||
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/disconnected_environments/mirroring-in-disconnected-environments#oc-mirror-about-cache-and-workspace-dirs_about-installing-oc-mirror-v2[About the --cache-dir and --workspace flags] | ||
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/operators/administrator-tasks#olm-restricted-networks[Using Operator Lifecycle Manager in disconnected environments] | ||
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/disconnected_environments/mirroring-in-disconnected-environments#oc-mirror-procedure-delete-v2_about-installing-oc-mirror-v2[Deleting images from a disconnected environment] | ||
|
||
//Apply changes to cluster so it can use Operators | ||
include::modules/microshift-oc-mirror-install-catalog-cluster.adoc[leveloffset=+2] | ||
{microshift-short} links:: | ||
ShaunaDiaz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* xref:../../microshift_install_get_ready/microshift-deploy-with-mirror-registry.adoc#microshift-configuring-hosts-for-mirror_microshift-deployment-mirror[Configuring hosts for mirror registry access] | ||
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts] | ||
* xref:../../microshift_install_get_ready/microshift-deploy-with-mirror-registry.adoc#microshift-deploy-with-mirror-registry[Mirroring container images for disconnected installations] | ||
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-in-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use] |
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 |
---|---|---|
@@ -1,37 +1,11 @@ | ||
//Module included in the following assemblies: | ||
// | ||
//* microshift_running_apps/microshift_operators/microshift-operators-olm.adoc | ||
//* microshift_running_apps/microshift_operators/microshift-operators-oc-mirror.adoc | ||
|
||
:_mod-docs-content-type: CONCEPT | ||
[id="microshift-using-oc-mirror_{context}"] | ||
= About the oc-mirror plugin for creating a mirror registry | ||
|
||
You can use the oc-mirror OpenShift CLI (oc) plugin with {microshift-short} to filter and prune Operator catalogs. You can then mirror the filtered catalog contents to a mirror registry or use the container images in disconnected or offline deployments with {op-system-ostree}. | ||
You can use the oc-mirror OpenShift CLI (oc) plugin with {microshift-short} to filter and delete images from Operator catalogs. You can then mirror the filtered catalog contents to a mirror registry or use the container images in disconnected or offline deployments. | ||
|
||
[NOTE] | ||
==== | ||
{microshift-short} uses the generally available version (1) of the oc-mirror plugin. Do not use the following procedures with the Technical Preview version (2) of oc-mirror plugin. | ||
==== | ||
|
||
You can mirror the container images required by the desired Operators locally or to a container mirror registry that supports link:https://docs.docker.com/registry/[Docker v2-2], such as {quay}. The procedure to mirror content from Red Hat-hosted registries connected to the internet to a disconnected image registry is the same, independent of the registry you choose. After you mirror the contents of your catalog, configure each cluster to retrieve this content from your mirror registry. | ||
|
||
[id="microshift-populate-mirror-registry-connectivity_{context}"] | ||
== Connectivity considerations when populating a mirror registry | ||
|
||
When you populate your registry, you can use one of following connectivity scenarios: | ||
|
||
Connected mirroring:: | ||
If you have a host that can access both the internet and your mirror registry, but not your cluster node, you can directly mirror the content from that machine. | ||
|
||
Disconnected mirroring:: | ||
If you do not have a host that can access both the internet and your mirror registry, you must mirror the images to a file system and then bring that host or removable media into your disconnected environment. | ||
+ | ||
[IMPORTANT] | ||
==== | ||
A container registry must be reachable by every machine in the clusters that you provision. Installing, updating, and other operations, such as relocating workloads, might fail if the registry is unreachable. | ||
==== | ||
|
||
To avoid problems caused by an unreachable registry, use the following standard practices: | ||
|
||
* Run mirror registries in a highly available way. | ||
* Ensure that the mirror registry at least matches the production availability of your clusters. | ||
The procedure to mirror content from Red Hat-hosted registries connected to the internet to a disconnected image registry is the same, independent of the registry you select. After you mirror the contents of your catalog, configure each cluster to retrieve this content from your 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,25 @@ | ||
//Module included in the following assemblies: | ||
// | ||
//* microshift_running_apps/microshift_operators/microshift-operators-oc-mirror.adoc | ||
|
||
:_mod-docs-content-type: CONCEPT | ||
[id="microshift-connectivity-considerations_{context}"] | ||
= Connectivity considerations when populating a mirror registry | ||
|
||
When you populate your registry, you can use one of following connectivity scenarios: | ||
|
||
Connected mirroring:: | ||
If you have a host that can access both the internet and your mirror registry, but not your cluster node, you can directly mirror the content from that machine. | ||
|
||
Disconnected mirroring:: | ||
If you do not have a host that can access both the internet and your mirror registry, you must mirror the images to a file system and then bring that host or removable media into your disconnected environment. | ||
+ | ||
[IMPORTANT] | ||
==== | ||
A container registry must be reachable by every machine in the cluster that you provision. Installing, updating, and other operations, such as relocating workloads, fail if the registry is unreachable. | ||
==== | ||
|
||
To avoid problems caused by an unreachable registry, use the following standard practices: | ||
|
||
* Run mirror registries in a highly available way. | ||
* Ensure that the mirror registry at least matches the production availability of your clusters. |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.