Начало работы с кластером или базой данных ArangoDB простым способом

Загрузка выпусков

Вы можете скачать предварительно скомпилированные бинарники arangodb через страницу выпусков GitHub.

Примечание: arangodb также входит во все текущие версии ArangoDB.

Сборка

Если вы хотите собрать arangodb самостоятельно, выполните следующее:

go install github.com/arangodb-helper/arangodb@latest

Это приведёт к созданию двоичного файла в директории $GOPATH/bin/arangodb.

Для более продвинутых вариантов сборки клонируйте этот репозиторий и выполните:

make local

Исполняемый файл будет находиться в папке ./bin, названной в соответствии с текущей ОС и архитектурой (например, linux/amd64/arangodb). Вы можете скопировать двоичный файл куда угодно в вашем PATH. Программа будет запущена на Linux, MacOS или Windows.

Примечание: стандартная сборка использует контейнер Docker для выполнения сборки. Если Docker недоступен, make local запустит компилятор Go напрямую и поместит двоичный файл непосредственно в проектную директорию. В этом случае вам потребуется установить пакет golang на вашей системе (версия 1.7 или выше).

Создание образа Docker

Если вы хотите создать образ arangodb/arangodb-starter Docker самостоятельно, вы можете сделать это с помощью команды:

make docker

Запуск кластера

Установите ArangoDB обычным образом как двоичный пакет. Затем:

На хосте А:

arangodb

Это будет использовать порт 8528 для ожидания коллег (необходимо три для надёжного кластера). На хосте Б: (может быть тем же что и А):

arangodb --starter.join A

Это будет связываться с А на порту 8528 и регистрироваться. На хосте C: (может быть тем же что и А или Б):

arangodb --starter.join A

Это будет связываться с А на порту 8528 и регистрироваться.

Как только три хоста соединятся, каждый из них запустит Агента, Координатора и Сервер базы данных, и кластер будет готов к использованию. Порт показывается в консоли, стартовый порт используется для координатора (порт +1), сервера базы данных (порт +2), агента (порт +3). Смотрите ниже под --starter.port для того, чтобы узнать, как изменить начальный порт стартового процесса.

Дополнительные серверы могут быть добавлены таким же образом.

Использование конфигурационного файла для предоставления опций CLI

Стартовый процесс ищет arangodb-starter.conf в рабочей директории по умолчанию. Вы можете указать путь до конфигурационного файла с помощью опции CLI --configuration (-c):

arangodb --configuration=/etc/arangodb-starter.conf

Файлы .conf для стартового процесса ArangoDB имеют простую пару ключ-значение. Каждое значение указано на отдельной строке в виде:

ключ = значение

Он может выглядеть так:

starter.id = my-starter-1
starter.endpoint = http://127.0.0.1:8528

Альтернативно, можно указать секцию заголовка и опции, относящиеся к этой секции, в более коротком формате:

[starter]
id = my-starter-1
endpoint = http://127.0.0.1:8528
sync = true

[sync]
start-master = true
start-worker = true
monitoring.token = 8cd07f3a5ff98f2a78cfc366c13fb123eb8d29c1ca37c79df190425d5b9e424d

Таким образом, опция командной строки ‑‑section.param value легко переводится в опцию в конфигурационном файле:

[секция]
param = значение

Вы также можете использовать конфигурационный файл для передачи опций:

starter.mode = cluster

[args]
all.default-language = es_419
dbservers.rocksdb.enable-statistics = true

Дополнительная информация по использованию

Просмотрите руководство по стартовому процессу ArangoDB.

HTTP API

Просмотрите HTTP API.

Будущие планы

• Разрешить удаление агента стартового процесса из кластера.
• Включить возможность обновления кластера в контролируемом режиме.

Техническое объяснение происходящего

Процесс заключается в том, что первый экземпляр arangodb (также известный как "мастер") предлагает HTTP-сервис на порту 8528 для регистрации коллег. Каждый экземпляр, который регистрируется, становится слугой. Как только количество зарегистрированных экземпляров достигает значения cluster-agency-size, каждый экземпляр arangodb запускает агента (если он один из первых трёх), базу данных и координатора. Необходимые опции командной строки для связи между экземплярами arangod генерируются автоматически. Кластер запускается и готов к использованию.

Когда любой экземпляр arangodb завершает работу, он также завершает работу всех экземпляров arangod под своим управлением. Когда arangodb снова запускается, он восстанавливает старую конфигурацию из файла setup.json в своей директории данных, запускает свои экземпляры arangod снова (со своими данными) и они присоединяются к кластеру.

Все сетевые адреса обнаруживаются через HTTP-коммуникацию между экземплярами arangodb. Порты используются 8529 (/8539 /8549) для координатора, 8530 (/8540 /8550) для базы данных, 8531 (/8541 /8551) для агента. Все эти порты должны быть свободны. Если больше одного экземпляра arangodb запускается на одном компьютере, второй увеличит все эти номера портов на 10 и так далее.

В случае если исполняемый файл работает внутри Docker, он будет использовать API Docker для получения номера порта Docker-хоста, на который порт 8528 был отображён. Все контейнеры, запущенные исполняющим файлом, будут отображать порты, которые они используют, на точно такой же порт хоста.

Обратная связь

Обратная связь очень ценится в форме задач GitHub, запросов на слияние или электронной почты на hackers@arangodb.com.