bihactl
bihactl — создать BiHA-кластер в Postgres Pro
Синтаксис
bihactl add [параметры]
bihactl init [параметры]
bihactl status [параметры]
bihactl -V | --version
bihactl -? | --help
Описание
bihactl — это утилита командной строки, которая позволяет создать BiHA-кластер, изменять его состав, а также отслеживать статус и версию кластера. За подробной информацией о решении BiHA обратитесь к главе Встроенная отказоустойчивость (BiHA).
В этом разделе содержится информация о командах утилиты bihactl:
Узел-последователь можно добавить с использованием «магической» строки, сохранённой после выполнения команды bihactl init, передав в команде bihactl add параметр -s.
Важно
Не рекомендуется выполнять команды bihactl в каталоге PGDATA. Утилита bihactl может создавать файлы biha_init.log и biha_add.log в том каталоге, откуда запускается. Однако для корректного выполнения команд bihactl целевой каталог PGDATA должен быть пустым.
Справка по командной строке #
add #
Синтаксис:
bihactl add [-c | --convert-standby]
[-D | --pgdata=каталог_данных]
[-f | --magic-file=файл_с_магической_строкой]
[-h | --host=адрес_узла]
[-I | --biha-node-id=id_узла]
[-l | --use-leader=параметры_подключения]
[-m | --backup-method=метод_резервирования]
[-O | --backup-options=параметры_резервирования]
[-p | --port=порт]
[-P | --biha-port=порт_biha]
[-r | --mode=режим_работы_узла]
[-s | --magic-string=магическая_строка]Добавляет последователя в инициализированный кластер. При выполнении этой команды создаётся резервная копия лидера с помощью pg_basebackup или pg_probackup. При добавлении узла утилита bihactl удерживает слот репликации, вызывая pg_probackup с параметрами --slot= или pg_probackup с параметрами ИМЯ_СЛОТА, --wal-method=stream, --checkpoint=fast--stream --slot=, что предотвращает удаление WAL на лидере во время создания резервной копии.ИМЯ_СЛОТА
Примечание
Узлы необходимо добавлять по очереди. Не добавляйте новый узел, если создание ранее добавленного узла ещё не завершено и узел находится в состоянии CSTATE_FORMING. В противном случае может возникнуть следующая ошибка:
WARNING: aborting backup due to backend exiting before pg_backup_stop was
called
Для выбора утилиты резервного копирования используется параметр -m, а параметры выбранной утилиты можно задать при помощи параметра -O.
Эта команда может принимать следующие параметры:
-c--convert-standby#Преобразовывает существующий узел в узел-последователь отказоустойчивого кластера. Узел должен быть репликой узла-лидера до преобразования.
-Dкаталог_данных--pgdata=#каталог_данныхУказывает каталог, где будет храниться кластер баз данных.
-fфайл_с_магической_строкой--magic-file=#файл_с_магической_строкойИспользует файл с «магической» строкой, содержащей закодированные данные, для подключения к узлу-лидеру.
-hадрес_узла--host=#адрес_узлаУказывает адрес узла для входящих соединений.
-Iid_узла--biha-node-id=#id_узлаУказывает уникальный идентификатор узла.
-lпараметры_подключения--use-leader=#параметры_подключенияУказывает параметры подключения к узлу-лидеру в следующем формате:
host=
адрес_узла_лидераport=порт_лидераbiha-port=порт_biha_лидера-mметод_резервирования--backup-method=#метод_резервированияУказывает утилиту резервного копирования. Допускаются значения
pg_basebackupиpg_probackup. Значение по умолчанию —pg_basebackup. Если не указывать параметр--backup-method, будет использован метод резервного копирования по умолчанию. Утилитаpg_basebackup— единственное допустимое значение при добавлении узла-рефери.-Oпараметры_резервирования--backup-options=#параметры_резервированияДополнительно указывает параметры pg_basebackup или pg_probackup в зависимости от утилиты резервного копирования, заданной в параметре
--backup-method.-pпорт--port=#портУказывает порт узла для входящих соединений. Если порт не указан, он берётся из
postgresql.confили используется значение по умолчанию — 5432.-Pпорт_biha--biha-port=#порт_bihaУказывает порт для обмена служебной информацией между узлами. Если порт не указан, устанавливается значение
port+ 1-rрежим_работы_узла--mode=#режим_работы_узлаУказывает режим работы узла. Допустимы следующие значения:
regular— узел может быть как лидером, так и последователем. Это значение по умолчанию.referee— узел только участвует в выборах лидера и не содержит пользовательских баз данных.referee_with_wal— узел участвует в выборах лидера так же, как в режимеreferee, и получает все файлы WAL от узла-лидера.
По умолчанию база данных
postgresне копируется на узел в режимеrefereeилиreferee_with_wal. Чтобы скопировать базу данныхpostgresна рефери, воспользуйтесь параметром --referee-with-postgres-db.-R--referee-with-postgres-db#Копирует базу данных
postgresсо всеми объектами на узел-рефери. Этот параметр можно использовать только при добавлении узла в режимеrefereeилиreferee_with_wal.-sмагическая_строка--magic-string=#магическая_строкаИспользует «магическую» строку, содержащую закодированные данные, для подключения к узлу-лидеру.
init #
Синтаксис:
bihactl init [-C | --convert]
[-D | --pgdata=каталог_данных]
[-f | --magic-file=файл_с_магической_строкой]
[-h | --host=адрес_узла]
[-I | --biha-node-id=id_узла]
[-M | --minnodes=мин_число_узлов]
[-N | --nquorum=значение_кворума]
[-o | --options=параметры_initdb]
[-p | --port=порт]
[-P | --biha-port=порт_biha]
[-S | --use-ssl]
[-Y | --sync-standbys=число_синхронных_ведомых_серверов]
[-y | --sync-standbys-min=мин_число_синхронных_ведомых_серверов]Инициализирует кластер и задаёт узел-лидер. При выполнении этой команды bihactl запускает утилиту initdb. На этом этапе также можно указать необходимые параметры этой утилиты при помощи флага -o.
Эта команда может принимать следующие параметры:
-C--convert#Преобразовывает существующий узел в узел-лидер отказоустойчивого кластера.
-Dкаталог_данных--pgdata=#каталог_данныхУказывает каталог, где будет храниться кластер баз данных.
-fфайл_с_магической_строкой--magic-file=#файл_с_магической_строкойИспользует файл с «магической» строкой, содержащей закодированные данные, для подключения к узлу-лидеру.
-hадрес_узла--host=#адрес_узлаУказывает адрес узла для входящих соединений.
-Iid_узла--biha-node-id=#id_узлаУказывает уникальный идентификатор узла.
-Mмин_число_узлов--minnodes=#мин_число_узловУказывает минимальное число работающих узлов, при котором узел-лидер будет доступен для пишущих транзакций. Если параметр не задан, его значение будет равно значению параметра
nquorum.-Nзначение_кворума--nquorum=#значение_кворумаУказывает число работающих узлов, участвующих в голосовании по выбору нового лидера. Рекомендуется задавать значение параметра больше половины числа узлов в кластере, чтобы узел-лидер мог быть избран простым большинством голосов. Например, если планируется создать кластер из 5 узлов, рекомендуется задавать значение кворума 3.
-oпараметры_initdb--options=#параметры_initdbДополнительно указывает параметры утилиты initdb.
-pпорт--port=#портУказывает порт узла для входящих соединений. Если порт не указан, он берётся из
postgresql.confили используется значение по умолчанию — 5432.-Pпорт_biha--biha-port=#порт_bihaУказывает порт для обмена служебной информацией между узлами. Если порт не указан, устанавливается значение
port+ 1-S--use-ssl#Включает защищённый режим передачи служебной информации между узлами кластера по протоколу SSL/TLS управляющего канала biha.
-Yчисло_синхронных_ведомых_серверов--sync-standbys=#число_синхронных_ведомых_серверовУказывает число синхронных узлов-последователей для подключения к узлу-лидеру. Рекомендуется задавать значение этого параметра меньше значения параметра
--minnodes. За подробной информацией обратитесь к разделу Настройка кворумной синхронной и асинхронной репликации.-yмин_число_синхронных_ведомых_серверов--sync-standbys-min=#мин_число_синхронных_ведомых_серверовЗадаёт минимальное число синхронных последователей, которые должны быть доступны, чтобы лидер продолжал работу. Значение должно быть меньше, чем
--sync-standbys, и не может быть отрицательным. Если параметр не указан, BiHA-кластер работает в соответствии с ограничениями синхронной репликации по умолчанию, то есть лидер будет оставаться недоступным для операций на запись, пока все последователи не догонят его текущее состояние.
status #
Синтаксис:
bihactl status [-f | --magic-file=файл_с_магической_строкой] [-h | --host=адрес_узла] [-p | --port=порт] [-s | --magic-string=магическая_строка]
Проверяет статус узла и отображает его в представлении biha.status_v. Эта команда может принимать следующие параметры:
-fфайл_с_магической_строкой--magic-file=файл_с_магической_строкойИспользует файл с «магической» строкой, содержащей закодированные данные, для подключения к узлу-лидеру.
-hадрес_узла--host=адрес_узлаУказывает адрес узла для входящих соединений.
-pпорт--port=портУказывает порт узла для входящих соединений. Если порт не указан, он берётся из
postgresql.confили используется значение по умолчанию — 5432.-sмагическая_строка--magic-string=магическая_строкаИспользует «магическую» строку, содержащую закодированные данные, для подключения к узлу-лидеру.
-V | --version #
Синтаксис:
bihactl -V bihactl --version
Выводит текущую версию отказоустойчивого кластера.