Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🌱 Deprecate clusterctl alpha topology plan #10139

Merged
merged 1 commit into from
Feb 12, 2024
Merged

🌱 Deprecate clusterctl alpha topology plan #10139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions cmd/clusterctl/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}

Expand Down
2 changes: 2 additions & 0 deletions cmd/clusterctl/cmd/topology_plan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ func init() {
panic(err)
}

topologyPlanCmd.Deprecated = "it will be removed in one of the upcoming releases.\n"

topologyCmd.AddCommand(topologyPlanCmd)
}

Expand Down
8 changes: 8 additions & 0 deletions docs/book/src/clusterctl/commands/alpha-topology-plan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down