Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-operators-oc-mirror-disconnected"]
= Adding OLM-based Operators to a disconnected node

include::_attributes/attributes-microshift.adoc[]
:context: microshift-operators-oc-mirror-disconnected

toc::[]

You can use OLM-based Operators in disconnected situations by embedding them in a {op-system-ostree-first} image.
[role="_abstract"]
You can use Operators managed by Operator Lifecycle Manager (OLM) for various tasks in disconnected situations by embedding them in a {op-system-ostree-first} image.

//Using OLM disconnected
include::modules/microshift-olm-deploy-op-disconnected-con.adoc[leveloffset=+1]

//additional resources for embedding operators into rhel for edge disconnected
[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/documentation/en-us/red_hat_build_of_microshift/{ocp-version}/html/embedding_in_a_rhel_for_edge_image/microshift-embed-in-rpm-ostree#microshift-creating-ostree-iso_microshift-embed-in-rpm-ostree[Creating the RHEL for Edge image]
* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-networking-disconnected-hosts[Configuring network settings for fully disconnected hosts]

//OCP module, edit with conditionals and care
include::modules/oc-mirror-dry-run.adoc[leveloffset=+2]

include::modules/microshift-oc-mirror-embed-ops-disconnected-use.adoc[leveloffset=+2]

include::modules/microshift-ops-config-embed-ostree.adoc[leveloffset=+2]

[id="additional-resources_microshift-operators-oc-mirror-disconnected"]
[role="_additional-resources"]
== Additional resources

* xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc#microshift-embed-rpm-ostree-offline-use[Embedding in a {op-system-ostree} image for offline use]
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-networking-disconnected-hosts[Configuring network settings for fully disconnected hosts]
Original file line number Diff line number Diff line change
@@ -1,32 +1,18 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-operators-oc-mirror"]
= Creating custom 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.

[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://docs.redhat.com/en/documentation/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-deployment-mirror[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]
[role="_abstract"]
You can create custom catalogs with widely available Operators and mirror them by using the oc-mirror {oc-first} plugin. Custom catalogs give you the tool so that you can host Operators locally, or control a variety of factors, such as versions and access.

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://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/disconnected_environments/index#installing-mirroring-installation-images[Mirroring images for a disconnected installation by using the oc adm command]
include::modules/microshift-connectivity-pop-mirror-registry.adoc[leveloffset=+2]

include::modules/microshift-oc-mirror-list-ops-catalogs.adoc[leveloffset=+2]

Expand All @@ -36,20 +22,9 @@ include::modules/microshift-oc-mirror-creating-imageset-config.adoc[leveloffset=
//OCP module, reference for valid imageset parameters for microshift; see conditionals
include::modules/oc-mirror-imageset-config-params.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-single/disconnected_environments/index#oc-mirror-image-set-examples_installing-mirroring-disconnected[Imageset configuration examples]

// OCP module, mirroring from mirror to mirror
include::modules/oc-mirror-mirror-to-mirror.adoc[leveloffset=+2]

//additional resources for microshift mirror to mirror module
[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html-single/disconnected_environments/index#oc-mirror-workflows-partially-disconnected-v2_about-installing-oc-mirror-v2[Mirroring an image set in a partially disconnected environment]
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/disconnected_environments/index#oc-mirror-workflows-fully-disconnected-v2_about-installing-oc-mirror-v2[Mirroring an image set in a fully disconnected environment]

//Convert the imageset file and add configuration to CRI-O
include::modules/microshift-oc-mirror-transform-imageset-to-crio.adoc[leveloffset=+2]

Expand All @@ -59,7 +34,11 @@ include::modules/microshift-oc-mirror-install-catalog-node.adoc[leveloffset=+1]
[id="Additional-resources_microshift-operators-oc-mirror_{context}"]
[role="_additional-resources"]
== Additional resources
* 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]

* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/disconnected_environments/index#oc-mirror-image-set-examples_installing-mirroring-disconnected[Imageset configuration examples]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]

{microshift-short} links::
* 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]
Original file line number Diff line number Diff line change
@@ -1,61 +1,35 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-operators-olm"]
= Using Operator Lifecycle Manager with {microshift-short}
= Using Operator Lifecycle Manager with MicroShift

include::_attributes/attributes-microshift.adoc[]
:context: microshift-operators-olm

toc::[]

The Operator Lifecycle Manager (OLM) package manager is used in {microshift-short} for installing and running optional link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/architecture/control-plane#olm-operators_control-plane[add-on Operators].

[id="microshift-olm-considerations_{context}"]
== Considerations for using OLM with {microshift-short}

* Cluster Operators as applied in {ocp} are not used in {microshift-short}.
* You must create your own catalogs for the add-on Operators you want to use with your applications. Catalogs are not provided by default.
** Each catalog must have an accessible `CatalogSource` added to a node, so that the OLM catalog Operator can use the catalog for content.
* You must use the CLI to conduct OLM activities with {microshift-short}. The console and OperatorHub GUIs are not available.
** Use the link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/cli_tools/opm-cli#cli-opm-install[Operator Package Manager `opm` CLI] with a network-connected node, or for building catalogs for custom Operators that use an internal registry.
** To mirror your catalogs and Operators for disconnected or offline nodes, install link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/disconnected_environments/index#installation-oc-mirror-installing-plugin_about-installing-oc-mirror-v2.

[IMPORTANT]
====
Before using an Operator, verify with the provider that the Operator is supported on {product-title}.
====
[role="_abstract"]
You can use Operator Lifecycle Manager (OLM) with {microshift-short} to install and run optional add-on Operators.

[id="microshift-installing-olm-options_{context}"]
== Determining your OLM installation type
You can install the OLM package manager for use with {microshift-short} 4.15 or newer versions. There are different ways to install OLM for a {microshift-short} node, depending on your use case.
include::modules/microshift-olm-considerations.adoc[leveloffset=+1]

* You can install the `microshift-olm` RPM at the same time you install the {microshift-short} RPM on {op-system-base-full}.
* You can install the `microshift-olm` on an existing {microshift-short} {product-version}. Restart the {microshift-short} service after installing OLM for the changes to apply.
See xref:../../microshift_install_rpm/microshift-install-rpm.adoc#microshift-install-rpms-olm_microshift-install-rpm[Installing the Operator Lifecycle Manager (OLM) from an RPM package].
* You can embed OLM in a {op-system-ostree-first} image. See xref:../../microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc#microshift-adding-olm-to-blueprint_microshift-embed-in-rpm-ostree[Adding the Operator Lifecycle Manager (OLM) service to a blueprint].
include::modules/microshift-installing-olm-options.adoc[leveloffset=+1]

include::modules/microshift-olm-namespaces.adoc[leveloffset=+1]

include::modules/microshift-olm-build-op-catalogs.adoc[leveloffset=+1]

//additional resources for building catalogs module
[role="_additional-resources"]
.Additional resources
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/cli_tools/opm-cli[`opm` CLI reference]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-about-catalogs_olm-rh-catalogs[About Operator catalogs]
* To create file-based catalogs by using the `opm` CLI, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-managing-custom-catalogs[Managing custom catalogs]

include::modules/microshift-olm-deploy-ops-con.adoc[leveloffset=+1]

//additional resources for deploying operators concept module
[role="_additional-resources"]
.Additional resources
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-operatorgroups-membership_olm-understanding-operatorgroups[Operator group membership]

include::modules/microshift-olm-deploy-ops-global-ns.adoc[leveloffset=+2]

include::modules/microshift-olm-deploy-ops-spec-ns.adoc[leveloffset=+2]

//additional resources for working with operators after deployment
[id="Additional-resources_microshift-operators-oc-mirror_{context}"]
[role="_additional-resources"]
.Additional resources
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-upgrading-operators[Updating installed Operators]
== Additional resources

* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/operators/understanding-operators#operator-lifecycle-manager-olm[Operator Lifecycle Manager]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-about-catalogs_olm-rh-catalogs[About Operator catalogs]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-operatorgroups-membership_olm-understanding-operatorgroups[Operator group membership]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-deleting-operator-from-a-cluster-using-cli_olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster using the CLI]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/operators/administrator-tasks#olm-managing-custom-catalogs-fb[Managing custom catalogs]
Original file line number Diff line number Diff line change
@@ -1,30 +1,14 @@
:_mod-docs-content-type: ASSEMBLY
[id="operators-with-microshift"]
[id="microshift-operators"]
= Using Operators with {microshift-short}
include::_attributes/attributes-microshift.adoc[]
:context: operators-microshift
:context: microshift-operators

toc::[]

You can use Operators with {microshift-short} to create applications that monitor the running services in your node. Operators can manage applications and their resources, such as deploying a database or message bus. As customized software running inside your node, Operators can be used to implement and automate common operations.
[role="_abstract"]
You can use Operators with {microshift-short} to create applications that monitor the running services in your node. As customized software running inside your node, you can use Operators to implement and automate common operations.

Operators offer a more localized configuration experience and integrate with Kubernetes APIs and CLI tools such as `kubectl` and `oc`. Operators are designed specifically for your applications. Operators enable you to configure components instead of modifying a global configuration file.
include::modules/microshift-about-using-operators.adoc[leveloffset=+1]

{microshift-short} applications are generally expected to be deployed in static environments. However, Operators are available if helpful in your use case. To determine the compatibility of an Operator with {microshift-short}, check the Operator documentation.

[id="microshift-operators-installation-paths_{context}"]
== How to use Operators with a {microshift-short} node

There are two ways to use Operators for your {microshift-short} node:

[id="microshift-operators-paths-manifests_{context}"]
=== Manifests for Operators
Operators can be installed and managed directly by using manifests. You can use the `kustomize` configuration management tool with {microshift-short} to deploy an application. Use the same steps to install Operators with manifests.

* See xref:../../microshift_running_apps/microshift-applications.adoc#microshift-manifests-overview_applications-microshift[Using Kustomize manifests to deploy applications] and xref:../../microshift_running_apps/microshift-applications.adoc#microshift-applying-manifests-example_applications-microshift[Using manifests example] for details.

[id="microshift-operators-paths-olm_{context}"]
=== Operator Lifecycle Manager for Operators
You can also install add-on Operators to a {microshift-short} node by using Operator Lifecycle Manager (OLM). OLM can be used to manage both custom Operators and Operators that are widely available. Building catalogs is required to use OLM with {microshift-short}.

* For details, see xref:../../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}].
include::modules/microshift-operators-how-to-install-and-manage.adoc[leveloffset=+1]
14 changes: 14 additions & 0 deletions modules/microshift-about-using-operators.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
//Module included in the following assemblies:
//
//* microshift_running_apps/microshift_operators/microshift-operators.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-about-using-operators_{context}"]
= About using Operators with a {microshift-short} node

[role="_abstract"]
You can use Operators to manage applications and their resources, such as deploying a database or message bus.

Operators offer a more localized configuration experience and integrate with Kubernetes APIs and CLI tools such as `kubectl` and `oc`. You can design or use Operators that are specifically for your applications. By using Operators, you can configure components instead of modifying a global configuration file.

{microshift-short} applications are generally expected to be deployed in static environments. However, Operators are available if helpful in your use case. To discover whether an Operator is compatible with {microshift-short}, check the Operator documentation.
27 changes: 27 additions & 0 deletions modules/microshift-connectivity-pop-mirror-registry.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
//Module included in the following assemblies:
//
//* microshift_running_apps/microshift_operators/microshift-operators-oc-mirror.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-connectivity-pop-mirror-registry_{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 node to retrieve this content from your mirror registry.
Loading