Навчальні посібники on etcd

Як налаштувати демонстраційний кластер etcd

Mon, 01 Jan 0001 00:00:00 +0000

На кожному вузлі etcd вкажіть членів кластера:

TOKEN=token-01
CLUSTER_STATE=new
NAME_1=machine-1
NAME_2=machine-2
NAME_3=machine-3
HOST_1=10.240.0.17
HOST_2=10.240.0.18
HOST_3=10.240.0.19
CLUSTER=${NAME_1}=http://${HOST_1}:2380,${NAME_2}=http://${HOST_2}:2380,${NAME_3}=http://${HOST_3}:2380

Запустіть це на кожній машині:

# Для машини 1
THIS_NAME=${NAME_1}
THIS_IP=${HOST_1}
etcd --data-dir=data.etcd --name ${THIS_NAME} \
	--initial-advertise-peer-urls http://${THIS_IP}:2380 --listen-peer-urls http://${THIS_IP}:2380 \
	--advertise-client-urls http://${THIS_IP}:2379 --listen-client-urls http://${THIS_IP}:2379 \
	--initial-cluster ${CLUSTER} \
	--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

# Для машини 2
THIS_NAME=${NAME_2}
THIS_IP=${HOST_2}
etcd --data-dir=data.etcd --name ${THIS_NAME} \
	--initial-advertise-peer-urls http://${THIS_IP}:2380 --listen-peer-urls http://${THIS_IP}:2380 \
	--advertise-client-urls http://${THIS_IP}:2379 --listen-client-urls http://${THIS_IP}:2379 \
	--initial-cluster ${CLUSTER} \
	--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

# Для машини 3
THIS_NAME=${NAME_3}
THIS_IP=${HOST_3}
etcd --data-dir=data.etcd --name ${THIS_NAME} \
	--initial-advertise-peer-urls http://${THIS_IP}:2380 --listen-peer-urls http://${THIS_IP}:2380 \
	--advertise-client-urls http://${THIS_IP}:2379 --listen-client-urls http://${THIS_IP}:2379 \
	--initial-cluster ${CLUSTER} \
	--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

Або використовуйте наш публічний сервіс виявлення:

Запис до etcd

Mon, 01 Jan 0001 00:00:00 +0000

Передумови

Встановіть etcdctl

Процедура

Використовуйте субкоманду put для запису пари ключ-значення:

etcdctl --endpoints=$ENDPOINTS put foo "Привіт Світ!"

де:

foo є назвою ключа
"Hello World!" є значенням у лапках

Читання з etcd

Mon, 01 Jan 0001 00:00:00 +0000

Передумови

Встановіть etcdctl

Процедура

Використовуйте субкоманду get для читання з etcd:

$ etcdctl --endpoints=$ENDPOINTS get foo
foo
Hello World!
$

де:

foo — це потрібний ключ
Hello World! — це отримане значення

Або, для форматованого виводу:

$ etcdctl --endpoints=$ENDPOINTS --write-out="json" get foo
{"header":{"cluster_id":289318470931837780,"member_id":14947050114012957595,"revision":3,"raft_term":4,
"kvs":[{"key":"Zm9v","create_revision":2,"mod_revision":3,"version":2,"value":"SGVsbG8gV29ybGQh"}]}}
$

де write-out="json" призводить до виводу значення у форматі JSON (зверніть увагу, що ключ не повертається).

Як отримати ключі за префіксом

Mon, 01 Jan 0001 00:00:00 +0000

Передумови

Отримати ключі за префіксом

$ etcdctl --endpoints=$ENDPOINTS get PREFIX --prefix

Глобальні параметри

--endpoints=[127.0.0.1:2379], gRPC endpoints

Параметри

--prefix, отримати діапазон ключів з відповідним префіксом

Приклад

etcdctl --endpoints=$ENDPOINTS put web1 value1
etcdctl --endpoints=$ENDPOINTS put web2 value2
etcdctl --endpoints=$ENDPOINTS put web3 value3

etcdctl --endpoints=$ENDPOINTS get web --prefix

Як видалити ключі

Mon, 01 Jan 0001 00:00:00 +0000

Передумови

Встановіть etcd та etcdctl

Додавання або видалення ключів

del для видалення вказаного ключа або діапазону ключів:

etcdctl del $KEY [$END_KEY]

Опції

