Docs: vttablet PITR via --restore-to-timestamp and --restore-to-position

[shlomi-noach]

Documenting the changes in vitessio/vitess#13964, and specifically these vttablet flags:

• --restore-to-timestamp
• --restore-to-position

Either of which, combined with --restore_from_backup, causes the tablet to start using a point-in-time recovery.

Only merge once vitessio/vitess#13964 is merged

[netlify]

✅ Deploy Preview for vitess ready!

Name	Link
🔨 Latest commit	7c0fd70
🔍 Latest deploy log	https://app.netlify.com/sites/vitess/deploys/652527905d3462000802faa4
😎 Deploy Preview	https://deploy-preview-1594--vitess.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[ajm188]

vttablet now also has auto-generated docs](#1580), so you should also update those with (assuming you have your changes checked out in vitessio/vitess): COBRADOCS_VERSION_PAIRS="HEAD:18.0" VITESS_DIR=/where/does/shlomi/keep/vitess make vttablet-docs (alternatively, make generated-docs to do 'em all instead of just the one binary; same envvars apply)

[shlomi-noach]

Cool! This actually changed nothing, except for this line, which apparently leaks devs' home directories:

--config-path strings                                              Paths to search for config files in. (default [/Users/andrew/dev/vitess])

[ajm188]

Cool! This actually changed nothing, except for this line, which apparently leaks devs' home directories:

--config-path strings                                              Paths to search for config files in. (default [/Users/andrew/dev/vitess])

yeah, we noticed this last night and @frouioui opened #1601 for it

[ajm188]

hmm, this should have updated https://vitess.io/docs/18.0/reference/programs/vttablet/#options with the added flags, was your HEAD maybe not on that branch?

[shlomi-noach]

was your HEAD maybe not on that branch?

It was, and I also ran make build to ensure the binaries were up to date...

[ajm188]

ahh, your PR is based 2 weeks ago, before the vttablet docgen stuff got added. if you merge to at least vitessio/vitess@98c754a you should get it working

[shlomi-noach]

I've merged latest main, executed again, and still no dice. No change to docs other than that line I mentioned above.

[shlomi-noach]

Updated to reflect dashes, not underscores. Automation still does not change the vttablet docs.

[shlomi-noach]

Now that vitessio/vitess#13964 is merged into main this works. I'm not sure why this wouldn't work when the branch was still unmerged?

[ajm188]

I'm not sure why this wouldn't work when the branch was still unmerged?

It depends on what you used for COBRADOC_VERSION_PAIRS, and what state your local checkout was. If, for example, you did HEAD:18.0, and you had vitess checked out to some other branch that didn't have your changes, it wouldn't reflect in the docs. If instead you did <your-vitess-branch-here>:18.0 then it would.

[shlomi-noach]

It depends on what you used for COBRADOC_VERSION_PAIRS, and what state your local checkout was. If, for example, you did HEAD:18.0, and you had vitess checked out to some other branch that didn't have your changes, it wouldn't reflect in the docs.

I did HEAD:18.0 and my branch was checkout to the appropriate branch, and I made sure to run make build.

If instead you did :18.0 then it would.

I did that as well, and made sure to run make build

[ajm188]

I did HEAD:18.0 and my branch was checkout to the appropriate branch, and I made sure to run make build.

I did that as well, and made sure to run make build

weiiiiird!

the only guess i have (and it doesn't super matter since it seems to be working for you now) is maybe you started in the website dir prior to this change? then if you had HEAD at your branch and main as the previous branch then every command after the first would have git checkout - send you back to main (and since vttablet is not first you would generate docs from main)

[shlomi-noach]

The website has been meanwhile frozen for v18 RC1 release. Therefore, this PR was updated to apply the changes to both 18.0 and the new 19.0 paths.