search

vitessio / vitess

Vitess is a database clustering system for horizontal scaling of MySQL.
http://vitess.io
Apache License 2.0
18.61k stars 2.1k forks source link

ETCD API version / documentation missmatch #8591

Open stenh0use opened 3 years ago

stenh0use commented 3 years ago

Overview of the Issue

In various places of the documentation it refers to ETCD requiring v2 of the API to be activated/used. v2 is no longer used and so this should be removed.

The references to v2 of the API are also present throughout the example code.

Reproduction Steps

Some examples, but may not be all the references.

- https://vitess.io/docs/user-guides/configuration-basic/global-topo/#choosing-a-toporoot
- https://vitess.io/docs/get-started/local-brew/
- https://github.com/vitessio/vitess/blob/4c33b2b5a90dc200e6cc649681cbace2520725bd/examples/region_sharding/scripts/etcd-up.sh#L22-L27
- https://github.com/vitessio/vitess/blob/4c33b2b5a90dc200e6cc649681cbace2520725bd/examples/local/scripts/etcd-up.sh#L22-L27
- https://github.com/vitessio/vitess/blob/4c33b2b5a90dc200e6cc649681cbace2520725bd/go/test/endtoend/clustertest/etcd_test.go#L28

Operating system and Environment details

N/A

Log Fragments

N/A

deepthi commented 3 years ago

Here's the relevant commit for etcd-up.sh: https://github.com/vitessio/vitess/commit/20c6617d94cefd942b3478b9c5fef7addd5173f5 From that it looks like v3 API didn't work on macOS at that time (at least with the default etcd you get with brew). We'll need to test whether it is now possible to remove the v2 flags and still have the example working on macOS.

stenh0use commented 3 years ago

The examples are probably fine if it is for Mac OS, but the documentation https://vitess.io/docs/user-guides/configuration-basic/global-topo/#choosing-a-toporoot definitely needs an update.