mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
64 lines
4.7 KiB
Plaintext
64 lines
4.7 KiB
Plaintext
:_mod-docs-content-type: ASSEMBLY
|
|
[id="microshift-operators-olm"]
|
|
= Using Operator Lifecycle Manager with {microshift-short}
|
|
include::_attributes/attributes-microshift.adoc[]
|
|
:context: microshift-operators-olm
|
|
|
|
toc::[]
|
|
|
|
Operator Lifecycle Manager (OLM) is used in {microshift-short} for installing and running optional add-on Operators. See the following link for more information:
|
|
|
|
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/operators/understanding-operators#operator-lifecycle-manager-olm[Operator Lifecycle Manager]
|
|
|
|
[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.openshift.com/container-platform/{ocp-version}/installing/disconnected_install/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[the oc-mirror OpenShift CLI plugin].
|
|
|
|
[IMPORTANT]
|
|
====
|
|
Before using an Operator, verify with the provider that the Operator is supported on {product-title}.
|
|
====
|
|
|
|
[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.
|
|
|
|
* 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-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.openshift.com/container-platform/{ocp-version}/operators/understanding/olm-rh-catalogs.html#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.openshift.com/container-platform/{ocp-version}/operators/understanding/olm/olm-understanding-operatorgroups.html#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
|
|
[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]
|
|
* 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]
|