Вернуться наверх

Обзор ​

MWS CLI — консольная утилита для создания и управления ресурсами MWS. Реализована в формате скачиваемого программного обеспечения, совместима с популярными ОС. Поддерживает управление сервисами MWS Cloud Platform.

Полный список поддерживаемых сервисов можно узнать в справке (после установки):

bash
mws --help

Ключевые особенности ​

  • Управление ресурсами облака
    С помощью MWS CLI можно просматривать список существующих ресурсов, а также создавать новые и управлять ими. Дополнительно поддерживаются сервисные команды, например, запрос на список подключенных сервисов в проекте. Доступ для выполнения операций основан на ролевой модели MWS.

  • Несколько профилей
    Можно создать несколько профилей с разными полномочиями. На уровне профиля настраиваются параметры по умолчанию — проект и зона доступности.

  • Несколько вариантов входных и выходных форматов
    Доступные форматы запросов — JSON и YAML, ответов — JSON, YAML и табличный (TXT).

  • Логирование всех действий
    Все действия MWS CLI логируются и могут быть записаны в отдельный файл на устройстве.

  • Кроссплатформенность
    MWS CLI устанавливается и поддерживается в операционных системах Linux, Windows и MacOS.

  • Встроенная справка
    Поддерживаемый синтаксис и возможные команды можно узнать с помощью флага --help.

Как работает утилита ​

Для начала работы с утилитой ее необходимо скачать и установить на устройство. После установки команды MWS CLI можно запускать через инструменты командной строки.

Для работы с MWS CLI вы можете использовать любые оболочки. Указанные ниже оболочки поддерживают автоматическое заполнение (autocomplete):

  • Linux или MacOS: bash, zsh, fish.
  • Windows: PowerShell.

После установки должна быть выполнена инициализация первого профиля и его привязка к сервисному аккаунту. После этого каждый запрос через MWS CLI авторизуется от имени этого сервисного аккаунта. Ролевые модели профиля и сервисного аккаунта совпадают.

Синтаксис команд MWS CLI для управления ресурсами облака:

bash
mws <сервис> <ресурс> <операция> <флаги>

Пример команды для просмотра списка ВМ в Compute:

bash
mws compute vm list --project=test_project

Типы флагов:

  • Глобальные — применимы ко всем командам MWS CLI. С помощью таких флагов можно указать, например, формат входных и выходных данных или настройки логирования запроса.
  • Локальные — уникальны для каждой команды. Например, флаг --order-by задаст способ сортировки вывода для команды mws compute vm list.

Примечание

Перечисленные типы не взаимоисключающие — для одной команды можно указать одновременно как глобальные, так и локальные флаги.

Значения некоторых глобальных флагов можно задать с помощью параметров профиля как значения по умолчанию. Например, вы можете указать ваш проект и зону доступности. Значения этих флагов будут автоматически применяться при выполнении команд.

MWS CLI поддерживает следующие типы операций управления ресурсами:

  • list — просмотр списка ресурсов, по умолчанию список выводится в виде таблицы;
  • get — получение подробной информации о ресурсе;
  • create — создание ресурса;
  • update — внесение изменений в ресурс;
  • delete — удаление ресурса.

Операции create и update предполагают добавление объектов с данными (по аналогии с POST и PUT HTTP-запросами). MWS CLI поддерживает входные и выходные данные в форматах JSON, YAML или TXT (файлом или в командной строке). Формат можно изменить в любом из запросов, передав соответствующий флаг.

Операции get, update и delete принимают идентификатор ресурса или его референс в качестве аргумента. Если референс содержит дополнительную информацию об идентификации ресурса, она будет использована в запросе. Например, при выполнении команды mws compute disk get projects/example/disks/mydisk MWS CLI автоматически определит, что требуется вывести информацию о диске mydisk в проекте example. Формат референса вы можете узнать, запросив команду с флагом --help, например mws compute disk get --help.

Чтобы выполнять операции с MWS CLI от имени разных сервисных аккаунтов, необходимо создать дополнительные профили на каждый из аккаунтов. При разделении на профили возможно настроить отдельные параметры.

Все события могут быть добавлены в журнал, поддерживаемые уровни логирования:

  • info — информационные сообщения, например, результат выполнения команды;
  • debug — отладочная информация, например, трассировка (пошаговое выполнение команды);
  • warn — сообщения с предупреждениями о потенциальных проблемах.
  • error — сообщения с ошибками выполнения команды.

После установки MWS CLI регулярно проверяет наличие обновлений с возможностью настройки сообщений об автообновлении. Если утилита больше не используется, она может быть удалена.

Версионность ​

MWS CLI — версионируемое программное обеспечение, разные версии могут поддерживать отличные друг от друга команды.

Важно

Своевременно обновляйте версию MWS CLI при наличии обновлений. При возникновении ошибок обратитесь в техническую поддержку.

Квоты и лимиты ​

Для MWS CLI не действуют дополнительные ограничения, кроме ограничений самих сервисов.

Тарификация ​

Использование MWS CLI не тарифицируется.