Giters

kubernetes / website

Kubernetes website and documentation repo:

Home Page:https://kubernetes.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

etcd task page unclear on difference between `etcdctl` and `etcdutl`

sftim opened this issue · comments

commented

This is a Bug Report

Problem:
Operating etcd clusters for Kubernetes mentions etcdctl (which is deprecated) quite a lot before the first mention of etcdutl.

Proposed Solution:

  • Mention early on that there are two tools
  • Where a use of etcdctl is deprecated in favor of etcdutl, repeat the equivalent change from #46748

Page to Update:
https://kubernetes.io/docs/tasks/administer-cluster/configure-upgrade-etcd/

Additional Information:
/sig etcd

commented

/triage accepted
/help

commented

@divya-mohan0209:
This request has been marked as needing help from a contributor.

Guidelines

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 here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/triage accepted
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

commented

I'd love to take this one if no one else has started already

commented

/assign

commented

Help is very welcome. Would you like any advice @robert-cronin ?

commented

Thank you @sftim 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! :)

commented

@robert-cronin I think you're right.

General guidance:

I'll edit the issue description.

commented

@robert-cronin I think you're right.

General guidance:

I'll edit the issue description.

Thank you for the guidance, @sftim.

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.