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

Reorder summary in order of importance #12433

Merged
merged 8 commits into from
Feb 24, 2023
Merged

Reorder summary in order of importance #12433

merged 8 commits into from
Feb 24, 2023

Conversation

GuptaManan100
Copy link
Member

Description

This PR reorders the summary file of release-16.0 to move some items which are important to the top of the list.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Documentation was added or is not required

Deployment Notes

@GuptaManan100
feat: breaking changes should be the first heading
0e89324 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
feat: reorder the breaking changes in order of user impact
344e3c2 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
feat: VTOrc becoming mandatory is important
85734b3 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Feb 22, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Feb 22, 2023 •
edited by deepthi
Loading

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@GuptaManan100 GuptaManan100 removed Type: Release NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Feb 22, 2023
@GuptaManan100
Copy link
Member Author

I have not added the forward port label to main because as part of the release process we have to copy the summary file and the release notes to main anyways. We can wait until then.

deepthi
deepthi reviewed Feb 22, 2023
View reviewed changes
doc/releasenotes/16_0_0_summary.md
Comment on lines +187 to +191
- It is possible to take an incremental backup, starting with last known (full or incremental) backup, and up to either a specified (GTID) position, or current ("auto") position.
- The backup is done by copying binary logs. The binary logs are rotated as needed.
- It is then possible to restore a backup up to a given point in time (GTID position). This involves finding a restore path consisting of a full backup and zero or more incremental backups, applied up to the given point in time.
- A server restored to a point in time remains in `DRAINED` tablet type, and does not join the replication stream (thus, "frozen" in time).
- It is possible to take incremental backups from different tablets. It is OK to have overlaps in incremental backup contents. The restore process chooses a valid path, and is valid as long as there are no gaps in the backed up binary log content.
Copy link
Member

Choose a reason for hiding this comment

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

It feels like we can condense this and link to the website docs. Assuming we have them 😉

Copy link
Member

Choose a reason for hiding this comment

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

I don't believe we have them, #11097 is still marked as NeedsWebsiteDocsUpdate, cc @shlomi-noach

Copy link
Contributor

Choose a reason for hiding this comment

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

That is correct 😓 I'm having hard time writing those docs, and in particular how to make them co-exist with existing binlog-server -based PITR docs.

@deepthi
Copy link
Member

deepthi commented Feb 22, 2023

we invite you to use the vitess/lite:v16.0.0-mysql57 Docker Image.

I think we need to make this stronger as well. You are required to use that image if you don't want an unplanned MySQL upgrade.

@frouioui frouioui mentioned this pull request Feb 23, 2023
Closed
51 tasks
@frouioui
Reorganize the flag deletions and deprecation announcements
7bc82e6 
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui
Fix various typo and add vtorc links
45df1a2 
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui
Upgrading to this release with vitess-operator
0cda0ca 
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui
Fix various typo
aa0aeb1 
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui
Link to PRs in major changes
f9c953c 
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
harshit-gangal
harshit-gangal requested changes Feb 24, 2023
View reviewed changes
doc/releasenotes/16_0_0_summary.md
### <a id="breaking-changes"/>Breaking Changes

#### <a id="advertised-mysql-version"/>VTGate Advertised MySQL Version

VTGate now advertises MySQL version 8.0.30. This is a breaking change for clients that rely on the VTGate advertised MySQL version and still use MySQL 5.7.
Since [Pull Request #11989](https://github.com/vitessio/vitess/pull/11989), VTGate advertises MySQL version 8.0.30. This is a breaking change for clients that rely on the VTGate advertised MySQL version and still use MySQL 5.7.
Copy link
Member

Choose a reason for hiding this comment

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

it is 8.0.31

Copy link
Member Author

Choose a reason for hiding this comment

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

IIRC, we downgraded from 8.0.31 to 8.0.30 because xtrabackup didn't have support for 8.0.31 yet.

Copy link
Member Author

Choose a reason for hiding this comment

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

This is the PR - #12273

Copy link
Member

Choose a reason for hiding this comment

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

@GuptaManan100 Correct

Copy link
Member

@harshit-gangal harshit-gangal Feb 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

xtrabackup for the specific purpose has a flag called –no-server-version-check this will make xtrabackup to work on 8.0.31 as well. To my knowledge there is no regression of sorts.

@GuptaManan100 GuptaManan100 merged commit 0598be6 into vitessio:release-16.0 Feb 24, 2023
@GuptaManan100 GuptaManan100 deleted the reorder_summary branch February 24, 2023 13:21
@hmaurer hmaurer mentioned this pull request Mar 21, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepthi deepthi deepthi left review comments

@mattlord mattlord mattlord left review comments

@shlomi-noach shlomi-noach shlomi-noach left review comments

@gedgar gedgar gedgar left review comments

@harshit-gangal harshit-gangal harshit-gangal approved these changes

@frouioui frouioui frouioui approved these changes

@rsajwani rsajwani Awaiting requested review from rsajwani rsajwani is a code owner

Assignees
No one assigned
Labels
Component: General Changes throughout the code base Type: Internal Cleanup
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@GuptaManan100 @deepthi @mattlord @shlomi-noach @gedgar @harshit-gangal @frouioui