Merge pull request #81632 from abrennan89/OSDOCS-11973

abrennan89 · web-flow · commit faf4bd3bf570 · 2024-09-24T10:27:40.000-05:00
OSDOCS-11973: Move cluster capabilities section from postinstallation docs
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -688,9 +688,6 @@ Topics:
   File: configuring-alert-notifications
 - Name: Converting a connected cluster to a disconnected cluster
   File: converting-to-disconnected
-- Name: Enabling cluster capabilities
-  File: enabling-cluster-capabilities
-  Distros: openshift-origin,openshift-enterprise
 ---
 Name: Updating clusters
 Dir: updating
diff --git a/applications/connecting_applications_to_services/installing-sbo.adoc b/applications/connecting_applications_to_services/installing-sbo.adoc
@@ -17,7 +17,7 @@ You can install {servicebinding-title} on {product-title} 4.7 and later.
 
 * You have access to an {product-title} cluster using an account with `cluster-admin` permissions.
 ifndef::openshift-rosa,openshift-dedicated[]
-* Your cluster has the xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc#enabling-cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually.
+* Your cluster has the xref:../../installing/overview/cluster-capabilities.adoc#operator-marketplace_cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually.
 endif::openshift-rosa,openshift-dedicated[]
 
 //Installing Service Binding Operator using web console
@@ -28,4 +28,3 @@ include::modules/op-installing-sbo-operator-using-the-web-console.adoc[leveloffs
 == Additional resources
 
 * xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
-
diff --git a/installing/installing_bare_metal/installing-bare-metal.adoc b/installing/installing_bare_metal/installing-bare-metal.adoc
@@ -138,10 +138,9 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
 .Additional resources
 
 * See xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure] for more information on the API and application ingress load balancing requirements.
-* See xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc[Enabling cluster capabilities] for more information on enabling cluster capabilities that were disabled prior to installation.
+* See xref:../../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] for more information on enabling cluster capabilities that were disabled before installation.
 * See xref:../../installing/overview/cluster-capabilities.adoc#explanation_of_capabilities_cluster-capabilities[Optional cluster capabilities in {product-title} {product-version}] for more information about the features provided by each capability.
 
-
 include::modules/installation-configure-proxy.adoc[leveloffset=+2]
 
 include::modules/installation-three-node-cluster.adoc[leveloffset=+2]
diff --git a/installing/installing_sno/install-sno-installing-sno.adoc b/installing/installing_sno/install-sno-installing-sno.adoc
@@ -77,7 +77,7 @@ include::modules/install-sno-generating-the-install-iso-manually.adoc[leveloffse
 .Additional resources
 
 * See xref:../../installing/installing_sno/install-sno-preparing-to-install-sno.adoc#preparing-to-install-sno[Requirements for installing OpenShift on a single node] for more information about installing {product-title} on a single node.
-* See xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc[Enabling cluster capabilities] for more information about enabling cluster capabilities that were disabled prior to installation.
+* See xref:../../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] for more information about enabling cluster capabilities that were disabled before installation.
 * See xref:../../installing/overview/cluster-capabilities.adoc#explanation_of_capabilities_cluster-capabilities[Optional cluster capabilities in {product-title} {product-version}] for more information about the features provided by each capability.
 
 include::modules/install-sno-monitoring-the-installation-manually.adoc[leveloffset=+2]
diff --git a/installing/overview/cluster-capabilities.adoc b/installing/overview/cluster-capabilities.adoc
@@ -13,8 +13,7 @@ Cluster administrators can use cluster capabilities to enable or disable optiona
 Cluster administrators cannot disable a cluster capability after it is enabled.
 ====
 
-include::modules/selecting-cluster-capabilities.adoc[leveloffset=+1]
-
+include::modules/enabling-cluster-capabilities.adoc[leveloffset=+1]
 include::snippets/capabilities-table.adoc[]
 
 [role="_additional-resources"]
@@ -126,7 +125,8 @@ include::modules/cluster-image-registry-operator.adoc[leveloffset=+2]
 * xref:../../registry/configuring-registry-operator.adoc#configuring-registry-operator[Image Registry Operator in {product-title}]
 * xref:../../nodes/pods/nodes-pods-secrets.adoc#auto-generated-sa-token-secrets_nodes-pods-secrets[Automatically generated secrets]
 
-[role="_additional-resources"]
-[id="additional-resources_{context}"]
-== Additional resources
-* xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc#enabling-cluster-capabilities[Enabling cluster capabilities after installation]
+include::modules/viewing-cluster-capabilities.adoc[leveloffset=+1]
+
+include::modules/enabling-baseline-capability-set.adoc[leveloffset=+1]
+
+include::modules/enabling-additional-enabled-capabilities.adoc[leveloffset=+1]
diff --git a/modules/enabling-additional-enabled-capabilities.adoc b/modules/enabling-additional-enabled-capabilities.adoc
@@ -1,15 +1,16 @@
 // Module included in the following assemblies:
 //