--prefix[=false]: видалити ключі з відповідним префіксом
--prev-kv[=false]: вивести видалені пари ключ-значення
--from-key[=false]: видалити ключі, які більші або рівні даному ключу, використовуючи байтове порівняння
--range[=false]: видалити діапазон ключів без затримки

Опції, успадковані від батьківських команд

--endpoints="127.0.0.1:2379": gRPC endpoints

Приклади

etcdctl --endpoints=$ENDPOINTS put key myvalue
etcdctl --endpoints=$ENDPOINTS del key

etcdctl --endpoints=$ENDPOINTS put k1 value1
etcdctl --endpoints=$ENDPOINTS put k2 value2
etcdctl --endpoints=$ENDPOINTS del k --prefix

Як зробити кілька записів у транзакції

Mon, 01 Jan 0001 00:00:00 +0000

Передумови

Встановіть etcd та etcdctl.
Запущений кластер etcd.

Термінологія

Ось визначення деяких ключових термінів, що використовуються в Прикладі нижче.

Терміни	Визначення
etcdctl	Інструмент командного рядка для взаємодії з сервером etcd.
команда `txn`	Команда `txn` є скороченням від “transaction” (транзакція). Вона зчитує кілька запитів etcd зі стандартного вводу та застосовує їх як єдину атомарну транзакцію. Транзакція складається з списку умов, списку запитів для застосування, якщо всі умови істинні, та списку запитів для застосування, якщо будь-яка умова хибна. Див. Команди ключ-значення etcdctl для отримання додаткової інформації.
`compare`	Умова `compare` всередині транзакції (`txn`) слугує умовною перевіркою, яка визначає, чи слід продовжувати операції транзакції. Вона гарантує, що зміни застосовуються лише тоді, коли поточний стан сховища ключ-значення відповідає очікуваним умовам, тим самим підтримуючи узгодженість даних та запобігаючи конфліктам у одночасному середовищі. Щоб побачити структуру команди, перегляньте розділ Виконання транзакції нижче.

Транзакції

txn для обробки всіх запитів в одній транзакції:

Як спостерігати за ключами

Mon, 01 Jan 0001 00:00:00 +0000

Необхідні умови

Встановіть etcd та etcdctl

Спостереження за ключами

Використовуйте watch, щоб отримувати повідомлення про майбутні зміни:

etcdctl watch $KEY [$END_KEY]

Опції

-i, --interactive[=false]: інтерактивний режим
--prefix[=false]: спостерігати за префіксом, якщо встановлено префікс
--rev=0: Ревізія для початку спостереження
--prev-kv[=false]: отримати попередню пару ключ-значення перед подією
--progress-notify[=false]: отримувати періодичні повідомлення про прогрес спостереження від сервера

Опції, успадковані від батьківських команд

--endpoints="127.0.0.1:2379": gRPC endpoints

Приклади

Як створити оренду

Mon, 01 Jan 0001 00:00:00 +0000

Використовуйте lease для запису з часу існування (TTL, time-to-live) в etcd:

etcdctl --endpoints=$ENDPOINTS lease grant 300
# lease 2be7547fbc6a5afa granted with TTL(300s)

etcdctl --endpoints=$ENDPOINTS put sample value --lease=2be7547fbc6a5afa
etcdctl --endpoints=$ENDPOINTS get sample

etcdctl --endpoints=$ENDPOINTS lease keep-alive 2be7547fbc6a5afa
etcdctl --endpoints=$ENDPOINTS lease revoke 2be7547fbc6a5afa
# or after 300 seconds
etcdctl --endpoints=$ENDPOINTS get sample

Як створювати блокування

Mon, 01 Jan 0001 00:00:00 +0000

Використовуйте lock для розподіленого блокування:

etcdctl --endpoints=$ENDPOINTS lock mutex1

# another client with the same name blocks
etcdctl --endpoints=$ENDPOINTS lock mutex1

Як проводити вибори лідера в кластері etcd

Mon, 01 Jan 0001 00:00:00 +0000

Передумови

Переконайтеся, що etcd та etcdctl встановлені.
Перевірте наявність активного кластера etcd.

Проведення виборів лідера

Команду etcdctl використовують для проведення виборів лідера в кластері etcd. Вона гарантує, що лише один клієнт може стати лідером за раз.

