You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can use OLM-based Operators in disconnected situations by embedding them in a {op-system-ostree-first} image.
10
+
[role="_abstract"]
11
+
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.
//additional resources for embedding operators into rhel for edge disconnected
15
-
[role="_additional-resources"]
16
-
.Additional resources
17
-
* 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]
18
-
* 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]
19
-
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-networking-disconnected-hosts[Configuring network settings for fully disconnected hosts]
* 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]
28
+
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-networking-disconnected-hosts[Configuring network settings for fully disconnected hosts]
== Using Red Hat-provided Operator catalogs and mirror registries
13
-
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."
14
-
15
-
//additional resources for deploying operators in disconnected environments
16
-
[role="_additional-resources"]
17
-
.Additional resources
18
-
* 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]
19
-
* 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]
20
-
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts]
21
-
* 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]
22
-
* 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]
10
+
[role="_abstract"]
11
+
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.
//additional resources for microshift mirror to mirror module
48
-
[role="_additional-resources"]
49
-
.Additional resources
50
-
* 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]
51
-
* 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]
52
-
53
28
//Convert the imageset file and add configuration to CRI-O
* 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]
40
+
41
+
{microshift-short} links::
63
42
* xref:../../microshift_networking/microshift-disconnected-network-config.adoc#microshift-disconnected-network-config[Configuring network settings for fully disconnected hosts]
64
43
* xref:../../microshift_install_get_ready/microshift-deploy-with-mirror-registry.adoc#microshift-deploy-with-mirror-registry[Mirroring container images for disconnected installations]
65
44
* 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]
= Using Operator Lifecycle Manager with {microshift-short}
3
+
= Using Operator Lifecycle Manager with MicroShift
4
+
4
5
include::_attributes/attributes-microshift.adoc[]
5
6
:context: microshift-operators-olm
6
7
7
8
toc::[]
8
9
9
-
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].
10
-
11
-
[id="microshift-olm-considerations_{context}"]
12
-
== Considerations for using OLM with {microshift-short}
13
-
14
-
* Cluster Operators as applied in {ocp} are not used in {microshift-short}.
15
-
* You must create your own catalogs for the add-on Operators you want to use with your applications. Catalogs are not provided by default.
16
-
** Each catalog must have an accessible `CatalogSource` added to a node, so that the OLM catalog Operator can use the catalog for content.
17
-
* You must use the CLI to conduct OLM activities with {microshift-short}. The console and OperatorHub GUIs are not available.
18
-
** 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.
19
-
** 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.
20
-
21
-
[IMPORTANT]
22
-
====
23
-
Before using an Operator, verify with the provider that the Operator is supported on {product-title}.
24
-
====
10
+
[role="_abstract"]
11
+
You can use Operator Lifecycle Manager (OLM) with {microshift-short} to install and run optional add-on Operators.
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.
* You can install the `microshift-olm` RPM at the same time you install the {microshift-short} RPM on {op-system-base-full}.
31
-
* 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.
32
-
See xref:../../microshift_install_rpm_opt/microshift-install-optional-rpms.adoc#microshift-install-rpms-olm_microshift-install-optional-rpms[Installing the Operator Lifecycle Manager (OLM) from an RPM package].
33
-
* 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].
* 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]
//additional resources for deploying operators concept module
49
-
[role="_additional-resources"]
50
-
.Additional resources
51
-
* 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-single/operators/index#olm-operatorgroups-membership_olm-understanding-operatorgroups[Operator group membership]
61
34
* 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]
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.
9
+
[role="_abstract"]
10
+
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.
10
11
11
-
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.
{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.
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.
23
-
24
-
* 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.
25
-
26
-
[id="microshift-operators-paths-olm_{context}"]
27
-
=== Operator Lifecycle Manager for Operators
28
-
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}.
29
-
30
-
* For details, see xref:../../microshift_running_apps/microshift_operators/microshift-operators-olm.adoc#microshift-operators-olm[Using Operator Lifecycle Manager with {microshift-short}].
= About using Operators with a {microshift-short} node
8
+
9
+
[role="_abstract"]
10
+
You can use Operators to manage applications and their resources, such as deploying a database or message bus.
11
+
12
+
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.
13
+
14
+
{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.
= Connectivity considerations when populating a mirror registry
8
+
9
+
When you populate your registry, you can use one of following connectivity scenarios:
10
+
11
+
Connected mirroring::
12
+
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.
13
+
14
+
Disconnected mirroring::
15
+
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.
16
+
+
17
+
[IMPORTANT]
18
+
====
19
+
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.
20
+
====
21
+
22
+
To avoid problems caused by an unreachable registry, use the following standard practices:
23
+
24
+
* Run mirror registries in a highly available way.
25
+
* Ensure that the mirror registry at least matches the production availability of your clusters.
26
+
27
+
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.
0 commit comments