1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/olmv1-clusteroperator.adoc
2025-07-31 16:46:35 +00:00

63 lines
2.4 KiB
Plaintext

// Module included in the following assemblies:
//
// * operators/operator-reference.adoc
// * installing/overview/cluster-capabilities.adoc
ifeval::["{context}" == "operator-reference"]
:operators:
endif::[]
ifeval::["{context}" == "cluster-capabilities"]
:cluster-caps:
endif::[]
:_mod-docs-content-type: CONCEPT
[id="cluster-operators-ref-olmv1_{context}"]
ifdef::operators[]
= {olmv1-first} Operator
endif::[]
ifdef::cluster-caps[]
= {olmv1-first} capability
endif::[]
ifdef::cluster-caps[]
{olmv1} provides the features for the `OperatorLifecycleManagerV1` capability.
endif::[]
Starting in {product-title} 4.18, {olmv1} is enabled by default alongside {olmv0}. This next-generation iteration provides an updated framework that evolves many of {olmv0} concepts that enable cluster administrators to extend capabilities for their users.
{olmv1} manages the lifecycle of the new `ClusterExtension` object, which includes Operators via the `registry+v1` bundle format, and controls installation, upgrade, and role-based access control (RBAC) of extensions within a cluster.
In {product-title}, {olmv1} is provided by the `olm` cluster Operator.
[NOTE]
====
The `olm` cluster Operator informs cluster administrators if there are any installed extensions blocking cluster upgrade, based on their `olm.maxOpenShiftVersion` properties. For more information, see "Compatibility with {product-title} versions".
====
[discrete]
== Components
{olmv1-first} comprises the following component projects:
Operator Controller:: The central component of {olmv1} that extends Kubernetes with an API through which users can install and manage the lifecycle of Operators and extensions. It consumes information from catalogd.
Catalogd:: A Kubernetes extension that unpacks file-based catalog (FBC) content packaged and shipped in container images for consumption by on-cluster clients. As a component of the {olmv1} microservices architecture, catalogd hosts metadata for Kubernetes extensions packaged by the authors of the extensions, and as a result helps users discover installable content.
[discrete]
== CRDs
* `clusterextension.olm.operatorframework.io`
** Scope: Cluster
** CR: `ClusterExtension`
* `clustercatalog.olm.operatorframework.io`
** Scope: Cluster
** CR: `ClusterCatalog`
[discrete]
== Project
* link:https://github.com/operator-framework/operator-controller[operator-framework/operator-controller]
* link:https://github.com/operator-framework/catalogd[operator-framework/catalogd]