diff --git a/cmd/clusterctl/client/client.go b/cmd/clusterctl/client/client.go index dd76da457b33..78f050b7d41b 100644 --- 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 index 76fcf7a4601d..9111e00b6a69 100644 --- 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 index 530cacb6d92e..6583ac7f8463 100644 --- 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 + + 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.