etcdctl --endpoints=$ENDPOINTS elect <election-name> [proposal]

etcdctl --endpoints=$ENDPOINTS elect election-name p1

Параметри

--endpoints : $ENDPOINTS

Адреса кожного члена кластера etcd.
election-name string

Рядковий ідентифікатор для виборів. Усі учасники, які конкурують за лідерство, мають використовувати однакову назву виборів.

Як перевірити стан кластера

Mon, 01 Jan 0001 00:00:00 +0000

Передумови

Встановіть etcd та etcdctl

Перевірка загального стану

endpoint status для перевірки загального стану кожної точки доступу, зазначеної у прапорці --endpoints:

etcdctl endpoint status (--endpoints=$ENDPOINTS|--cluster)

Параметри

--cluster[=false]: use all endpoints from the cluster member list

Перевірка справності

Використовуйте endpoint health для перевірки справності кожної точки доступу, зазначеної у прапорці --endpoints:

etcdctl endpoint health (--endpoints=$ENDPOINTS|--cluster)

Параметри

--cluster[=false]: use all endpoints from the cluster member list

Перевірка хешу KV

endpoint hashkv для перевірки хешу історії KV кожної точки доступу, зазначеної у прапорці --endpoints:

Як зберегти базу даних

Mon, 01 Jan 0001 00:00:00 +0000

Передумови

Знімок бази даних

Використовуйте snapshot для збереження знімка бази даних etcd на певний момент часу:

etcdctl --endpoints=$ENDPOINT snapshot save DB_NAME

Глобальні параметри

etcdctl

--endpoints=[127.0.0.1:2379], gRPC endpoints

Знімок можна запросити лише з одного вузла etcd, тому прапорець --endpoints повинен містити лише одну точку доступу.

etcdutl

-w, --write-out string set the output format (fields, json, protobuf, simple, table) (default "simple")

Приклад

Як додавати та видаляти учасників

Mon, 01 Jan 0001 00:00:00 +0000

Використовуйте member для додавання, видалення, оновлення членства:

# Для кожної машини
TOKEN=my-etcd-token-1
CLUSTER_STATE=new
NAME_1=etcd-node-1
NAME_2=etcd-node-2
NAME_3=etcd-node-3
HOST_1=10.240.0.13
HOST_2=10.240.0.14
HOST_3=10.240.0.15
CLUSTER=${NAME_1}=http://${HOST_1}:2380,${NAME_2}=http://${HOST_2}:2380,${NAME_3}=http://${HOST_3}:2380

# Для вузла 1
THIS_NAME=${NAME_1}
THIS_IP=${HOST_1}
etcd --data-dir=data.etcd --name ${THIS_NAME} \
	--initial-advertise-peer-urls http://${THIS_IP}:2380 \
	--listen-peer-urls http://${THIS_IP}:2380 \
	--advertise-client-urls http://${THIS_IP}:2379 \
	--listen-client-urls http://${THIS_IP}:2379 \
	--initial-cluster ${CLUSTER} \
	--initial-cluster-state ${CLUSTER_STATE} \
	--initial-cluster-token ${TOKEN}

# Для вузла 2
THIS_NAME=${NAME_2}
THIS_IP=${HOST_2}
etcd --data-dir=data.etcd --name ${THIS_NAME} \
	--initial-advertise-peer-urls http://${THIS_IP}:2380 \
	--listen-peer-urls http://${THIS_IP}:2380 \
	--advertise-client-urls http://${THIS_IP}:2379 \
	--listen-client-urls http://${THIS_IP}:2379 \
	--initial-cluster ${CLUSTER} \
	--initial-cluster-state ${CLUSTER_STATE} \
	--initial-cluster-token ${TOKEN}

# Для вузла 3
THIS_NAME=${NAME_3}
THIS_IP=${HOST_3}
etcd --data-dir=data.etcd --name ${THIS_NAME} \
	--initial-advertise-peer-urls http://${THIS_IP}:2380 \
	--listen-peer-urls http://${THIS_IP}:2380 \
	--advertise-client-urls http://${THIS_IP}:2379 \
	--listen-client-urls http://${THIS_IP}:2379 \
	--initial-cluster ${CLUSTER} \
	--initial-cluster-state ${CLUSTER_STATE} \
	--initial-cluster-token ${TOKEN}

Потім замініть учасника за допомогою команд member remove та member add: