Перейти к основному содержимому
Версия: 8.1

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

monqctl - утилита управления сервисами Monq. При помощи данной утилиты производится установка, обновление и конфигурация микросервисов Monq в кластере Kubernetes.

Установка monqctl

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

Информация

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

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

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

    curl -LO https://downloads.monq.ru/tools/monqctl/`curl -s https://downloads.monq.ru/tools/monqctl/latest.txt`/linux-x64/monqctl.zip
    Windows

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

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

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

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

    curl -LO https://downloads.monq.ru/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.

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

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

    monqctl config set instance monq.domain.com --server=http://registry.api.monq.domain.com
  2. Добавьте токен доступа в реестр микросервисов для управления Monq:

    TOKEN=$(kubectl get secrets -n production registry-token -o jsonpath='{.data.secure_token}' | base64 -d)
    monqctl config set credential monq-user --registry-token=${TOKEN}
  3. Добавьте токен доступа в ReleaseHub для получения обновлений:

    monqctl config set releasehub monq-release-hub --token=<token>
Токен приходит на почту вместе с лицензионным ключом (в том числе с пробным)
  1. Сконфигурируйте контекст, который связывает экземпляр Monq, разрешение доступа и Monq ReleaseHub для доступа к обновлениям:

    monqctl config set context monq.domain.com --instance=monq.domain.com --credential=monq-user --releasehub=monq-release-hub
  2. Установите текущий контекст экземпляра Monq, с которым будет взаимодействовать клиент управления monqctl:

    monqctl config use-context monq.domain.com 

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

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

monqctl [options] [command]

Опции:

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

Команды:

КомандаОписаниеСправка
configКоманда для работы с конфигурацией monqctlmonqctl config -h
registryКоманда для работы с реестром микросервисовmonqctl registry -h
releaseКоманда для работы с обновлениями Monqmonqctl release -h
instanceКоманда управления текущим экземпляром Monqmonqctl instance -h
installerКоманда для работы с образами установкиmonqctl installer -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
deleteСлужебная команда для удаления микросервисов Monqmonqctl registry delete -h

Команда monqctl release

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

monqctl [options] release [command]

Опции:

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

Команды:

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

Команда monqctl instance

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

monqctl [options] instance [command]

Опции:

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

Команды:

КомандаОписаниеСправка
clearКоманда очистки сущностей Monqmonqctl instance clear -h
execКоманда запуска миграций с БД Monqmonqctl instance exec -h
getКоманда получения информации об инстансе Monqmonqctl instance get -h
restartКоманда для перезапуска сервисов Monqmonqctl instance restart -h
createКоманда для добавления новых модулей в Monqmonqctl instance create -h
deleteКоманда для удаления очередей и подписок к ним в Monqmonqctl instance delete -h
resetКоманда сброса пароля администратора Monqmonqctl instance reset -h

Команда monqctl installer

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

monqctl [options] installer [command]

Опции:

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

Команды:

КомандаОписаниеСправка
version listКоманда для получения списка доступных версий установщикаmonqctl installer version -h
version download <version>Команда для загрузки доступной версии Monqmonqctl installer download -h

Обязательные параметры:

  • --token <update-token> - токен для получения обновлений Monq

Команда 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>

Переименовать alias пользователя 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>