Change:
This is a Bug Report <!-- Thanks for filing an issue! Before submitting, please fill in the following information. --<!-- See for guidance on writing an actionable issue description. --<!--Required Information--Problem: mentions ~(which is deprecated)~ quite a lot before the first mention of . Proposed Solution: Mention early on that there are two tools Where a use of is deprecated in favor of , repeat the equivalent change from Page to Update: <!--Optional Information (remove the comment tags around information you would like to include)--<!--Kubernetes Version:--Additional Information: /sig etcd
/triage accepted /help
This request has been marked as needing help from a contributor. Please ensure that the issue body includes answers to the following questions: Why are we solving this issue? To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points? Does this issue have zero to low barrier of entry? How can the assignee reach out to you for help? For more details on the requirements of such an issue, please see and ensure that they are met. If this request no longer meets these requirements, the label can be removed by commenting with the command. <detailsIn response to : /triage accepted /help Instructions for interacting with me using PR comments are available . If you have questions or suggestions related to my behavior, please file an issue against the repository. </details
I'd love to take this one if no one else has started already
/assign
Help is very welcome. Would you like any advice ?
Thank you Any general advice would be greatly appreciated. I have a Minikube multi-node cluster up and running, and I am executing the etcdutl commands within the first container. Hopefully, this setup will suffice for validation. Regarding documentation, I'll follow the provided related issues/documentation, which seem comprehensive enough to get started. However, I'll ensure to ask in the Slack group or on this issue if I encounter any difficulties. As I understand it, only the snapshot commands are deprecated and need updating to their etcdutl counterparts. If there's any inaccuracy in my understanding, please feel free to correct me. Thanks again! :)
I think you're right. General guidance: I'll edit the issue description.
Thank you for the guidance, I have opened a pull request to add a section clarifying the difference between etcdctl and etcdutl. Please feel free to review it and suggest any changes.

Discussion:
nodes. If you do not already have a cluster, you can create one by using [minikube](https://minikube.sigs.k8s.io/docs/tutorials/multi_node/). <ins> ### Understanding etcdctl and etcdutl `etcdctl` and `etcdutl` are command-line tools used to interact with etcd clusters, but they serve different purposes: - `etcdctl`: This is the primary command-line client for interacting with etcd over a network. It is used for day-to-day operations such as managing keys and values, administering the cluster, checking health, and more. - `etcdutl`: This is an administration utility designed to operate directly on etcd data files, including migrating data between etcd versions, defragmenting the database, restoring snapshots, and validating data consistency. For network operations, `etcdctl` should be used. For more information on `etcdutl`, you can refer to the [etcd recovery documentation](https://etcd.io/docs/v3.5/op-guide/recovery/). </ins> <!-- steps --> ## Prerequisites

Verify the snapshot: <del> ```shell ETCDCTL_API=3 etcdctl --write-out=table snapshot status snapshot.db ``` </del> <ins> {{< tabs name="etcd_verify_snapshot" >}} {{% tab name="Use etcdutl" %}} The below example depicts the usage of the `etcdutl` tool for verifying a snapshot: </ins> <del> ```console +----------+----------+------------+------------+ |   HASH   | REVISION | TOTAL KEYS | TOTAL SIZE | +----------+----------+------------+------------+ | fe01cf57 |       10 |          7 | 2.1 MB     | +----------+----------+------------+------------+ ``` </del> <ins> ```shell etcdutl --write-out=table snapshot status snapshot.db ``` This should generate an output resembling the example provided below: ```console +----------+----------+------------+------------+ |   HASH   | REVISION | TOTAL KEYS | TOTAL SIZE | +----------+----------+------------+------------+ | fe01cf57 |       10 |          7 | 2.1 MB     | +----------+----------+------------+------------+ ``` {{% /tab %}} {{% tab name="Use etcdctl (Deprecated)" %}} {{< note >}} The usage of `etcdctl snapshot status` has been **deprecated** since etcd v3.5.x and is slated for removal from etcd v3.6. It is recommended to utilize [`etcdutl`](https://github.com/etcd-io/etcd/blob/main/etcdutl/README.md) instead. {{< /note >}} The below example depicts the usage of the `etcdctl` tool for verifying a snapshot: ```shell export ETCDCTL_API=3 etcdctl --write-out=table snapshot status snapshot.db ``` This should generate an output resembling the example provided below: ```console Deprecated: Use `etcdutl snapshot status` instead. +----------+----------+------------+------------+ |   HASH   | REVISION | TOTAL KEYS | TOTAL SIZE | +----------+----------+------------+------------+ | fe01cf57 |       10 |          7 | 2.1 MB     | +----------+----------+------------+------------+ ``` {{% /tab %}} {{< /tabs >}} </ins> ### Volume snapshot