✨ feat: add experimental `clusterctl convert` command by ramessesii2 · Pull Request #12843 · kubernetes-sigs/cluster-api

ramessesii2 · 2025-10-10T06:50:05Z

Implements a new clusterctl convert command to convert core CAPI resources i.e., cluster.x-k8s.io resources between API versions, currently supporting v1beta1 → v1beta2 migration.

✅ Tests
✅ Docs

Implements #12716

k8s-ci-robot · 2025-10-10T06:50:13Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign justinsb for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot · 2025-10-10T06:50:14Z

Welcome @ramessesii2!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2025-10-10T06:50:15Z

Hi @ramessesii2. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

neolit123

did a quick first pass on migrate.go

please keep the commits squashed to 1 on amends.

cmd/clusterctl/cmd/migrate.go

sbueringer · 2025-10-16T04:54:48Z

/ok-to-test

fabriziopandini · 2025-10-16T14:58:06Z

/area clusterctl

neolit123

thanks for the updates. i did a bigger pass on the code today.
this is in relatively good shape, but i made some suggestions to re-organize it a bit and make api types opaque to the migrate package.

cmd/clusterctl/cmd/migrate.go

cmd/clusterctl/internal/migrate/parser.go

neolit123 · 2025-10-16T16:54:40Z

cmd/clusterctl/cmd/migrate.go

+
+Examples:
+  # Migrate from file to stdout
+  clusterctl migrate cluster.yaml


would migrate from new to old be supported?
e.g. v1beta2 -> v1beta1

I'm thinking what are the usecase where a user would downgrade! And even with warnings, there might be data loss while downgrading.
If may suggest, could we please keep it to the scope of the issue as it's already experimental but definitely mark your question.

fabriziopandini

@ramessesii2 thanks for this PR and sorry for the delay in the review.

Two main comments from my side

