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

Add lock shard docs #15981

Merged
merged 4 commits into from
May 22, 2024
Merged

Add lock shard docs #15981

merged 4 commits into from
May 22, 2024

Conversation

GuptaManan100
Copy link
Member

Description

This PR adds internal docs for LockShard functionality.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@GuptaManan100
feat: add lock sharding docs for etcd
ab57de0 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
docs: add zookeeper docs
32839be 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
docs: add consul too to the docs
3ecb7d9 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented May 20, 2024

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

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

Backward compatibility

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

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels May 20, 2024
@GuptaManan100 GuptaManan100 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels May 20, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 20, 2024
frouioui
frouioui approved these changes May 21, 2024
View reviewed changes
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Should we also add this to the website repository?

doc/design-docs/LockShard.md Outdated Show resolved Hide resolved
doc/design-docs/LockShard.md Outdated Show resolved Hide resolved
@GuptaManan100
docs: address review comments
3095b45 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@rohit-nayak-ps rohit-nayak-ps merged commit 64ae1b7 into vitessio:main May 22, 2024
91 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the add-lock-shard-docs branch May 22, 2024 10:49
@rohit-nayak-ps
Copy link
Contributor

Should we also add this to the website repository?

This is implementation-related, so it makes sense to keep it in the vitess repo I think.

@GuptaManan100
Copy link
Member Author

I agree with Rohit, this can remain an internal Vitess doc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frouioui frouioui frouioui approved these changes

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

@mattlord mattlord Awaiting requested review from mattlord

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps

Assignees
No one assigned
Labels
Component: Topology Type: Documentation
Projects
None yet
Milestone
v20.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@GuptaManan100 @rohit-nayak-ps @frouioui