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 docs for the durability policies #955

Merged
merged 7 commits into from
Feb 2, 2022

Conversation

GuptaManan100
Copy link
Member

This PR adds the documentation for the durability policies which are part of vtctl, vtctld, vtworker and vtorc. It also documents its usage for logging discrepancies in semi-sync setup as introduced in vitessio/vitess#9533

@netlify
Copy link

netlify bot commented Jan 27, 2022

✔️ Deploy Preview for vitess ready!

🔨 Explore the source changes: 5506cff

🔍 Inspect the deploy log: https://app.netlify.com/sites/vitess/deploys/61f89eb6eba8f300081945d2

😎 Browse the preview: https://deploy-preview-955--vitess.netlify.app/docs/13.0/user-guides/configuration-basic/durability_policy

Copy link
Member

@hallaroo hallaroo 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 grammar changes and one link insert suggestion.

Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

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

Approving provisionally.
We can merge once feedback has been addressed.

Comment on lines 33 to 39
In case you notice any logs that look like the following, you should create an issue [here](https://github.com/vitessio/vitess/issues) and report it:
```
invalid configuration - semi-sync should be setup according to durability policies, but enable_semi_sync is not set
```
```
invalid configuration - semi-sync should be setup according to durability policies, but the tablet is not primaryEligible
```
Copy link
Member

Choose a reason for hiding this comment

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

This section still needs to change, right?
First thing people should do is check that their configuration on vtctld matches the config on vttablets, not create an issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

These logs only happen when someone has specified -durability_policy=semi-sync and then enableSemiSync isn't set on the tablet or we sent true for semi-sync for a non-primary eligible tablet. These bugs have to be reported, right?

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'll add one more line asking for the users to verify that the vtctl configuration matches that of vttablet

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 have made the requested change. If there is something else that needs change I'll create another PR for it. Merging this PR.

@deepthi deepthi dismissed hallaroo’s stale review February 2, 2022 16:38

Feedback has been addressed

@deepthi deepthi merged commit b3b34e6 into vitessio:prod Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants