diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 1ab70dff64..5cad20333c 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -502,6 +502,8 @@ Topics: File: configuring-alert-notifications - Name: Converting a connected cluster to a disconnected cluster File: connected-to-disconnected +- Name: Cluster capabilities + File: cluster-capabilities --- Name: Updating clusters Dir: updating diff --git a/modules/enabling-additional-enabled-capabilities.adoc b/modules/enabling-additional-enabled-capabilities.adoc new file mode 100644 index 0000000000..3f20ee5b09 --- /dev/null +++ b/modules/enabling-additional-enabled-capabilities.adoc @@ -0,0 +1,58 @@ +// Module included in the following assemblies: +// +// *post_installation_configuration/cluster-capabilities.adoc + +[id="setting_additional_enabled_capabilities_{context}"] += Enabling the cluster capabilities by setting additional enabled capabilities + +As a cluster administrator, you can enable the cluster capabilities by setting `additionalEnabledCapabilities`. + +.Prerequisites + +* You have installed the OpenShift CLI (`oc`). + +.Procedure + +. View the additional enabled capabilities by running the following command: ++ +[source,terminal] +---- +$ oc get clusterversion version -o jsonpath='{.spec.capabilities.additionalEnabledCapabilities}{"\n"}' +---- + ++ +.Example output +[source,terminal] +---- +["openshift-samples"] +---- + +. To set the `additionalEnabledCapabilities`, run the following command: ++ +[source,terminal] +---- +$ oc patch clusterversion/version --type merge -p '{"spec":{"capabilities":{"additionalEnabledCapabilities":["openshift-samples", "marketplace"]}}}' +---- + +[IMPORTANT] +==== +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. +==== + + +If you try to disable a capability, then CVO shows the divergent spec: +[source,terminal] +---- +$ oc get clusterversion version -o jsonpath='{.status.conditions[?(@.type=="ImplicitlyEnabledCapabilities")]}{"\n"}' +---- + +.Example output +[source,terminal] +---- +{"lastTransitionTime":"2022-07-22T03:14:35Z","message":"The following capabilities could not be disabled: openshift-samples","reason":"CapabilitiesImplicitlyEnabled","status":"True","type":"ImplicitlyEnabledCapabilities"} +---- + +[NOTE] +==== +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. +==== diff --git a/modules/enabling-baseline-capability-set.adoc b/modules/enabling-baseline-capability-set.adoc new file mode 100644 index 0000000000..d75363adaa --- /dev/null +++ b/modules/enabling-baseline-capability-set.adoc @@ -0,0 +1,41 @@ +// Module included in the following assemblies: +// +// *post_installation_configuration/cluster-capabilities.adoc + +[id="setting_baseline_capability_set_{context}"] += Enabling the cluster capabilities by setting baseline capability set + +As a cluster administrator, you can enable the capabilities by setting `baselineCapabilitySet`. + +.Prerequisites + +* You have installed the OpenShift CLI (`oc`). + +.Procedure + +* To set the `baselineCapabilitySet`, run the following command: ++ +[source,terminal] +---- +$ oc patch clusterversion version --type merge -p '{"spec":{"capabilities":{"baselineCapabilitySet":"vCurrent"}}}' <1> +---- ++ +<1> For `baselineCapabilitySet` you can specify `vCurrent`, `v4.11`, or `none`. ++ +The following table describes the `baselineCapabilitySet` values. ++ +.Cluster capabilities `baselineCapabilitySet` values description +[cols=".^4,.^6a",options="header"] +|=== +|Value|Description + +|`vCurrent` +|Specify when you want to automatically add new capabilities as they become recommended. + +|`v4.11` +|Specify when you want the capabilities defined in {product-title} 4.11 and not automatically enable capabilities, which might be introduced in later versions. + +|`none` +|Specify when the other sets are too large, and you do not need any capabilities or want to fine-tune via `additionalEnabledCapabilities`. + +|=== diff --git a/modules/viewing-cluster-capabilities.adoc b/modules/viewing-cluster-capabilities.adoc new file mode 100644 index 0000000000..76969e945e --- /dev/null +++ b/modules/viewing-cluster-capabilities.adoc @@ -0,0 +1,28 @@ +// Module included in the following assemblies: +// +// *post_installation_configuration/cluster-capabilities.adoc + +[id="viewing_the_cluster_capabilities_{context}"] += Viewing the cluster capabilities +As a cluster administrator, you can view the capabilities by using the `clusterversion` resource status. + +.Prerequisites + +* You have installed the OpenShift CLI (`oc`). + +.Procedure + +* To view the status of the cluster capabilities, run the following command: ++ +[source,terminal] +---- +$ oc get clusterversion version -o jsonpath='{.spec.capabilities}{"\n"}{.status.capabilities}{"\n"}' +---- + ++ +.Example output +[source,terminal] +---- +{"additionalEnabledCapabilities":["openshift-samples"],"baselineCapabilitySet":"None"} +{"enabledCapabilities":["openshift-samples"],"knownCapabilities":["baremetal","marketplace","openshift-samples"]} +---- diff --git a/post_installation_configuration/cluster-capabilities.adoc b/post_installation_configuration/cluster-capabilities.adoc new file mode 100644 index 0000000000..304d13c1ee --- /dev/null +++ b/post_installation_configuration/cluster-capabilities.adoc @@ -0,0 +1,31 @@ +:_content-type: ASSEMBLY +[id="cluster-capabilities"] += Cluster capabilities +include::_attributes/common-attributes.adoc[] +:context: cluster-capabilities + +toc::[] + +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. + +[NOTE] +==== +If cluster capability has been enabled before, it cannot be disabled. +==== + +include::modules/viewing-cluster-capabilities.adoc[leveloffset=+1] + +include::modules/enabling-baseline-capability-set.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +The following are the capabilities defined in `v4.11`: + +* xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install[Bare metal] + +* xref:../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Marketplace] + +* xref:../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[OpenShift-samples] + +include::modules/enabling-additional-enabled-capabilities.adoc[leveloffset=+1]