Документация

# monqctl. Клиент управления monq

# Установка monqctl

Установку клиента управления monq можно произвести на любой сервер под управление Linux или Windows.

Информация

По умолчанию в распространяемом образе monq - клиент управления monq уже установлен и частично сконфигурирован.

Дополнительно, для работы с обновлениями monq необходимо добавить в конфигурацию monqctl токен доступа к обновлениям ReleaseHub - шаг №3 конфигурации.

  1. Загрузите последнюю версию Клиента управления MONQ из нашего репозитория:

    curl -LO https://downloads.monqlab.com/tools/monqctl/`curl -s https://downloads.monqlab.com/tools/monqctl/latest.txt`/linux-x64/monqctl.zip

    Windows

    Ссылка для загрузки версии monqctl для Windows - скачать (opens new window)

    Чтобы загрузить определенную версию monqctl ...

    Вставьте в фрагмент команды вместо
    $(curl -s https://downloads.monqlab.com/tools/monqctl/latest.txt)
    нужную версию.

    Например, команда загрузки версии v1.1.0 для Linux будет выглядеть следующим образом:

    curl -LO https://downloads.monqlab.com/tools/monqctl/v1.1.0/linux-x64/monqctl.zip

  2. Разархивируйте полученный файл:

    #debian based distribs
sudo apt-get install unzip
#redhat based distribs
sudo yum install unzip

unzip monqctl.zip

  3. Сделайте двоичный файл monqctl исполняемым:

    chmod +x ./monqctl

  4. Переместите двоичный файл в директорию из переменной окружения $PATH:

    sudo mv ./monqctl /usr/local/bin/monqctl

  5. Убедитесь, что установлена последняя версия monqctl:

    monqctl --version

# Настройка monqctl

Для начала работы с monqctl требуется выполнить конфигурацию контекста программы для использования с конкретным экземпляром monq.

Конфигурация токена доступа к обновлениям

При конфигурации monqctl вам потребуется токен для доступа в ReleaseHub. Его требуется получить, обратившись в поддержку monq.

Предположим, что ваш экземпляр monq расположен по следующему адресу: monq.domain.com и вам необходимо произвести конфигурацию monqctl. Для этого выполните следующие действия:

  1. Добавьте экземпляр monq в конфигурацию контекста:

    monqctl config set instance monq.domain.com --server=http://pl-microservice-registry.api.monq.domain.com

  2. Добавьте разрешение для доступа к экземпляру monq. Токены в ранних версиях реестра микросервисов не используется:

    monqctl config set credential monq-user

  3. Добавьте токен доступа в ReleaseHub для получения обновлений:

    monqctl config set releasehub monq-release-hub --token=<token>

  4. Сконфигурируйте контекст, который связывает экземпляр monq, разрешение доступа и MONQ ReleaseHub для доступа к обновлениям:

    monqctl config set context monq.domain.com --instance=monq.domain.com --credential=monq-user --releasehub=monq-release-hub

  5. Установите текущий контекст экземпляра monq, с которым будет взаимодействовать клиент управления monqctl:

    monqctl config use-context monq.domain.com

# Основные команды monqctl

Использование:

monqctl [options] [command]

Опции:

Опция Описание
--version Показать текущую версию программы monqctl
-?, -h, --help Показать справку

Команды:

Команда Описание Справка
config Команда для работы с конфигурацией monqctl monqctl config -h
registry Команда для работы с реестром микросервисов monqctl registry -h
release Команда для работы с обновлениями monq monqctl release -h
instance Команда управления текущим инстансом monq monqctl instance -h

# Команда monqctl registry

Использование:

monqctl [options] registry [command]

Опции:

Опция Описание
-?, -h, --help Показать справку

Команды:

Команда Описание Справка
get Команда получение статусов и информации из реестра микросервисов monqctl registry get -h
apply Команда для применения конфигураций микросервисов monqctl registry apply -h
update Команда для обновления версии реестра микросервисов monqctl registry update -h
export Команда для экспорта обновления из ReleaseHub в папку monqctl registry export -h

# Команда monqctl release

Использование:

monqctl [options] release [command]

Опции:

Опция Описание
-?, -h, --help Показать справку

Команды:

Команда Описание Справка
update Команда обновления объектов ППО текущей инсталяции monqctl release update -h
version Команда для работы с доступными версиями monq monqctl release version -h
use-version <version> Команда для выбора устанавливаемой версии обновления monqctl release use-version -h
current-version Команда для получения текущей версии monq monqctl release current-version -h

# Команда monqctl instance

Использование:

monqctl [options] instance [command]

Опции:

Опция Описание
-?, -h, --help Показать справку

Команды:

Команда Описание Справка
clear Команда очистки сущностей monq monqctl instance clear -h
exec Команда запуска миграций с БД monq monqctl instance exec -h
get Команда получения информации об инстансе monq monqctl instance get -h

# Команда monqctl config

# Команда GET

# Получить список экземпляров monq

monqctl config get instances

# Получить подробную информацию по экземпляру monq

monqctl config get instances <Name of instance>

# Получить список пользователей из конфигурации

monqctl config get credentials

# Получить подробную информацию о пользователе

monqctl config get credentials <Name of credential>

# Получить список настроенных ReleaseHub из конфигурации

monqctl config get releasehubs

# Получить подробную информацию по ReleaseHub

monqctl config get releasehubs <Name of ReleaseHub>

# Получить список настроенных контекстов

monqctl config get contexts

# Получить подробную информацию по контексту

monqctl config get contexts <Name of context>

# Команда RENAME

# Переименовать экземпляр monq в конфигурации

monqctl config rename instance <old-instance> <new-instance>

# Переименовать алиас пользователя monq в конфигурации

monqctl config rename credential <old-user> <new-user>

# Переименовать ReleaseHub в конфигурации

monqctl config rename releasehub <old-release-hub> <new-release-hub>

# Переименовать экземпляр monq в конфигурации

monqctl config rename context <old-smon> <new-smon>

# Команда DELETE

# Удалить настроенный экземпляр monq из конфигурации

monqctl config delete instance <Name of instance>

# Удалить пользователя из конфигурации

monqctl config delete credential <Name of credential>

# Удалить релиз-хаб из конфигурации

monqctl config delete releasehub <Name of releasehub>

# Удалить контекст из конфигурации

monqctl config delete context <Name of context>

# Общие команды

# Показать конфигурационный файл полностью

monqctl config view

# Показать текущий контекст

monqctl config current-context

# Установить текущий контекст экземпляра, с которым будет производится работа

monqctl config use-context <Name of context>