*: remove project version 1 references, update migration guide to 2 -> 3 #1636

estroz · 2020-08-11T21:30:51Z

Project version 1 shouldn't be mentioned in code, and any project version that isn't supported by the binary used in a project should cause an error to be returned.

This PR also adds a skeleton migration guide with some TODO's for future work that will likely be in before the next major release.

/kind documentation

k8s-ci-robot · 2020-08-11T21:30:52Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

k8s-ci-robot · 2020-08-11T21:31:05Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: estroz

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~~ [estroz]

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

estroz · 2020-08-11T21:33:01Z

/cc @DirectXMan12 @joelanford

estroz · 2020-08-11T21:33:34Z

Closes #1508

camilamacedo86 · 2020-08-12T10:44:20Z

docs/book/src/SUMMARY.md

@@ -45,12 +45,10 @@

 - [Migrations](./migrations.md)

-  - [Kubebuilder v1 vs v2](./migration/v1vsv2.md)
+  - [Kubebuilder v2 vs v3](./migration/v2vsv3.md)


Hi @estroz,

IMO we should not remove the V1 to the V2 migration guide. It should still
What do you need is add a new migration V2 to V3 instead.

camilamacedo86 · 2020-08-12T10:44:29Z

build/test.sh

-go test -race ./cmd/...
-go test -race ./pkg/...
-
-fi


Where it is used?
Is not a test to check the project in the release process?
So, would not be better it be updated to use the project version 3-alpha instead?

camilamacedo86 · 2020-08-12T10:45:47Z

docs/book/src/migration/guide.md

@@ -1,220 +1,58 @@
-# Migration from v1 to v2
+# Migration from v2 to v3


Ditto above

camilamacedo86 · 2020-08-12T10:46:32Z

docs/book/src/migration/multi-group.md

@@ -1,85 +0,0 @@
-# Single Group to Multi-Group


It should not be removed.
For V2 and V# it still valid.

camilamacedo86 · 2020-08-12T10:48:24Z

docs/book/src/migration/testdata/gopath/project-v1/.gitignore

@@ -1,24 +0,0 @@
-


I have a PR to remove the V1 mock and update the migration guide to not point to it.
Could we move forward with it #1499 before?

camilamacedo86 · 2020-08-12T10:49:04Z

docs/book/src/migration/v2vsv3.md

+The default `CustomResourceDefinition` version is now `v1`, bumped from `v1beta1` which is
+[deprecated][crds-deprecated-doc].


was it merged?

camilamacedo86 · 2020-08-12T10:49:22Z

docs/book/src/migration/v2vsv3.md

+The default `ValidatingWebhookConfiguration` and `MutatingWebhookConfiguration` versions are now `v1`,
+bumped from `v1beta1` which is [deprecated][webhook-deprecated-pr].


camilamacedo86 · 2020-08-12T10:49:57Z

docs/kubebuilder_v0_v1_difference.md

@@ -1,56 +0,0 @@
-# Kubebuilder v0 v.s. v1


we should not remove the old docs. they should still.

camilamacedo86 · 2020-08-12T10:50:06Z

docs/migration_guide.md

@@ -1,146 +0,0 @@
-# Migration guide from v0 project to v1 project


we should not remove the old docs. they should still.

camilamacedo86 · 2020-08-12T10:51:15Z

internal/config/config.go

