Документація v3.7 on etcd

Швидкий старт

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

Дотримуйтесь цих інструкцій, щоб локально встановити, запустити і протестувати кластер, що складається з одного члена etcd:

Встановіть etcd з попередньо зібраних двійкових файлів або з коду. Докладні відомості наведено у розділі Встановлення.

Важливо: Переконайтеся, що ви виконали останній крок інструкцій з встановлення, щоб переконатися, що etcd є у вашій змінній PATH.
Запустіть etcd:
```
$ etcd
{"level":"info","ts":"2021-09-17T09:19:32.783-0400","caller":"etcdmain/etcd.go:72","msg":... }
⋮
```
Примітка: Вивід, який створює etcd є журналами — логи інформаційного рівня можна ігнорувати.

Встановлення

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

Вимоги

Перед встановленням etcd ознайомтеся з наступними сторінками:

Встановлення з попередньо зібраних двійкових файлів

Найпростіший спосіб встановити etcd — з готових двійкових файлів:

Завантажте стиснутий файл архіву для вашої платформи з Releases, вибравши реліз v3.7.0 або пізніший.
Розпакуйте архівний файл. У результаті буде створено теку, яка міститиме двійкові файли.
Додайте виконувані двійкові файли до вашого шляху. Наприклад, перейменуйте та/або перемістіть двійкові файли до теки у вашому шляху (наприклад, /usr/local/bin), або додайте до шляху теку, створену на попередньому кроці.

Функціональні можливості

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

Ця сторінка містить огляд різних функціональних можливостей, які адміністратор може вказати для etcd.

Див. етапи функцій для їх пояснення.

Огляд

Функціональні можливості — це набір пар ключ=значення, які описують функції etcd. Ви можете увімкнути або вимкнути ці функції за допомогою прапорця --feature-gates у командному рядку etcd.

etcd дозволяє увімкнути або вимкнути набір функціональних можливостей. Використовуйте прапорець -h, щоб переглянути повний набір функціональних можливостей. Щоб установити функціональні можливості, використовуйте прапорець --feature-gates із вказаним списком пар функцій у командному рядку:

ЧаПи

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

etcd, загальні питання

Що таке etcd?

etcd — це консистентне розподілене сховище ключ-значення. Головним чином використовується як окрема служба координації в розподілених системах. Розроблено для зберігання невеликої кількості даних, які можуть повністю поміститися в памʼяті.

Як вимовляється etcd?

etcd вимовляється /ˈɛtsiːdiː/ і означає “розподілена тека etc.”

Чи повинні клієнти надсилати запити до лідера etcd?

Raft базується на лідері; лідер обробляє всі клієнтські запити, які потребують консенсусу кластера. Однак клієнт не повинен знати, який вузол є лідером. Будь-який запит, що вимагає консенсусу, надісланий до послідовника, автоматично пересилається до лідера. Запити, які не потребують консенсусу (наприклад, серіалізовані читання), можуть оброблятися будь-яким членом кластера.

Бібліотеки та інструменти

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