The code should be structured to support usage of clusterctl as a library
I would suggest to simplify the code as much as possible, the code target a specific use case and we do not expect to change this code frequently (let's prefer simplicity over extensibility)

See comments for more details; also feel free to pin me in the CAPI channel if you need more clarifications

cmd/clusterctl/cmd/migrate.go

cmd/clusterctl/internal/migrate/parser.go

cmd/clusterctl/internal/migrate/converter.go

sbueringer · 2025-11-11T17:14:47Z

@ramessesii2 Do you have time to address the findings above?

ramessesii2 · 2025-11-12T00:40:00Z

@ramessesii2 Do you have time to address the findings above?

Hey @sbueringer, sorry for the delay. I've been working on the major refactoring suggested in the reviews. Almost there, I'll push it by EDO

- Experimental migration support focuses on v1beta1 to v1beta2 conversions for core Cluster API resources Signed-off-by: Satyam Bhardwaj <[email protected]>

ramessesii2

I've addressed most of the reviews, other might not be applicable post the refactoring.

cmd/clusterctl/cmd/migrate.go

cmd/clusterctl/internal/migrate/converter.go

cmd/clusterctl/internal/migrate/engine.go

cmd/clusterctl/internal/migrate/parser.go

- Move to new `Convert` method in clusterctl client interface from the proposed migrate. - Create new conversion package with parsing and conversion utilities - Remove deprecated `migrate` command and related internal migration code Signed-off-by: Satyam Bhardwaj <[email protected]>

ramessesii2 · 2025-11-12T05:22:14Z

@neolit123 @fabriziopandini @sbueringer Thanks for your initial reviews. Based on those, I've refactored code into a new commit. I'll squash it once we're ready to merge or let me know if you prefer that right away.

k8s-ci-robot · 2025-11-12T05:25:04Z

@ramessesii2: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-cluster-api-apidiff-main	`e2b91c1`	link	false	`/test pull-cluster-api-apidiff-main`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

sbueringer · 2025-11-26T04:03:44Z

/cc @fabriziopandini when you have some time (I'll be on PTO for a while)

sivchari · 2026-02-18T03:07:32Z

cmd/clusterctl/client/convert/resource_test.go

+func contains(s, substr string) bool {
+	return len(s) >= len(substr) && (s == substr || len(s) > len(substr) && containsHelper(s, substr))
+}
+
+func containsHelper(s, substr string) bool {
+	for i := 0; i <= len(s)-len(substr); i++ {
+		if s[i:i+len(substr)] == substr {
+			return true
+		}
+	}
+	return false
+}


Isn't it enought to use strings.Contains ?

sivchari · 2026-02-18T03:08:50Z

cmd/clusterctl/client/convert/parser.go

+	obj := &unstructured.Unstructured{}
+	_, gvk, err := unstructuredDecoder.Decode(trimmed, nil, obj)
+	if err != nil {
+		return document{}, errors.Wrap(err, "unable to decode document: invalid YAML structure")


Suggested change

return document{}, errors.Wrap(err, "unable to decode document: invalid YAML structure")

return document{}, errors.Wrap(err, "failed to decode document: invalid YAML structure")

sivchari · 2026-02-18T03:08:59Z

cmd/clusterctl/client/convert/parser.go

+		return document{}, errors.Wrap(err, "unable to decode document: invalid YAML structure")
+	}
+	if gvk == nil || gvk.Empty() || gvk.Kind == "" || (gvk.Group == "" && gvk.Version == "") {
+		return document{}, errors.New("unable to decode document: missing or empty apiVersion/kind")


Suggested change

return document{}, errors.New("unable to decode document: missing or empty apiVersion/kind")

return document{}, errors.New("failed to decode document: missing or empty apiVersion/kind")

sivchari · 2026-02-18T04:29:19Z

cmd/clusterctl/client/convert.go

+var (
+	// sourceGroupVersions defines the source GroupVersions that should be converted.
+	sourceGroupVersions = []schema.GroupVersion{
+		clusterv1.GroupVersion,


Suggested change

clusterv1.GroupVersion,

clusterv1beta1.GroupVersion,

It will result in pass through.

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 10, 2025

k8s-ci-robot added the do-not-merge/needs-area PR is missing an area label label Oct 10, 2025

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 10, 2025

k8s-ci-robot requested review from Jont828 and sivchari October 10, 2025 06:50

ramessesii2 mentioned this pull request Oct 10, 2025

v1beta1 -> v1beta2 migration tool #12716

Open

ramessesii2 force-pushed the RAMESSES/migrate-cmd branch from db40551 to 1bf4039 Compare October 15, 2025 07:53

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 15, 2025

ramessesii2 changed the title ~~feat: add clusterctl alpha migrate command~~ feat: add experimental clusterctl migrate command Oct 15, 2025

ramessesii2 force-pushed the RAMESSES/migrate-cmd branch 3 times, most recently from 6f90e35 to c2050f4 Compare October 15, 2025 08:51

ramessesii2 marked this pull request as ready for review October 15, 2025 08:52

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 15, 2025

k8s-ci-robot requested a review from richardcase October 15, 2025 08:52

ramessesii2 changed the title ~~feat: add experimental clusterctl migrate command~~ ✨ feat: add experimental clusterctl migrate command Oct 15, 2025

neolit123 reviewed Oct 15, 2025

View reviewed changes

ramessesii2 force-pushed the RAMESSES/migrate-cmd branch from c2050f4 to f67227b Compare October 16, 2025 01:33

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 16, 2025

ramessesii2 force-pushed the RAMESSES/migrate-cmd branch from f67227b to dd58aab Compare October 16, 2025 10:29

k8s-ci-robot added the area/clusterctl Issues or PRs related to clusterctl label Oct 16, 2025

k8s-ci-robot removed the do-not-merge/needs-area PR is missing an area label label Oct 16, 2025

neolit123 reviewed Oct 16, 2025

View reviewed changes

fabriziopandini reviewed Oct 25, 2025

View reviewed changes

feat: add experimental clusterctl migrate command

f0dd120

- Experimental migration support focuses on v1beta1 to v1beta2 conversions for core Cluster API resources Signed-off-by: Satyam Bhardwaj <[email protected]>

ramessesii2 force-pushed the RAMESSES/migrate-cmd branch from dd58aab to 5303b74 Compare November 12, 2025 05:06

ramessesii2 commented Nov 12, 2025

View reviewed changes

ramessesii2 changed the title ~~✨ feat: add experimental clusterctl migrate command~~ ✨ feat: add experimental clusterctl convert command Nov 12, 2025

ramessesii2 force-pushed the RAMESSES/migrate-cmd branch from 5303b74 to e2b91c1 Compare November 12, 2025 05:20

fabriziopandini mentioned this pull request Nov 25, 2025

clusterctl move fails when migrating from v1beta1 to v1beta2 management cluster #13034

Closed

ramessesii2 requested review from fabriziopandini and neolit123 December 9, 2025 12:17

sivchari reviewed Feb 18, 2026

View reviewed changes

	return document{}, errors.Wrap(err, "unable to decode document: invalid YAML structure")
	return document{}, errors.Wrap(err, "failed to decode document: invalid YAML structure")

	return document{}, errors.New("unable to decode document: missing or empty apiVersion/kind")
	return document{}, errors.New("failed to decode document: missing or empty apiVersion/kind")

Conversation

ramessesii2 commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Oct 10, 2025

Uh oh!

k8s-ci-robot commented Oct 10, 2025

Uh oh!

k8s-ci-robot commented Oct 10, 2025

Uh oh!

neolit123 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sbueringer commented Oct 16, 2025

Uh oh!

fabriziopandini commented Oct 16, 2025

Uh oh!

neolit123 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neolit123 Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

ramessesii2 Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

fabriziopandini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sbueringer commented Nov 11, 2025

Uh oh!

ramessesii2 commented Nov 12, 2025

Uh oh!

ramessesii2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ramessesii2 commented Nov 12, 2025

Uh oh!

k8s-ci-robot commented Nov 12, 2025

Uh oh!

sbueringer commented Nov 26, 2025

Uh oh!

ramessesii2 commented Oct 10, 2025 •

edited

Loading

neolit123 left a comment •

edited

Loading

neolit123 left a comment •

edited

Loading