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

GA: Promote GitRepository API to source.toolkit.fluxcd.io/v1 #1056

Merged
merged 16 commits into from
Mar 29, 2023
Merged

GA: Promote GitRepository API to source.toolkit.fluxcd.io/v1 #1056

merged 16 commits into from
Mar 29, 2023

Conversation

stefanprodan
Copy link
Member

@stefanprodan stefanprodan commented Mar 23, 2023 •
edited by hiddeco
Loading

API changes

The GitRepository kind was promoted from v1beta2 to v1 (GA) and deprecated fields were removed.

The common types Artifact, Conditions and the Source interface were promoted to v1.

The gitrepositories.source.toolkit.fluxcd.io CRD contains the following versions:

  • v1 (storage version)
  • v1beta2 (deprecated)
  • v1beta1 (deprecated)

Upgrade

The GitRepository v1 API is backwards compatible with v1beta2 with the following exceptions:

  • the deprecated field .spec.gitImplementation was removed
  • the unused field .spec.accessFrom was removed
  • the deprecated field .status.contentConfigChecksum was removed
  • the deprecated field .status.artifact.checksum was removed
  • the .status.url was removed in favor of the absolute .status.artifact.url

To upgrade from v1beta2, after deploying the new CRD and controller, set apiVersion: source.toolkit.fluxcd.io/v1 in the YAML files that contain GitRepository definitions and remove the deprecated fields if any. Bumping the API version in manifests can be done gradually. It is advised to not delay this procedure as the beta versions will be removed after 6 months.

Closes: #947

@stefanprodan stefanprodan added this to the Bootstrap GA milestone Mar 23, 2023
@stefanprodan stefanprodan force-pushed the gitrepository-v1 branch 2 times, most recently from 5136db4 to 9a0a899 Compare March 23, 2023 20:59
@stefanprodan
Promote GitRepository API to v1
ef8804c 
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
stefanprodan and others added 6 commits March 23, 2023 23:33
@stefanprodan
Mark GitRepository v1beta1 and v1beta2 as deprecated
9c80a66 
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
@hiddeco
api: Remove deprecated Checksum from Artifact
b2da6f0 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
api/v1: Remove deprecated ContentConfigChecksum
462178e 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
api/v1: Remove deprecated GitImplementation
97a2cdd 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@stefanprodan
Update fluxcd/pkg/apis/meta to v1.0.0
e9de3a7 
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
@stefanprodan
docs: Add GitRepository v1 docs
d905985 
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
makkes pushed a commit to fluxcd/website that referenced this pull request Mar 27, 2023
pull in v1 GitRepository from fluxcd/source-controller#1056
e8dfbce 
Signed-off-by: Max Jonas Werner <mail@makk.es>
@stefanprodan stefanprodan marked this pull request as ready for review March 27, 2023 17:54
@stefanprodan stefanprodan requested a review from a team March 27, 2023 17:55
@hiddeco
docs: remove deprecated Checksum from specs
929d42e 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
makkes pushed a commit to fluxcd/website that referenced this pull request Mar 28, 2023
pull in v1 GitRepository from fluxcd/source-controller#1056
df1da30 
Signed-off-by: Max Jonas Werner <mail@makk.es>
@stefanprodan
Add GitRepository v1 to project file
ee7d9b3 
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
hiddeco added 2 commits March 28, 2023 13:45
@hiddeco
Put back deprecated types and hint to v1
861343d 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
Remove TransformLegacyRevision from v1
19ba61a 
Consumers still relying on this should make use of `v1beta2` to
facilitate any transition.

In addition, remove the `*Implementation` constants for now removed
Git implemenations.

Signed-off-by: Hidde Beydals <hidde@hhh.computer>
makkes
makkes reviewed Mar 28, 2023
View reviewed changes
Copy link
Member

@makkes makkes left a comment

Choose a reason for hiding this comment

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

Not sure about the checksum-related changes in here but otherwise lgtm.

config/crd/bases/source.toolkit.fluxcd.io_buckets.yaml Show resolved Hide resolved
darkowlzz
darkowlzz reviewed Mar 28, 2023
View reviewed changes
Copy link
Contributor

@darkowlzz darkowlzz left a comment

Choose a reason for hiding this comment

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

A few comments while revising the APIs one last time before v1.

api/v1/artifact_types.go Show resolved Hide resolved
api/v1/artifact_types.go Outdated Show resolved Hide resolved
api/v1/gitrepository_types.go Outdated Show resolved Hide resolved
api/v1/gitrepository_types.go Show resolved Hide resolved
api/v1/gitrepository_types.go Outdated Show resolved Hide resolved
api/v1/zz_generated.deepcopy.go Outdated Show resolved Hide resolved
hiddeco added 2 commits March 28, 2023 16:57
@hiddeco
Delete Status.URL field from GitRepository v1
4ab3c21 
Usage of this field has not been recommended for a long time as it was
best-effort based.

Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
api-docs: fix external link source for v1.Artifact
8fcfde9 
Plus a switch from `godoc.org` -> `pkg.go.dev`.

Signed-off-by: Hidde Beydals <hidde@hhh.computer>
darkowlzz
darkowlzz reviewed Mar 28, 2023
View reviewed changes
controllers/gitrepository_controller.go Show resolved Hide resolved
controllers/gitrepository_controller.go Show resolved Hide resolved
controllers/storage.go Outdated Show resolved Hide resolved
controllers/storage.go Show resolved Hide resolved
docs/spec/v1/gitrepositories.md Outdated Show resolved Hide resolved
@hiddeco hiddeco mentioned this pull request Mar 28, 2023
Merged
hiddeco added 3 commits March 29, 2023 00:00
@hiddeco
api: improve validation rules and omitempty nits
f65e261 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
misc: various nits in doc blocks
1023315 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
docs: address nits
f2da9bf 
- Use `kubectl events` in favor of `kubectl get events`.
- Remove deleted `URL` field from `Status` examples of `GitRepository`
  v1.

Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
Copy link
Member

hiddeco commented Mar 28, 2023

@darkowlzz think I managed to address all your comments.

@hiddeco hiddeco requested a review from darkowlzz March 29, 2023 07:00
darkowlzz
darkowlzz approved these changes Mar 29, 2023
View reviewed changes
Copy link
Contributor

@darkowlzz darkowlzz left a comment

Choose a reason for hiding this comment

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

LGTM!

@hiddeco hiddeco merged commit 51dea22 into main Mar 29, 2023
@hiddeco hiddeco deleted the gitrepository-v1 branch March 29, 2023 09:38
@stefanprodan stefanprodan mentioned this pull request Mar 29, 2023
Merged
2 tasks
@RafalKorepta RafalKorepta mentioned this pull request Oct 19, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hiddeco hiddeco hiddeco left review comments

@makkes makkes makkes left review comments

@darkowlzz darkowlzz darkowlzz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Maintainers' Focus
Archived in project
Milestone
Bootstrap GA
Development

Successfully merging this pull request may close these issues.

GA: Promote GitRepository to source.toolkit.fluxcd.io/v1
4 participants
@stefanprodan @hiddeco @makkes @darkowlzz