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.

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

Add Instructions for storedVersion Upgrade #6467

Closed
wants to merge 1 commit into from

Conversation

JeromeJu
Copy link
Member

Changes

This commit updates the v1 migration guide to add the instructions for the storedVersion upgrade.

/kind documentation
part of #6382

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs included if any changes are user facing
  • [n/a] Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • [n/a] Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • [n/a] Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

This commit updates the v1 migration guide to add the instructions for
the storedVersion upgrade.
@tekton-robot tekton-robot added kind/documentation Categorizes issue or PR as related to documentation. release-note-none Denotes a PR that doesnt merit a release note. labels Mar 30, 2023
@tekton-robot tekton-robot requested review from dibyom and jerop March 30, 2023 10:39
@tekton-robot tekton-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 30, 2023
Copy link
Member

@QuanZhang-William QuanZhang-William left a comment

Choose a reason for hiding this comment

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

Thanks, @JeromeJu!

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: QuanZhang-William
To complete the pull request process, please assign vdemeester after the PR has been reviewed.
You can assign the PR to them by writing /assign @vdemeester in a comment when ready.

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

Needs approval from an approver in each of these files:

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

@JeromeJu
Copy link
Member Author

JeromeJu commented Apr 5, 2023

Thanks for the inputs for #6382 during the pipeline WG.
PTAL for the doc updates for the migration. 🙏
cc @lbernick @pritidesai @vdemeester

It identifies the differences between `v1beta1` Tekton objects and their `v1` counterparts.
It also describes the changed fields and the deprecated fields moving to v1.

## Upgrading objects to new storedversion
Copy link
Member

Choose a reason for hiding this comment

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

I think we wouldn't want a change in stored version to be transparent to users. It sounded like the docs Vincent mentioned wanting were docs on how to identify whether there are any v1beta1 objects remaining on the cluster, so they can be removed or swapped to v1. Once we have a storage version migrator in place we can also add instructions on how to use that (if any are needed).

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we wouldn't want a change in stored version to be transparent to users.

Will we want to recommend users to specify v1 CRDs instead of v1beta1 since then? curious because right now the CRD releases only provided with v1 but not yet ask so.

It sounded like the docs Vincent mentioned wanting were docs on how to identify whether there are any v1beta1 objects remaining on the cluster, so they can be removed or swapped to v1

Thanks for clarifications. Sounds like this should be in scope of this PR while we could leave the migrator parts till later when we decide on when we deprecate v1beta1? 🤔

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I think we should recommend users specify v1 CRDs instead of v1beta1. I think we can accomplish this by having our docs use v1 examples (#6414).

Adding docs for identifying v1beta1 CRDs on the cluster in this PR sounds like a great idea, maybe you and @vdemeester could work together on that?

And yes, we can leave the storage version migrator for later.

Copy link
Member

Choose a reason for hiding this comment

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

I am not sure I followed everything, but the storage version switch should be "transparent" for users. They can use v1 or v1beta1 today, and no matter what we use as a storage version this should still remain true.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think in the previous context, "not transparent" might intend to mean "end users wouldn't be necessary to feel impacted or need to respond to the version upgrade". It makes sense that we shall definitely include in the release note and let users know when we swap:)

@JeromeJu
Copy link
Member Author

JeromeJu commented Jun 9, 2023

Let's close this for now until we are reaching the EOL of v1beta1 :)

@JeromeJu JeromeJu closed this Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. release-note-none Denotes a PR that doesnt merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants