Обзор команд pxf

Антон Монаков

Команды pxf используются для управления сервисом PXF на хосте Greengage DB.

Синтаксис команды в общем виде выглядит следующим образом:

$ pxf <command> [<option>]

где <command> — одна из следующих команд.

Команда Описание

Команда	Описание
help	Выводит справочную информацию о команде `pxf`
cluster	Осуществляет централизованное управление сервисами PXF на всех хостах Greengage DB. Более подробную информацию можно получить в статье pxf cluster
init	(Устаревшая команда) Эквивалентна команде `register` и будет удалена в будущих релизах PXF
migrate	Производит миграцию конфигурации PXF 5 из каталога $PXF_CONF в каталог $PXF_BASE на хосте. При запуске команды требуется указать каталог конфигурации PXF 5 с помощью переменной окружения `PXF_CONF`. PXF мигрирует конфигурацию версии 5 в каталог $PXF_BASE, копируя и объединяя каталоги по необходимости. Обратите внимание, что все измененные настройки из файла pxf-log4j.properties необходимо вручную перенести в файл pxf-log4j2.xml
prepare	Копирует шаблоны файлов конфигурации в каталог $PXF_BASE на каждом хосте Greengage DB. Каталог должен быть указан с помощью переменной окружения `PXF_BASE`
register	Копирует файлы расширения PXF из каталога установки PXF в каталог установки Greengage DB на хосте. Чтобы выполнить команду, требуется, чтобы была установлена переменная окружения `GPHOME`. Команда запускается один раз после установки PXF или обновления Greengage DB
reset	(Устаревшая команда) Не производит никаких действий и будет удалена в будущих релизах PXF
restart	Перезапускает сервис PXF на текущем хосте Greengage DB
start	Запускает сервис PXF на текущем хосте Greengage DB
status	Отображает статус сервиса PXF на текущем хосте Greengage DB. Используйте опцию `-p` (`--process`), чтобы проверить только то, что сервис PXF запущен, а не то, что он отвечает на запросы
stop	Останавливает сервис PXF на текущем хосте Greengage DB
sync <gphost>	Синхронизирует конфигурацию PXF ($PXF_BASE) между мастер-хостом и прочими хостами Greengage DB. Команда должна запускаться на мастер-хосте, при этом требуется указать значение `<gphost>`, определяющее резервный мастер-хост или сегмент-хост. По умолчанию при выполнении команды копируются и обновляются файлы на целевом хосте. Чтобы PXF также удалял файлы во время синхронизации, используйте опцию `-d` (`--delete`). Если опция указана, все файлы на резервном мастер-хосте и сегмент-хостах, отсутствующие при этом на мастер-хосте, будут удалены. При обновлении пользовательской конфигурации PXF или добавлении новых JAR- или нативных зависимостей требуется перезапустить PXF после синхронизации конфигурации
encrypt <password> <encryptor_type>	Шифрует предоставленный пароль (`<password>`), используя указанный тип шифрователя (`<encryptor_type>`), по умолчанию `aes256`. Для работы команды требуется, чтобы в каталоге $PXF_BASE/lib присутствовал JAR-файл библиотеки шифрователя, а в конфигурационном файле pxf-application.properties были указаны свойства `pxf.ssl.jks-store.path`, `pxf.ssl.jks-store.password` и `pxf.ssl.salt.key`. Значения этих свойств можно переопределить с помощью соответствующих опций `-jksPath`, `-jksPassword` и `-jksEncryptKeyAlias` команды. Команду можно запустить со следующими опциями: `-command <command_type>` — тип команды: `encrypt` (шифрование) или `decrypt` (расшифровывание). `-message` — пароль, который требуется зашифровать. `-encryptionKey` — ключ шифрования. `-encryptorType` — тип шифрователя, по умолчанию `aes256`. `-jksEncryptKeyAlias` — псевдоним ключа шифрования в хранилище ключей Java (keystore). `-jksPassword` — пароль хранилища ключей Java. `-jksPath` — путь к хранилищу ключей Java. Полученную зашифрованную строку затем можно использовать в качестве значения `jdbc.password` в конфигурационном файле JDBC-сервера
version	Отображает версию PXF

