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 documentation for new snapshot restore flags #16160

Closed
dusk125 opened this issue Jun 30, 2023 · 6 comments
Closed

Add documentation for new snapshot restore flags #16160

dusk125 opened this issue Jun 30, 2023 · 6 comments
Assignees
Labels
area/documentation area/etcdutl contribfest Issues for Contribfest workshop happening during KubeCon type/feature

Comments

@dusk125
Copy link
Contributor

dusk125 commented Jun 30, 2023

What would you like to be added?

In #16029, new flags were added to etcdutl snapshot restore (--bump-revision and --mark-compacted) that need user documentation; this issue will add this documentation.

Why is this needed?

The flags are a part of the effort (#16028) to enhance restore without breaking api guarantees, and should be documented so users can understand how they work and what effects they have on their restored etcd instance.

@dusk125
Copy link
Contributor Author

dusk125 commented Jun 30, 2023

I can handle this issue

@jmhbnz
Copy link
Member

jmhbnz commented Aug 3, 2023

Hey @dusk125 - How are you going with this issue? Please let us know if we should open this issue up for the community, thanks! 🙏🏻

@dusk125
Copy link
Contributor Author

dusk125 commented Aug 3, 2023

Hey @jmhbnz, this issue is still on my todo list, but feel free to open it up if someone can/wants to handle it before I get back to this. I've been working on a time sensitive project which is why this and my other PR have stalled, but that is wrapping up, so I'll be able to dedicate more time to both.

@jmhbnz jmhbnz added the contribfest Issues for Contribfest workshop happening during KubeCon label Nov 4, 2023
@jmhbnz
Copy link
Member

jmhbnz commented Nov 4, 2023

Adding contribfest label. This would be a good candidate for the upcoming etcd contribfest at Kubecon.

For a quick hint to whoever picks this up, the flag documentation needs to be added to https://github.com/etcd-io/etcd/blob/main/etcdutl/README.md.

@spawulski
Copy link

contribfest: I can try take on this issue

@jmhbnz
Copy link
Member

jmhbnz commented Nov 8, 2023

Closing, completed in #16885 :)

@jmhbnz jmhbnz closed this as completed Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation area/etcdutl contribfest Issues for Contribfest workshop happening during KubeCon type/feature
Development

No branches or pull requests

3 participants