kubernetes / kubernetes/website

etcd --listen-client-urls and --advertise-client-urls configuration doesn't match etcd documentation

Open Beginner friendly
#56,517 3 comments 0 reactions 0 assignees View on GitHub
kind/bug needs-triage
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

**This is a Bug Report**

**Problem:**

In https://github.com/kubernetes/website/blob/main/content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md#multi-node-etcd-cluster it gives the example:

etcd --listen-client-urls=http://$IP1:2379,http://$IP2:2379,http://$IP3:2379,http://$IP4:2379,http://$IP5:2379

This doesn't align with the etcd documentation, which indicates that --listen-client-urls is the set of addresses that a specific instance of etcd should listen for clients on. If you look at https://etcd.io/docs/v3.5/op-guide/clustering/ you can see that each instance of etcd listens on a publicly-accessible address, and on the localhost address.

Similarly, each etcd instance only specifies its own IP address for --advertise-client-urls.

**Proposed Solution:**

Make it clear that the user is to run five separate instances of etcd with different IP addresses, and that these are not complete commandlines for etcd:
etcd --listen-client-urls=http://$IP1:2379 --advertise-client-urls=http://$IP1:2379...
etcd --listen-client-urls=http://$IP2:2379 --advertise-client-urls=http://$IP2:2379...
etcd --listen-client-urls=http://$IP3:2379 --advertise-client-urls=http://$IP3:2379...
etcd --listen-client-urls=http://$IP4:2379 --advertise-client-urls=http://$IP4:2379...
etcd --listen-client-urls=http://$IP5:2379 --advertise-client-urls=http://$IP5:2379...

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

Contributor guide

Open the contributing guide

Research direction

Open content/en/docs/tasks/administer-cluster/configure-upgrade-etcd.md and inspect the multi-node etcd cluster section, then compare its example with the linked etcd clustering documentation. Update the example and surrounding explanation so the five separate instances and their per-instance client URLs are unambiguous; done means the page no longer suggests one instance listens on every node address.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.