help

Выводит справочную информацию о команде pxf

cluster

Осуществляет централизованное управление сервисами PXF на всех хостах Greengage DB. Более подробную информацию можно получить в статье pxf cluster

init

(Устаревшая команда) Эквивалентна команде register и будет удалена в будущих релизах PXF

migrate

Производит миграцию конфигурации PXF 5 из каталога $PXF_CONF в каталог $PXF_BASE на хосте. При запуске команды требуется указать каталог конфигурации PXF 5 с помощью переменной окружения PXF_CONF. PXF мигрирует конфигурацию версии 5 в каталог $PXF_BASE, копируя и объединяя каталоги по необходимости. Обратите внимание, что все измененные настройки из файла pxf-log4j.properties необходимо вручную перенести в файл pxf-log4j2.xml

prepare

Копирует шаблоны файлов конфигурации в каталог $PXF_BASE на каждом хосте Greengage DB. Каталог должен быть указан с помощью переменной окружения PXF_BASE

Копирует файлы расширения PXF из каталога установки PXF в каталог установки Greengage DB на хосте. Чтобы выполнить команду, требуется, чтобы была установлена переменная окружения GPHOME. Команда запускается один раз после установки PXF или обновления Greengage DB

reset

(Устаревшая команда) Не производит никаких действий и будет удалена в будущих релизах PXF

restart

Перезапускает сервис PXF на текущем хосте Greengage DB

start

Запускает сервис PXF на текущем хосте Greengage DB

status

Отображает статус сервиса PXF на текущем хосте Greengage DB. Используйте опцию -p (--process), чтобы проверить только то, что сервис PXF запущен, а не то, что он отвечает на запросы

stop

Останавливает сервис PXF на текущем хосте Greengage DB

sync <gphost>

Синхронизирует конфигурацию PXF ($PXF_BASE) между мастер-хостом и прочими хостами Greengage DB. Команда должна запускаться на мастер-хосте, при этом требуется указать значение <gphost>, определяющее резервный мастер-хост или сегмент-хост.

По умолчанию при выполнении команды копируются и обновляются файлы на целевом хосте. Чтобы PXF также удалял файлы во время синхронизации, используйте опцию -d (--delete). Если опция указана, все файлы на резервном мастер-хосте и сегмент-хостах, отсутствующие при этом на мастер-хосте, будут удалены.

При обновлении пользовательской конфигурации PXF или добавлении новых JAR- или нативных зависимостей требуется перезапустить PXF после синхронизации конфигурации

encrypt <password> <encryptor_type>

Шифрует предоставленный пароль (<password>), используя указанный тип шифрователя (<encryptor_type>), по умолчанию aes256. Для работы команды требуется, чтобы в каталоге $PXF_BASE/lib присутствовал JAR-файл библиотеки шифрователя, а в конфигурационном файле pxf-application.properties были указаны свойства pxf.ssl.jks-store.path, pxf.ssl.jks-store.password и pxf.ssl.salt.key. Значения этих свойств можно переопределить с помощью соответствующих опций -jksPath, -jksPassword и -jksEncryptKeyAlias команды.

Команду можно запустить со следующими опциями:

-command <command_type> — тип команды: encrypt (шифрование) или decrypt (расшифровывание).
-message — пароль, который требуется зашифровать.
-encryptionKey — ключ шифрования.
-encryptorType — тип шифрователя, по умолчанию aes256.
-jksEncryptKeyAlias — псевдоним ключа шифрования в хранилище ключей Java (keystore).
-jksPassword — пароль хранилища ключей Java.
-jksPath — путь к хранилищу ключей Java.

Полученную зашифрованную строку затем можно использовать в качестве значения jdbc.password в конфигурационном файле JDBC-сервера

version

Отображает версию PXF

JDBC

pxf cluster