Skip to content

Commit 52da949

Browse files
darshan-nagarajdarshan-nagaraj
committed
OSDOCS-3789: Adds cluster capabilities section
1 parent dcb4c1c commit 52da949

File tree

5 files changed

+160
-0
lines changed

5 files changed

+160
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,8 @@ Topics:
502502
File: configuring-alert-notifications
503503
- Name: Converting a connected cluster to a disconnected cluster
504504
File: connected-to-disconnected
505+
- Name: Cluster capabilities
506+
File: cluster-capabilities
505507
---
506508
Name: Updating clusters
507509
Dir: updating

‎modules/enabling-additional-enabled-capabilities.adoc

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
// Module included in the following assemblies:
2+
//
3+
// *post_installation_configuration/cluster-capabilities.adoc
4+
5+
[id="setting_additional_enabled_capabilities_{context}"]
6+
= Enabling the cluster capabilities by setting additional enabled capabilities
7+
8+
As a cluster administrator, you can enable the cluster capabilities by setting `additionalEnabledCapabilities`.
9+
10+
.Prerequisites
11+
12+
* You have installed the OpenShift CLI (`oc`).
13+
14+
.Procedure
15+
16+
. View the additional enabled capabilities by running the following command:
17+
+
18+
[source,terminal]
19+
----
20+
$ oc get clusterversion version -o jsonpath='{.spec.capabilities.additionalEnabledCapabilities}{"\n"}'
21+
----
22+
23+
+
24+
.Example output
25+
[source,terminal]
26+
----
27+
["openshift-samples"]
28+
----
29+
30+
. To set the `additionalEnabledCapabilities`, run the following command:
31+
+
32+
[source,terminal]
33+
----
34+
$ oc patch clusterversion/version --type merge -p '{"spec":{"capabilities":{"additionalEnabledCapabilities":["openshift-samples", "marketplace"]}}}'
35+
----
36+
37+
[IMPORTANT]
38+
====
39+
It is not possible to disable a capability which is already enabled in a cluster. The cluster version Operator (CVO) continues to reconcile the capability which is already enabled in the cluster.
40+
====
41+
42+
43+
If you try to disable a capability, then CVO shows the divergent spec:
44+
[source,terminal]
45+
----
46+
$ oc get clusterversion version -o jsonpath='{.status.conditions[?(@.type=="ImplicitlyEnabledCapabilities")]}{"\n"}'
47+
----
48+
49+
.Example output
50+
[source,terminal]
51+
----
52+
{"lastTransitionTime":"2022-07-22T03:14:35Z","message":"The following capabilities could not be disabled: openshift-samples","reason":"CapabilitiesImplicitlyEnabled","status":"True","type":"ImplicitlyEnabledCapabilities"}
53+
----
54+
55+
[NOTE]
56+
====
57+
During the cluster upgrades, it is possible that a given capability could be implicitly enabled. If a resource was already running on the cluster before the upgrade, then any capabilities that is part of the resource will be enabled. For example, during a cluster upgrade, a resource that is already running on the cluster has been changed to be part of the `marketplace` capability by the system. Even if a cluster administrator does not explicitly enabled the `marketplace` capability, it is implicitly enabled by the system.
58+
====

‎modules/enabling-baseline-capability-set.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Module included in the following assemblies:
2+
//
3+
// *post_installation_configuration/cluster-capabilities.adoc
4+
5+
[id="setting_baseline_capability_set_{context}"]
6+
= Enabling the cluster capabilities by setting baseline capability set
7+
8+
As a cluster administrator, you can enable the capabilities by setting `baselineCapabilitySet`.
9+
10+
.Prerequisites
11+
12+
* You have installed the OpenShift CLI (`oc`).
13+
14+
.Procedure
15+
16+
* To set the `baselineCapabilitySet`, run the following command:
17+
+
18+
[source,terminal]
19+
----
20+
$ oc patch clusterversion version --type merge -p '{"spec":{"capabilities":{"baselineCapabilitySet":"vCurrent"}}}' <1>
21+
----
22+
+
23+
<1> For `baselineCapabilitySet` you can specify `vCurrent`, `v4.11`, or `none`.
24+
+
25+
The following table describes the `baselineCapabilitySet` values.
26+
+
27+
.Cluster capabilities `baselineCapabilitySet` values description
28+
[cols=".^4,.^6a",options="header"]
29+
|===
30+
|Value|Description
31+
32+
|`vCurrent`
33+
|Specify when you want to automatically add new capabilities as they become recommended.
34+
35+
|`v4.11`
36+
|Specify when you want the capabilities defined in {product-title} 4.11 and not automatically enable capabilities, which might be introduced in later versions.
37+
38+
|`none`
39+
|Specify when the other sets are too large, and you do not need any capabilities or want to fine-tune via `additionalEnabledCapabilities`.
40+
41+
|===

‎modules/viewing-cluster-capabilities.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// Module included in the following assemblies:
2+
//
3+
// *post_installation_configuration/cluster-capabilities.adoc
4+
5+
[id="viewing_the_cluster_capabilities_{context}"]
6+
= Viewing the cluster capabilities
7+
As a cluster administrator, you can view the capabilities by using the `clusterversion` resource status.
8+
9+
.Prerequisites
10+
11+
* You have installed the OpenShift CLI (`oc`).
12+
13+
.Procedure
14+
15+
* To view the status of the cluster capabilities, run the following command:
16+
+
17+
[source,terminal]
18+
----
19+
$ oc get clusterversion version -o jsonpath='{.spec.capabilities}{"\n"}{.status.capabilities}{"\n"}'
20+
----
21+
22+
+
23+
.Example output
24+
[source,terminal]
25+
----
26+
{"additionalEnabledCapabilities":["openshift-samples"],"baselineCapabilitySet":"None"}
27+
{"enabledCapabilities":["openshift-samples"],"knownCapabilities":["baremetal","marketplace","openshift-samples"]}
28+
----

‎post_installation_configuration/cluster-capabilities.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
:_content-type: ASSEMBLY
2+
[id="cluster-capabilities"]
3+
= Cluster capabilities
4+
include::_attributes/common-attributes.adoc[]
5+
:context: cluster-capabilities
6+
7+
toc::[]
8+
9+
Cluster administrators can use the cluster capabilities to select or deselect one or more optional components prior to installation and also enable a cluster capability anytime post installation.
10+
11+
[NOTE]
12+
====
13+
If cluster capability has been enabled before, it cannot be disabled.
14+
====
15+
16+
include::modules/viewing-cluster-capabilities.adoc[leveloffset=+1]
17+
18+
include::modules/enabling-baseline-capability-set.adoc[leveloffset=+1]
19+
20+
[role="_additional-resources"]
21+
.Additional resources
22+
23+
The following are the capabilities defined in `v4.11`:
24+
25+
* xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install[Bare metal]
26+
27+
* xref:../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Marketplace]
28+
29+
* xref:../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[OpenShift-samples]
30+
31+
include::modules/enabling-additional-enabled-capabilities.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)