Merge pull request #10139 from sbueringer/pr-deprecate-clusterctl-alp…

…ha-topology-plan

🌱 Deprecate clusterctl alpha topology plan

.golangci.yml

@@ -202,7 +202,7 @@ issues:
   # should be removed as the referenced deprecated item is removed from the project.
   - linters:
       - staticcheck
-    text: "SA1019: (bootstrapv1.ClusterStatus|KubeadmConfigSpec.UseExperimentalRetryJoin|scope.Config.Spec.UseExperimentalRetryJoin|DockerMachine.Spec.Bootstrapped|machineStatus.Bootstrapped) is deprecated"
+    text: "SA1019: (bootstrapv1.ClusterStatus|KubeadmConfigSpec.UseExperimentalRetryJoin|scope.Config.Spec.UseExperimentalRetryJoin|DockerMachine.Spec.Bootstrapped|machineStatus.Bootstrapped|c.TopologyPlan) is deprecated"
   # Specific exclude rules for deprecated packages that are still part of the codebase. These
   # should be removed as the referenced deprecated packages are removed from the project.
   - linters:

cmd/clusterctl/client/client.go

@@ -87,6 +87,8 @@ type AlphaClient interface {
 	// RolloutUndo provides rollout rollback of cluster-api resources
 	RolloutUndo(ctx context.Context, options RolloutUndoOptions) error
 	// TopologyPlan dry runs the topology reconciler
+	//
+	// Deprecated: TopologyPlan is deprecated and will be removed in one of the upcoming releases.
 	TopologyPlan(ctx context.Context, options TopologyPlanOptions) (*TopologyPlanOutput, error)
 }
 

cmd/clusterctl/cmd/topology_plan.go

@@ -107,6 +107,8 @@ func init() {
 		panic(err)
 	}
 
+	topologyPlanCmd.Deprecated = "it will be removed in one of the upcoming releases.\n"
+
 	topologyCmd.AddCommand(topologyPlanCmd)
 }
 

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

@@ -1,5 +1,13 @@
 # clusterctl alpha topology plan
 
+<aside class="note warning">
+
+<h1>Warning</h1>
+
+"clusterctl alpha topology plan" is deprecated and will be removed in one of the upcoming releases. For more details, please see [#10138](https://github.com/kubernetes-sigs/cluster-api/issues/10138). 
+
+</aside>
+
 The `clusterctl alpha topology plan` command can be used to get a plan of how a Cluster topology evolves given
 file(s) containing resources to be applied to a Cluster.