Deprecate clusterctl alpha topology plan

Signed-off-by: Stefan Büringer buringerst@vmware.com
kubernetes-sigs · Feb 12, 2024 · bd8565f · bd8565f
1 parent 4a84453
commit bd8565f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/cmd/clusterctl/client/client.go b/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)
 }
 

diff --git a/cmd/clusterctl/cmd/topology_plan.go b/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)
 }
 

diff --git a/docs/book/src/clusterctl/commands/alpha-topology-plan.md b/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.