Merge pull request #5954 from sbueringer/pr-cc-doc

📖 ClusterClass: restructure documentation

Author: k8s-ci-robot

docs/book/src/SUMMARY.md

@@ -20,8 +20,8 @@
         - [ClusterResourceSet](./tasks/experimental-features/cluster-resource-set.md)
         - [ClusterClass](./tasks/experimental-features/cluster-class/index.md)
             - [Writing a ClusterClass](./tasks/experimental-features/cluster-class/write-clusterclass.md)
-            - [Upgrading a Cluster](./tasks/experimental-features/cluster-class/upgrade-cluster.md)
             - [Changing a ClusterClass](./tasks/experimental-features/cluster-class/change-clusterclass.md)
+            - [Operating a managed Cluster](./tasks/experimental-features/cluster-class/operate-cluster.md)
         - [Ignition Bootstrap configuration](./tasks/experimental-features/ignition.md)
 - [clusterctl CLI](./clusterctl/overview.md)
     - [clusterctl Commands](clusterctl/commands/commands.md)
@@ -34,6 +34,8 @@
         - [upgrade](clusterctl/commands/upgrade.md)
         - [delete](clusterctl/commands/delete.md)
         - [completion](clusterctl/commands/completion.md)
+        - [alpha rollout](clusterctl/commands/alpha-rollout.md)
+        - [alpha topology plan](clusterctl/commands/alpha-topology-plan.md)
     - [clusterctl Configuration](clusterctl/configuration.md)
     - [clusterctl Provider Contract](clusterctl/provider-contract.md)
     - [clusterctl for Developers](clusterctl/developers.md)

docs/book/src/clusterctl/commands/alpha-topology-plan.md

@@ -0,0 +1,3 @@
+# clusterctl alpha topology plan
+
+**Under Construction**

docs/book/src/clusterctl/commands/commands.md

@@ -10,4 +10,4 @@
 * [`clusterctl delete`](delete.md)
 * [`clusterctl completion`](completion.md)
 * [`clusterctl alpha rollout`](alpha-rollout.md)
-* [`clusterctl config cluster` (deprecated)](config-cluster.md)
+* [`clusterctl alpha topology plan`](alpha-topology-plan.md)

docs/book/src/clusterctl/commands/config-cluster.md

@@ -8,15 +8,17 @@ ClusterClass is a powerful abstraction implemented on top of existing interfaces
 **Variable name to enable/disable the feature gate**: `CLUSTER_TOPOLOGY`
 
 Additional documentation:
+* Background information:  [ClusterClass and Managed Topologies CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/202105256-cluster-class-and-managed-topologies.md)
 * For ClusterClass authors:
-  * [Writing a ClusterClass](./write-clusterclass.md)
-  * Publishing a ClusterClass is documented in the [clusterctl Provider contract]
-* For Cluster operators:
-    * Creating a Cluster is documented in the [Quick Start guide]
-    * [Upgrading a Cluster](./upgrade-cluster.md)
+    * [Writing a ClusterClass](./write-clusterclass.md)
     * [Changing a ClusterClass](./change-clusterclass.md)
-* Additional background information can be found in the  [ClusterClass and Managed Topologies CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/202105256-cluster-class-and-managed-topologies.md)
+    * Publishing a ClusterClass for clusterctl usage: [clusterctl Provider contract]
+* For Cluster operators:
+    * Creating a Cluster: [Quick Start guide]
+    * [Operating a managed Cluster](./operate-cluster.md)
+    * Planning topology rollouts: [clusterctl alpha topology plan]
 
 <!-- links -->
 [Quick Start guide]: ../../../user/quick-start.md
 [clusterctl Provider contract]: ../../../clusterctl/provider-contract.md
+[clusterctl alpha topology plan]: ../../../clusterctl/commands/alpha-topology-plan.md

docs/book/src/tasks/experimental-features/cluster-class/index.md

@@ -1,4 +1,6 @@
-# Upgrade a Cluster using Managed Topology
+# Operating a managed Cluster
+
+## Upgrade the Cluster
 
 The `spec.topology` field added to the Cluster object as part of ClusterClass allows changes made on the Cluster to be propagated across all relevant objects. This turns a Kubernetes cluster upgrade into a one-touch operation.
 Let's assume we have created a CAPD cluster with ClusterClass and Kubernetes v1.21.2 (as documented in the [Quick Start guide]). Looking at the cluster, the version of the control plane and the MachineDeployments is v1.21.2.