-// *post_installation_configuration/cluster-capabilities.adoc
+// * installing/overview/cluster-capabilities.adoc
 
-[id="setting_additional_enabled_capabilities_{context}"]
+:_mod-docs-content-type: PROCEDURE
+[id="enabling-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`.
+As a cluster administrator, you can enable cluster capabilities any time after a {product-title} installation by setting the `additionalEnabledCapabilities` configuration parameter.
 
 .Prerequisites
 
-* You have installed the OpenShift CLI (`oc`).
+* You have installed the {oc-first}.
 
 .Procedure
 
@@ -19,15 +20,14 @@ As a cluster administrator, you can enable the cluster capabilities by setting `
 ----
 $ oc get clusterversion version -o jsonpath='{.spec.capabilities.additionalEnabledCapabilities}{"\n"}'
 ----
-
 +
 .Example output
 [source,terminal]
 ----
 ["openshift-samples"]
 ----
 
-. To set the `additionalEnabledCapabilities`, run the following command:
+. To set the `additionalEnabledCapabilities` configuration parameter, run the following command:
 +
 [source,terminal]
 ----
diff --git a/modules/enabling-baseline-capability-set.adoc b/modules/enabling-baseline-capability-set.adoc
@@ -1,25 +1,23 @@
 // Module included in the following assemblies:
 //
-// *post_installation_configuration/cluster-capabilities.adoc
+// * installing/overview/cluster-capabilities.adoc
 
-[id="setting_baseline_capability_set_{context}"]
+:_mod-docs-content-type: PROCEDURE
+[id="enabling-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`.
+As a cluster administrator, you can enable cluster capabilities any time after a {product-title} installation by setting the `baselineCapabilitySet` configuration parameter.
 
 .Prerequisites
 
-* You have installed the OpenShift CLI (`oc`).
+* You have installed the {oc-first}.
 
 .Procedure
 
-* To set the `baselineCapabilitySet`, run the following command:
+* To set the `baselineCapabilitySet` configuration parameter, 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`, `v{product-version}`, or `None`.
-
-include::snippets/capabilities-table.adoc[]
diff --git a/modules/enabling-cluster-capabilities.adoc b/modules/enabling-cluster-capabilities.adoc
@@ -0,0 +1,39 @@
+// Module included in the following assemblies:
+//
+// * installing/overview/cluster-capabilities.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="enabling-cluster-capabilities_{context}"]
+= Enabling cluster capabilities
+
+If you are using an installation method that includes customizing your cluster by creating an `install-config.yaml` file, you can select which cluster capabilities you want to make available on the cluster.
+
+[NOTE]
+====
+If you customize your cluster by enabling or disabling specific cluster capabilities, you must manually maintain your `install-config.yaml` file. New {product-title} updates might declare new capability handles for existing components, or introduce new components altogether. Users who customize their `install-config.yaml` file should consider periodically updating their `install-config.yaml` file as {product-title} is updated.
+====
+
+You can use the following configuration parameters to select cluster capabilities:
+
+[source,yaml]
+----
+capabilities:
+  baselineCapabilitySet: v4.11 <1>
+  additionalEnabledCapabilities: <2>
+  - CSISnapshot
+  - Console
+  - Storage
+----
+<1> Defines a baseline set of capabilities to install. Valid values are `None`, `vCurrent` and `v4.x`. If you select `None`, all optional capabilities are disabled. The default value is `vCurrent`, which enables all optional capabilities.
++
+[NOTE]
+====
+`v4.x` refers to any value up to and including the current cluster version.
+For example, valid values for a {product-title} 4.12 cluster are `v4.11` and `v4.12`.
+====
+<2> Defines a list of capabilities to explicitly enable. These capabilities are enabled in addition to the capabilities specified in `baselineCapabilitySet`.
++
+[NOTE]
+====
+In this example, the default capability is set to `v4.11`. The `additionalEnabledCapabilities` field enables additional capabilities over the default `v4.11` capability set.
+====
diff --git a/modules/selecting-cluster-capabilities.adoc b/modules/selecting-cluster-capabilities.adoc
diff --git a/modules/viewing-cluster-capabilities.adoc b/modules/viewing-cluster-capabilities.adoc
@@ -1,14 +1,16 @@
 // Module included in the following assemblies:
 //
-// *post_installation_configuration/cluster-capabilities.adoc
+// * installing/overview/cluster-capabilities.adoc
 
-[id="viewing_the_cluster_capabilities_{context}"]
+:_mod-docs-content-type: PROCEDURE
+[id="viewing-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`).
+* You have installed the {oc-first}.
 
 .Procedure
 
@@ -18,7 +20,6 @@ As a cluster administrator, you can view the capabilities by using the `clusterv
 ----
 $ oc get clusterversion version -o jsonpath='{.spec.capabilities}{"\n"}{.status.capabilities}{"\n"}'
 ----
-
 +
 .Example output
 [source,terminal]
diff --git a/post_installation_configuration/configuring-multi-arch-compute-machines/multi-architecture-configuration.adoc b/post_installation_configuration/configuring-multi-arch-compute-machines/multi-architecture-configuration.adoc
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-An {product-title} cluster with multi-architecture compute machines is a cluster that supports compute machines with different architectures. 
+An {product-title} cluster with multi-architecture compute machines is a cluster that supports compute machines with different architectures.
 
 [NOTE]
 ====
@@ -15,7 +15,7 @@ When there are nodes with multiple architectures in your cluster, the architectu
 
 [IMPORTANT]
 ====
-The Cluster Samples Operator is not supported on clusters with multi-architecture compute machines. Your cluster can be created without this capability. For more information, see xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc#enabling-cluster-capabilities[Enabling cluster capabilities]
+The Cluster Samples Operator is not supported on clusters with multi-architecture compute machines. Your cluster can be created without this capability. For more information, see xref:../../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities].
 ====
 
 For information on migrating your single-architecture cluster to a cluster that supports multi-architecture compute machines, see xref:../../updating/updating_a_cluster/migrating-to-multi-payload.adoc#migrating-to-multi-payload[Migrating to a cluster with multi-architecture compute machines].
@@ -33,28 +33,28 @@ To create a cluster with multi-architecture compute machines with different inst
 |Microsoft Azure
 |
 |&#10003;
-|`aarch64` or `x86_64` 
+|`aarch64` or `x86_64`
 |`aarch64`, `x86_64`
 
 |xref:../../post_installation_configuration/configuring-multi-arch-compute-machines/creating-multi-arch-compute-nodes-aws.adoc#creating-multi-arch-compute-nodes-aws[Creating a cluster with multi-architecture compute machines on AWS]
 |Amazon Web Services (AWS)
 |
 |&#10003;
-|`aarch64` or `x86_64` 
+|`aarch64` or `x86_64`
 |`aarch64`, `x86_64`
 
 |xref:../../post_installation_configuration/configuring-multi-arch-compute-machines/creating-multi-arch-compute-nodes-gcp.adoc#creating-multi-arch-compute-nodes-gcp[Creating a cluster with multi-architecture compute machines on GCP]
 |Google Cloud Platform (GCP)
 |
 |&#10003;
-|`aarch64` or `x86_64` 
+|`aarch64` or `x86_64`
 |`aarch64`, `x86_64`
 
 .3+|xref:../../post_installation_configuration/configuring-multi-arch-compute-machines/creating-multi-arch-compute-nodes-bare-metal.adoc#creating-multi-arch-compute-nodes-bare-metal[Creating a cluster with multi-architecture compute machines on bare metal, {ibm-power-title}, or {ibm-z-title}]
 |Bare metal
 |&#10003;
 |
-|`aarch64` or `x86_64` 
+|`aarch64` or `x86_64`
 |`aarch64`, `x86_64`
 
 |{ibm-power-title}
diff --git a/post_installation_configuration/enabling-cluster-capabilities.adoc b/post_installation_configuration/enabling-cluster-capabilities.adoc
diff --git a/rosa_architecture/index.adoc b/rosa_architecture/index.adoc
@@ -229,7 +229,7 @@ Manage machines, provide services to users, and follow monitoring and logging re
 
 - **xref:../architecture/architecture.adoc#architecture-overview-architecture[Understand {product-title} management]**: Learn about components of the {product-title} {product-version} control plane. See how {product-title} control plane and compute nodes are managed and updated through the xref:../machine_management/index.adoc#machine-api-overview_overview-of-machine-management[Machine API] and xref:../architecture/control-plane.adoc#operators-overview_control-plane[Operators].
 
-- **xref:../post_installation_configuration/enabling-cluster-capabilities.adoc#enabling-cluster-capabilities[Enable cluster capabilities]**: As a cluster administrator, you can enable cluster capabilities that were disabled prior to installation.
+- **xref:../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities]**: As a cluster administrator, you can enable cluster capabilities that were disabled before installation.
 
 === Manage cluster components
 
diff --git a/welcome/index.adoc b/welcome/index.adoc
@@ -229,7 +229,7 @@ Manage machines, provide services to users, and follow monitoring and logging re
 
 - **xref:../architecture/architecture.adoc#architecture-overview-architecture[Understand {product-title} management]**: Learn about components of the {product-title} {product-version} control plane. See how {product-title} control plane and compute nodes are managed and updated through the xref:../machine_management/index.adoc#machine-api-overview_overview-of-machine-management[Machine API] and xref:../architecture/control-plane.adoc#operators-overview_control-plane[Operators].
 
-- **xref:../post_installation_configuration/enabling-cluster-capabilities.adoc#enabling-cluster-capabilities[Enable cluster capabilities]**: As a cluster administrator, you can enable cluster capabilities that were disabled prior to installation.
+- **xref:../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities]**: As a cluster administrator, you can enable cluster capabilities that were disabled before installation.
 
 === Manage cluster components
 
