⚠️ Introduce v1alpha2 API #190

Fedosin · 2023-07-14T14:22:30Z

What this PR does / why we need it:
This PR introduces new API version v1alpha2.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #167

Fedosin · 2023-07-14T14:22:39Z

/hold

Fedosin · 2023-08-11T10:04:47Z

/hold cancel

test/e2e/helm_test.go

furkatgofurov7

Thank you working on this, few suggestions inline:

api/v1alpha2/conditions_consts.go

.golangci.yaml

furkatgofurov7 · 2023-08-14T15:03:48Z

internal/controller/component_customizer.go

-			if cSpec.Image != nil && cSpec.Image.Name != "" && cSpec.Image.Repository != "" {
-				c.Image = imageMetaToURL(cSpec.Image)


how are these changes related to new API version?

I guess this is the reason for the new API version. Incompatible fields

Yes, @Danil-Grigorev is right. It's a result of the API change. In v1alpha1 we used ImageMeta object to provide a custom image for the provider. In v1alpha2 we decided that it's better to use the well-known /: image URL format, which is just a string.
After this change we don't have to convert ImageMeta -> ImageURL anymore, hence the change.

Should we add documentation for user migration from v1alpha1 to v1alpha2 in this case? Similar to https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/developer/providers/version-migration.md?plain=1

But migration doc in CAPI is formed when they release a minor release, and describe changes needed going from one minor release of CAPI to another.

Technically, you don't need to migrate anything manually. I implemented auto-conversion, which handles v1alpha1 -> v1alpha2 upgrade.
But I agree that it would be nice to have a doc describing the changes in the new version.

Auto-conversion looks good to me. If we face a situation when autogenerated conversion will not be enough, we could look towards documenting the process. Let’s address the doc describing changes closer to the next release.

furkatgofurov7 · 2023-08-14T15:33:42Z

Also forgot to mention, I would consider this as a breaking change and suggest re-titling the PR (with ⚠️) to signal it properly in the release notes

Danil-Grigorev

/lgtm

k8s-ci-robot · 2023-08-18T10:16:41Z

LGTM label has been added.

Git tree hash: d31cb9e373b23600b0d8f5d5832653313b9f28c9

Danil-Grigorev · 2023-08-18T10:16:57Z

Thanks @Fedosin, looking good!

furkatgofurov7

/approve
/hold

pending clarification on: ⚠️ Introduce v1alpha2 API #190 (comment). I would prefer taking care of this with the same PR if we decide to go down that path but no strong opinions since we have an autoconversion in place.
in case we want to have more eyes on it

k8s-ci-robot · 2023-08-23T10:19:07Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: furkatgofurov7

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [furkatgofurov7]

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

Fedosin · 2023-08-23T12:43:01Z

@furkatgofurov7 I agree with you - some documentation is necessary here. I'll write it later today and update the PR.

docs/README.md

furkatgofurov7 · 2023-08-23T18:12:25Z

docs/migrating.md

+
+This document describes changes that were introduced in v1alpha2 API and how to update your templates to the new version.
+
+## ImageMeta -> imageURL conversion


One more suggestion: we could have headers in the doc, similar to https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/developer/providers/migrations/v1.4-to-v1.5.md#cluster-api-v14-compared-to-v15 and for example for API changes like below it could be https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/developer/providers/migrations/v1.4-to-v1.5.md#changes-by-kind

docs/migrating.md

furkatgofurov7 · 2023-08-24T09:51:12Z

@Fedosin thanks a lot, this version looks great to me!

furkatgofurov7

/lgtm

Pending CI to pass (currently failing due to API rate limit and needs re-run after an hour)

k8s-ci-robot · 2023-08-24T09:52:24Z

LGTM label has been added.

Git tree hash: 4dda14fbb1ad348a2cb26615b2dd40d4de0656b3

Danil-Grigorev

/lgtm

Fedosin · 2023-08-24T12:59:44Z

/retest

Fedosin · 2023-08-24T13:17:07Z

Thank you for review!

/hold cancel

k8s-ci-robot requested review from fabriziopandini and justinsb July 14, 2023 14:22

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 14, 2023

k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 14, 2023

Fedosin force-pushed the v1alpha2 branch 3 times, most recently from 52ecc4a to f023580 Compare July 18, 2023 16:10

alexander-demicev mentioned this pull request Aug 4, 2023

Support addon providers such as CAAPH #198

Closed

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 5, 2023

Fedosin force-pushed the v1alpha2 branch from f023580 to d448885 Compare August 10, 2023 13:26

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 10, 2023

Fedosin force-pushed the v1alpha2 branch 7 times, most recently from 05d51a2 to 78ad7d2 Compare August 11, 2023 09:51

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 11, 2023

Danil-Grigorev reviewed Aug 11, 2023

View reviewed changes

test/e2e/helm_test.go Outdated Show resolved Hide resolved

furkatgofurov7 reviewed Aug 14, 2023

View reviewed changes

Fedosin changed the title ~~✨ Introduce v1alpha2 API~~ ✨ ⚠️ Introduce v1alpha2 API Aug 15, 2023

Fedosin force-pushed the v1alpha2 branch 2 times, most recently from 2ddda48 to f5218d3 Compare August 15, 2023 09:37

Danil-Grigorev approved these changes Aug 18, 2023

View reviewed changes

k8s-ci-robot assigned Danil-Grigorev Aug 18, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 18, 2023

furkatgofurov7 approved these changes Aug 23, 2023

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 23, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 23, 2023

Introduce v1aplha2 API

60377c7

Fedosin force-pushed the v1alpha2 branch from f5218d3 to 20d532c Compare August 23, 2023 16:45

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 23, 2023

k8s-ci-robot requested a review from Danil-Grigorev August 23, 2023 16:45

furkatgofurov7 reviewed Aug 23, 2023

View reviewed changes

Fedosin added 2 commits August 24, 2023 11:26

Update docs

0838ca2

Add v1alpha2 migration doc

251997c

Fedosin force-pushed the v1alpha2 branch from 20d532c to 251997c Compare August 24, 2023 09:39

furkatgofurov7 reviewed Aug 24, 2023

View reviewed changes

k8s-ci-robot assigned furkatgofurov7 Aug 24, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 24, 2023

Danil-Grigorev reviewed Aug 24, 2023

View reviewed changes

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 24, 2023

k8s-ci-robot merged commit 7cf4782 into kubernetes-sigs:main Aug 24, 2023

Fedosin mentioned this pull request Aug 25, 2023

⚠️ Use v1alpha2 manifests in the helm chart #220

Merged

Fedosin changed the title ~~✨ ⚠️ Introduce v1alpha2 API~~ ⚠️ Introduce v1alpha2 API Feb 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

⚠️ Introduce v1alpha2 API #190

⚠️ Introduce v1alpha2 API #190

Fedosin commented Jul 14, 2023

Fedosin commented Jul 14, 2023

Fedosin commented Aug 11, 2023

furkatgofurov7 left a comment

furkatgofurov7 Aug 14, 2023

Danil-Grigorev Aug 14, 2023

Fedosin Aug 15, 2023

Danil-Grigorev Aug 15, 2023

furkatgofurov7 Aug 15, 2023

Fedosin Aug 15, 2023

Danil-Grigorev Aug 23, 2023

furkatgofurov7 commented Aug 14, 2023

Danil-Grigorev left a comment

k8s-ci-robot commented Aug 18, 2023

Danil-Grigorev commented Aug 18, 2023

furkatgofurov7 left a comment •

edited

Loading

k8s-ci-robot commented Aug 23, 2023

Fedosin commented Aug 23, 2023

furkatgofurov7 Aug 23, 2023

furkatgofurov7 commented Aug 24, 2023

furkatgofurov7 left a comment

k8s-ci-robot commented Aug 24, 2023

Danil-Grigorev left a comment

Fedosin commented Aug 24, 2023

Fedosin commented Aug 24, 2023

		if cSpec.Image != nil && cSpec.Image.Name != "" && cSpec.Image.Repository != "" {
		c.Image = imageMetaToURL(cSpec.Image)


		This document describes changes that were introduced in v1alpha2 API and how to update your templates to the new version.

		## ImageMeta -> imageURL conversion

⚠️ Introduce v1alpha2 API #190

⚠️ Introduce v1alpha2 API #190

Conversation

Fedosin commented Jul 14, 2023

Fedosin commented Jul 14, 2023

Fedosin commented Aug 11, 2023

furkatgofurov7 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

furkatgofurov7 commented Aug 14, 2023

Danil-Grigorev left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 18, 2023

Danil-Grigorev commented Aug 18, 2023

furkatgofurov7 left a comment • edited Loading

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 23, 2023

Fedosin commented Aug 23, 2023

Choose a reason for hiding this comment

furkatgofurov7 commented Aug 24, 2023

furkatgofurov7 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 24, 2023

Danil-Grigorev left a comment

Choose a reason for hiding this comment

Fedosin commented Aug 24, 2023

Fedosin commented Aug 24, 2023

furkatgofurov7 left a comment •

edited

Loading