Зверніть увагу, що сторонні бібліотеки та інструменти (не розміщені на https://github.com/etcd-io), згадані нижче, не тестуються та не підтримуються командою etcd. Перед їх використанням рекомендується ознайомитися з ними та провести власне розслідування.

Інструменти

etcdctl - Клієнт командного рядка для etcd
etcd-dump - Утиліта командного рядка для дампу/відновлення etcd.
etcd-fs - Файлова система FUSE для etcd
etcddir - Синхронізація etcd та локальної теки в реальному часі. Робота з windows та linux..
etcd-browser - Веб-редактор ключів/значень для etcd з використанням AngularJS
etcd-lock - Реалізація вибору майстра та розподіленого r/w блокування з використанням etcd - Підтримує v2
etcd-console - Веб-редактор ключів/значень для etcd з використанням PHP
etcd-viewer - Редактор/переглядач сховища ключів-значень etcd, написаний на Java
etcdtool - Експорт/Імпорт/Редагування теки etcd у форматах JSON/YAML/TOML та перевірка теки за допомогою JSON-схеми
etcdloadtest - Клієнт командного рядка для навантажувального тестування etcd версії 3.0 і вище.
etcd-tui - Сучасний інтерфейс користувача терміналу (TUI) для взаємодії з вашою базою даних etcd. Навігація ключами, перегляд значень, фільтрація даних та управління кластером etcd безпосередньо з терміналу.
etcdfinder - Швидкий, сучасний вебінтерфейс для etcd з миттєвим пошуком. Підтримує як etcd v2, так і v3.
lucas - Вебпереглядач ключів-значень для кластера kubernetes etcd3.0+.
etcd-manager - Сучасний, ефективний, багатоплатформний та безкоштовний GUI та клієнтський інструмент для etcd 3.x. Доступний для Windows, Linux та Mac.
etcd-backup-restore - Утиліта для періодичного та інкрементного резервного копіювання та відновлення etcd.
etcd-druid - Оператор Kubernetes для розгортання кластерів etcd та управління операціями другого дня.
etcdadm - Інструмент командного рядка для управління кластером etcd.
etcd-defrag - Зручний у використанні та розумний інструмент дефрагментації etcd.
etcdhelper - Втулок платформи intellij для etcd.

Бібліотеки

Нижче наведено клієнтські бібліотеки etcd за мовами програмування.

Повідомлення про помилки

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

Якщо будь-яка частина проєкту etcd має помилки або помилки в документації, будь ласка, повідомте нам, відкривши тікет. Ми ставимося до багів і помилок дуже серйозно і вважаємо, що жодна проблема не є занадто малою. Перед створенням звіту про помилку, будь ласка, перевірте, чи не існує вже звіт про ту ж проблему.

Щоб зробити звіт про помилку точним і легким для розуміння, будь ласка, спробуйте створювати звіти про помилки, які є:

Конкретними. Включайте якомога більше деталей: яка версія, яке середовище, яка конфігурація тощо. Якщо помилка повʼязана з роботою сервера etcd, будь ласка, додайте журнал etcd (початковий журнал з конфігурацією etcd особливо важливий).

Налаштування

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

Типові налаштування в etcd повинні добре працювати для встановлень у локальній мережі, де середня затримка мережі низька. Однак, при використанні etcd між кількома дата-центрами або в мережах з високою затримкою, налаштування інтервалу такту та тайм-ауту виборів можуть потребувати налаштування.

Мережа не є єдиним джерелом затримки. На кожен запит і відповідь можуть впливати повільні диски як на лідері, так і на послідовнику. Кожен з цих тайм-аутів представляє загальний час від запиту до успішної відповіді від іншої машини.

Протокол служби виявлення

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

Протокол служби виявлення допомагає новому учаснику etcd виявити всіх інших учасників у фазі завантаження кластера за допомогою спільного токена виявлення та списку точок доступу.

Протокол служби виявлення використовується лише на етапі запуску кластера і не може застосовуватися для переналаштування під час роботи або моніторингу кластера.

Протокол використовує новий токен виявлення для завантаження одного унікального кластера etcd. Памʼятайте, що один токен виявлення може представляти лише один кластер etcd. Як тільки протокол виявлення на цьому токені починається, навіть якщо він переривається на півдорозі, його не можна використовувати для завантаження іншого кластера etcd.

Домовленості ведення журналу

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

etcd використовує бібліотеку zap для ведення журналу виводу застосунків, категоризованого на рівні. Рівень повідомлення журналу визначається відповідно до цих домовленостей:

Журнали DebugLevel зазвичай є обʼємними, і типово вимикаються у робочому середовищі.
- Приклади:
  - Надсилання звичайного повідомлення до віддаленого вузла
  - Запис елемента журналу на диск
InfoLevel є стандартним пріоритетом ведення журналу.
- Приклади:
  - Конфігурація запуску
  - Початок створення знімка
  - Додавання нового вузла до кластера
  - Додавання нового користувача до підсистеми автентифікації
Журнали WarnLevel важливіші за Info, але не потребують окремого перегляду людиною.

Модулі Golang

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

Проєкт etcd (з версії 3.5) організований у кілька golang модулів, розміщених в одному репозиторії.

Існують наступні модулі:

go.etcd.io/etcd/api/v3 — містить визначення API (наприклад, протоколи та бібліотеки, згенеровані протоколами), що визначають протокол звʼязку між клієнтами та сервером etcd.
go.etcd.io/etcd/pkg/v3 — колекція пакунків утиліт, що використовуються etcd без привʼязки до самого etcd. Пакунок є належним тут лише якщо його можна буде в майбутньому перемістити в окремий репозиторій. Будь ласка, уникайте додавання сюди коду, який має багато залежностей, оскільки вони автоматично стають залежностями клієнтської бібліотеки (яку ми хочемо зберегти легкою).

Демонстрація

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

Ця серія прикладів показує основні процедури роботи з кластером etcd.

Auth

auth,user,role для автентифікації:

export ETCDCTL_API=3
ENDPOINTS=localhost:2379

etcdctl --endpoints=${ENDPOINTS} role add root
etcdctl --endpoints=${ENDPOINTS} role get root

etcdctl --endpoints=${ENDPOINTS} user add root
etcdctl --endpoints=${ENDPOINTS} user grant-role root root
etcdctl --endpoints=${ENDPOINTS} user get root

etcdctl --endpoints=${ENDPOINTS} role add role0
etcdctl --endpoints=${ENDPOINTS} role grant-permission role0 readwrite foo
etcdctl --endpoints=${ENDPOINTS} user add user0
etcdctl --endpoints=${ENDPOINTS} user grant-role user0 role0

etcdctl --endpoints=${ENDPOINTS} auth enable
# тепер всі запити клієнтів проходять через автентифікацію

etcdctl --endpoints=${ENDPOINTS} --user=user0:123 put foo bar
etcdctl --endpoints=${ENDPOINTS} get foo
# у дозволі відмовлено, імʼя користувача порожнє, оскільки запит не видає запит на автентифікацію
etcdctl --endpoints=${ENDPOINTS} --user=user0:123 get foo
# user0 може прочитати ключ foo
etcdctl --endpoints=${ENDPOINTS} --user=user0:123 get foo1