@@ -64,7 +64,7 @@ func readFrom(fs afero.Fs, path string) (c config.Config, err error) {

 	// kubebuilder v1 omitted version, so default to v1
 	if c.Version == "" {
-		c.Version = config.Version1
+		return config.Config{}, fmt.Errorf("project version key `version` is empty or does not exist in %s", path)


IMO we need a PR to ADD the migration guide v2 to v3
and another one to do these changes.

camilamacedo86

Please, see the comments:

we should not remove the old docs
we should not remove the migration guide v1 to v3
we should just add a new migration guide v2 to v3
IMO the changes in the code needs be done in one Pr and we need to have another to add the new migration guide.

PS.: I think we ought to merge #1499 before this one.

/hold

camilamacedo86 · 2020-08-12T10:54:59Z

/hold

estroz · 2020-08-12T15:07:48Z

we should not remove the old docs

You're probably right.

the changes in the code needs be done in one Pr and we need to have another to add the new migration guide.

Sure

k8s-ci-robot · 2020-08-15T17:55:25Z

@estroz: PR needs rebase.

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/test-infra repository.

gabbifish

Some minor comments about catching deprecated plugin versions and ensuring we continue to provide helpful messaging about its deprecation.

gabbifish · 2020-08-31T07:12:34Z

pkg/cli/init.go

-	// The --plugins flag can only be called to init projects v2+.
-	if c.projectVersion != config.Version1 {
+	// The --plugins flag can only be called to init projects v3+.
+	if c.projectVersion != config.Version2 {


Should this conditional continue to check c.projectVersion != config.Version1? Or in the case v1 is used, explicitly print out a message saying that version is now deprecated? We could use the IsVersionSupported() helper to accomplish this.

V1 is no longer supported and its code no longer exists in the project for a while so I am not sure if it would be required. However, I am ok with the suggestion as well.

gabbifish · 2020-08-31T07:14:55Z

pkg/model/config/config_test.go

@@ -37,11 +37,6 @@ var _ = Describe("Config", func() {
 			expectedConfig Config
 		)

-		By("Using config version 1")


Should we keep this check to ensure that v1 usage continues to produce the expected behavior (failure?)

camilamacedo86 · 2020-10-08T12:58:35Z

Hi @estroz,

In order to help we move forward and solve its blocker for the next release, I raise a PR with the migration guide only in #1714. Please, feel free to check. Also, feel free to change this pr to address only the other changes that you would like which are here.

camilamacedo86 · 2020-11-01T19:29:37Z

Hi @estroz,

The migration guide from V2 to V3 is merged. See: #1714
Since it is open for I while I pushed your suggestions/fixes made here to remove the v1 and make the --plugins flag available only for V3-alpha project version via #1763. It would be very nice to get your help in the review for we are able to merge it.

in this way, I think we can close this. WDYT?

camilamacedo86 · 2020-11-02T11:39:43Z

Hi @estroz,

I am closing this one based on the comment #1636 (comment). However, please feel free to re-open if you see that it is required.

*: remove project version 1 references, update migration guide to 2->3

28a7b4b

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. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 11, 2020

k8s-ci-robot requested review from camilamacedo86 and droot August 11, 2020 21:31

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

estroz marked this pull request as ready for review August 11, 2020 21:32

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 Aug 11, 2020

k8s-ci-robot requested review from DirectXMan12 and joelanford August 11, 2020 21:33

camilamacedo86 reviewed Aug 12, 2020

View reviewed changes

docs/book/src/migration/guide.md

@@ -1,220 +1,58 @@

# Migration from v1 to v2

# Migration from v2 to v3

Copy link

Member

camilamacedo86 Aug 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto above

camilamacedo86 reviewed Aug 12, 2020

View reviewed changes

camilamacedo86 requested changes Aug 12, 2020

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 12, 2020

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

gabbifish reviewed Aug 31, 2020

View reviewed changes

camilamacedo86 mentioned this pull request Nov 1, 2020

✨ remove v1 version and only shows --plugins flag when the project version is != V2 #1763

Merged

camilamacedo86 closed this Nov 2, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

*: remove project version 1 references, update migration guide to 2 -> 3 #1636

*: remove project version 1 references, update migration guide to 2 -> 3 #1636

estroz commented Aug 11, 2020 •

edited

Loading

k8s-ci-robot commented Aug 11, 2020

k8s-ci-robot commented Aug 11, 2020

estroz commented Aug 11, 2020

estroz commented Aug 11, 2020

camilamacedo86 Aug 12, 2020

camilamacedo86 Aug 12, 2020 •

edited

Loading

camilamacedo86 Aug 12, 2020

camilamacedo86 Aug 12, 2020

camilamacedo86 Aug 12, 2020

camilamacedo86 Aug 12, 2020

camilamacedo86 Aug 12, 2020

camilamacedo86 Aug 12, 2020

camilamacedo86 Aug 12, 2020

camilamacedo86 Aug 12, 2020

camilamacedo86 left a comment •

edited

Loading

camilamacedo86 commented Aug 12, 2020

estroz commented Aug 12, 2020

k8s-ci-robot commented Aug 15, 2020

gabbifish left a comment

gabbifish Aug 31, 2020

camilamacedo86 Aug 31, 2020 •

edited

Loading

gabbifish Aug 31, 2020

camilamacedo86 commented Oct 8, 2020

camilamacedo86 commented Nov 1, 2020

camilamacedo86 commented Nov 2, 2020

		@@ -1,220 +1,58 @@
		# Migration from v1 to v2
		# Migration from v2 to v3

		The default `CustomResourceDefinition` version is now `v1`, bumped from `v1beta1` which is
		[deprecated][crds-deprecated-doc].

		The default `ValidatingWebhookConfiguration` and `MutatingWebhookConfiguration` versions are now `v1`,
		bumped from `v1beta1` which is [deprecated][webhook-deprecated-pr].

		@@ -1,146 +0,0 @@
		# Migration guide from v0 project to v1 project

*: remove project version 1 references, update migration guide to 2 -> 3 #1636

*: remove project version 1 references, update migration guide to 2 -> 3 #1636

Conversation

estroz commented Aug 11, 2020 • edited Loading

k8s-ci-robot commented Aug 11, 2020

k8s-ci-robot commented Aug 11, 2020

estroz commented Aug 11, 2020

estroz commented Aug 11, 2020

Choose a reason for hiding this comment

camilamacedo86 Aug 12, 2020 • edited Loading

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

Choose a reason for hiding this comment

camilamacedo86 left a comment • edited Loading

Choose a reason for hiding this comment

camilamacedo86 commented Aug 12, 2020

estroz commented Aug 12, 2020

k8s-ci-robot commented Aug 15, 2020

gabbifish left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Aug 31, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 commented Oct 8, 2020

camilamacedo86 commented Nov 1, 2020

camilamacedo86 commented Nov 2, 2020

estroz commented Aug 11, 2020 •

edited

Loading

camilamacedo86 Aug 12, 2020 •

edited

Loading

camilamacedo86 left a comment •

edited

Loading

camilamacedo86 Aug 31, 2020 •

edited

Loading