Skip to content

Commit 3600a32

Browse files
authored
Merge pull request #71069 from rohennes/TELCODOCS-1724
TELCODOCS-1724: Adding OLM cluster capability
2 parents 21acd41 + 3aeea66 commit 3600a32

File tree

3 files changed

+55
-2
lines changed

3 files changed

+55
-2
lines changed

installing/cluster-capabilities.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,13 @@ include::modules/operator-marketplace.adoc[leveloffset=+2]
9191
.Additional resources
9292
* xref:../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Red Hat-provided Operator catalogs]
9393
94+
// OperatorLifecycleManager capability
95+
include::modules/olm-overview.adoc[leveloffset=+2]
96+
97+
[role="_additional-resources"]
98+
.Additional resources
99+
* xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources]
100+
94101
// Node Tuning capability
95102
include::modules/node-tuning-operator.adoc[leveloffset=+2]
96103

modules/olm-overview.adoc

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,37 @@
11
// Module included in the following assemblies:
22
//
3+
// * installing/cluster-capabilities.adoc
34
// * operators/understanding/olm/olm-understanding-olm.adoc
45
// * operators/operator-reference.adoc
56

7+
ifeval::["{context}" == "cluster-operators-ref"]
8+
:operators:
9+
endif::[]
10+
ifeval::["{context}" == "cluster-capabilities"]
11+
:cluster-caps:
12+
endif::[]
13+
14+
15+
:_mod-docs-content-type: CONCEPT
616
[id="olm-overview_{context}"]
7-
ifeval::["{context}" != "cluster-operators-ref"]
17+
ifndef::operators[]
18+
ifndef::cluster-caps[]
819
= What is Operator Lifecycle Manager?
920
endif::[]
10-
ifeval::["{context}" == "cluster-operators-ref"]
21+
endif::[]
22+
ifdef::operators[]
1123
= Purpose
1224
endif::[]
25+
ifdef::cluster-caps[]
26+
= Operator Lifecycle Manager capability
27+
28+
[discrete]
29+
== Purpose
30+
endif::[]
1331

1432
_Operator Lifecycle Manager_ (OLM) helps users install, update, and manage the lifecycle of Kubernetes native applications (Operators) and their associated services running across their {product-title} clusters. It is part of the link:https://operatorframework.io/[Operator Framework], an open source toolkit designed to manage Operators in an effective, automated, and scalable way.
1533

34+
ifndef::cluster-caps[]
1635
.Operator Lifecycle Manager workflow
1736
image::olm-workflow.png[]
1837

@@ -33,3 +52,27 @@ endif::openshift-dedicated,openshift-rosa[]
3352
to install Operators, as well as grant specific projects access to use the catalog of Operators available on the cluster.
3453

3554
For developers, a self-service experience allows provisioning and configuring instances of databases, monitoring, and big data services without having to be subject matter experts, because the Operator has that knowledge baked into it.
55+
endif::[]
56+
57+
ifdef::cluster-caps[]
58+
If an Operator requires any of the following APIs, then you must enable the `OperatorLifecycleManager` capability:
59+
60+
* `ClusterServiceVersion`
61+
* `CatalogSource`
62+
* `Subscription`
63+
* `InstallPlan`
64+
* `OperatorGroup`
65+
66+
[IMPORTANT]
67+
====
68+
The `marketplace` capability depends on the `OperatorLifecycleManager` capability. You cannot disable the `OperatorLifecycleManager` capability and enable the `marketplace` capability.
69+
====
70+
endif::[]
71+
72+
ifeval::["{context}" == "cluster-operators-ref"]
73+
:!operators:
74+
endif::[]
75+
76+
ifeval::["{context}" == "cluster-caps"]
77+
:!cluster-caps:
78+
endif::[]

snippets/capabilities-table.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ The following table describes the `baselineCapabilitySet` values.
2222
|`v4.14`
2323
|Specify this option when you want to enable the default capabilities for {product-title} 4.14. By specifying `v4.14`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.14 are `baremetal`, `MachineAPI`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage`, `CSISnapshot`, `NodeTuning`, `ImageRegistry`, `Build`, and `DeploymentConfig`.
2424

25+
|`v4.15`
26+
|Specify this option when you want to enable the default capabilities for {product-title} 4.15. By specifying `v4.15`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.15 are `baremetal`, `MachineAPI`, `marketplace`, `OperatorLifecycleManager`, `openshift-samples`, `Console`, `Insights`, `Storage`, `CSISnapshot`, `NodeTuning`, `ImageRegistry`, `Build`, and `DeploymentConfig`.
27+
2528
|`None`
2629
|Specify when the other sets are too large, and you do not need any capabilities or want to fine-tune via `additionalEnabledCapabilities`.
2730

0 commit comments

Comments
 (0)