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 clarification on the usage of etcdutl vs etcdctl #46778

Merged
merged 3 commits into from
Jun 12, 2024
Merged

Add clarification on the usage of etcdutl vs etcdctl #46778

merged 3 commits into from
Jun 12, 2024

Conversation

robert-cronin
Copy link
Contributor

@robert-cronin robert-cronin commented Jun 11, 2024 •
edited
Loading

This PR clarifies the usage of etcdctl and etcdutl on the "Operating etcd clusters for Kubernetes" page

Fixes #46757

Before
After

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. language/en Issues or PRs related to English language labels Jun 11, 2024
@netlify Netlify
Copy link

netlify bot commented Jun 11, 2024 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 364f5bb
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/666952a669aa9d0008a1ca08
😎 Deploy Preview https://deploy-preview-46778--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@robert-cronin
Copy link
Contributor Author

/sig etcd

@k8s-ci-robot k8s-ci-robot added the sig/etcd Categorizes an issue or PR as relevant to SIG Etcd. label Jun 11, 2024
@robert-cronin
Copy link
Contributor Author

robert-cronin commented Jun 11, 2024 •
edited
Loading

I might have overlooked the snapshot status command, I will add a tab layout.

As for the snapshot save command, it looks like that is meant to remain as the etcdctl command so I won't do anything for that:

website git:(update-etcd-commands) ✗ etcdutl snapshot save snapshot.db                  
Command "save" is deprecated, Use `etcdctl snapshot save` to download snapshot
...

@robert-cronin robert-cronin marked this pull request as draft June 11, 2024 12:49
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 11, 2024
sftim
sftim reviewed Jun 11, 2024
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Changes so far LGTM

@robert-cronin
Copy link
Contributor Author

Thank you @sftim, I've added a tab for the snapshot status command. The commands produce the same output on my local so I have just duplicated the result in the explanation:

website git:(update-etcd-commands) ✗ etcdctl snapshot status ./snapshot.db --write-out=table
Deprecated: Use `etcdutl snapshot status` instead.

 ---------- ---------- ------------ ------------ 
|   HASH   | REVISION | TOTAL KEYS | TOTAL SIZE |
 ---------- ---------- ------------ ------------ 
| be51a9b0 |     4727 |        971 |     2.4 MB |
 ---------- ---------- ------------ ------------ 
➜  website git:(update-etcd-commands) ✗ etcdutl snapshot status ./snapshot.db --write-out=table
 ---------- ---------- ------------ ------------ 
|   HASH   | REVISION | TOTAL KEYS | TOTAL SIZE |
 ---------- ---------- ------------ ------------ 
| be51a9b0 |     4727 |        971 |     2.4 MB |
 ---------- ---------- ------------ ------------

Note: status will also be deprecated in 3.6: etcd-io/etcd#13809

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 12, 2024
@robert-cronin robert-cronin marked this pull request as ready for review June 12, 2024 00:43
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 12, 2024
@Shubham82
Copy link
Contributor

Thanks @robert-cronin
The preview looks good to me:
https://deploy-preview-46778--kubernetes-io-main-staging.netlify.app/docs/tasks/administer-cluster/configure-upgrade-etcd/#understanding-etcdctl-and-etcdutl

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 12, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: db81cf650a861abe8d8c3bbea1489f3e172a967b

sftim
sftim reviewed Jun 12, 2024
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 12, 2024
@k8s-ci-robot k8s-ci-robot merged commit ab46c51 into kubernetes:main Jun 12, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@jpbetz jpbetz Awaiting requested review from jpbetz

@wojtek-t wojtek-t Awaiting requested review from wojtek-t

@Shubham82 Shubham82 Awaiting requested review from Shubham82

Assignees

@Shubham82 Shubham82

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/etcd Categorizes an issue or PR as relevant to SIG Etcd. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

etcd task page unclear on difference between etcdctl and etcdutl
4 participants
@robert-cronin @Shubham82 @k8s-ci-robot @sftim