Вернуться

Jelastic CLI

Интерфейс командной строки Jelastic CLI является инструментом, который предназначен для упрощения взаимодействия с вашей учетной записью облачной платформы путем выполнения необходимых команд непосредственно с локального компьютера. Это позволяет обрабатывать подавляющее большинство доступных операций дистанционно, дополняя широкий спектр возможностей предоставляемых с помощью графического интерфейса панели управления и Jelastic API.

Основное преимущество данного клиента — это передовые и относительно простые средства автоматизации, которые позволяют использовать CLI разработчикам. Простой текст командной строки может быть легко объединен в скрипты, создавая мощные механизмы для решения различных задач: от автоматизации наиболее распространенных и частых операций до мониторинга приложений и управления DevOps процессами.

Установка CLI

Для того чтобы установить Jelastic CLI на локальный компьютер необходимо в терминале выполнить следующую команду:

curl -s ftp://ftp.jelastic.com/pub/cli/jelastic-cli-installer.sh | bash

заранее убедитесь, что у вас установлена Java версии 1.7 и выше;
в случае, если вы используете операционную систему Windows, вам необходимо сначала установить Unix-подобную среду и интерфейс командной строки для Microsoft Windows (например Cygwin), с помощью которого вы сможете выполнить все необходимые команды.

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

~ $ touch /home/name/.config/jelastic/jelastic.properties

где {name} — имя вашей директории.

Начало работы

Jelastic CLI представляет собой исполняемый .jar архив и ряд предварительно сконфигурированных команд (bash скриптов) для его работы. С их помощью вы сможете контролировать, управлять и автоматизировать работу вашего окружения.

для начала необходимо пройти процедуру аутентификации. Аутентификация может быть инициирована следующей командой:

~/jelastic/environment/control/getenvs

Далее укажите следующие значения:

Platform URL — app.jelastic.regruhosting.ru;
Email — логин (email) вашей учетной записи;
Password — пароль учетной записи.

Если введенные данные верны, вы увидите логотип Jelastic и версию используемой в данный момент платформы:

Jelastic cli 1

Аутентификация может быть также инициирована вручную ( например, если вам нужно переключить текущий сеанс или войти под другим пользователем ) соответствующей командой:

~/jelastic/users/authentication/signin --login {email} --password {password} --platformUrl {platform_url}

В данном случае, выделенные строки должны быть заменены соответствующими параметрами учетной записи (которые описаны выше):

Jelastic cli 2

Если вход произведен успешно, полученный ответ будет включать в себя параметр: «result»: 0

Информация об актуальной сессии пользователя (т.е адрес платформы и ваши учетные данные) хранятся в автоматически генерируемом файле ~/.config/jelastic/jelastic.properties, которые извлекаются при необходимости. Это позволяет сконцентрироваться на выполняемых операциях без повторения шага авторизации.

если вы ранее не сталкивались с Jelastic API, вам потребуется информация о структуре интерфейса командной строки. Вы можете получить доступ к справочной информации, выполнив команду:

~/jelastic/jelastic-help

Jelastic cli 3

для того, чтобы получить список всех возможных операций для конкретного метода, необходимо выполнить следующую команду:

ls ~/jelastic/environment/control

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

Jelastic cli 4

для получения более подробной информации о конкретной операции, запустите ее без заданных параметров:

Jelastic cli 5

Установленный CLI клиент будет регулярно проверять наличие обновлений, поэтому, когда станет доступна новая версия, вы увидите соответствующее уведомление с инструкцией о необходимых действиях.

Примеры использования

Обеспечивая полнофункциональное дистанционное управление, Jelastic CLI работает со всеми типами окружений и приложений, и поддерживает все необходимые операции, от самых простых до самых сложных. Ниже приведены несколько примеров его использования:

Запуск/Остановка окружения

Наиболее распространенными операциями для управления окружением являются его запуск и остановка.

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

~/jelastic/environment/control/stopenv --envName {env_name}

где {env_name} — название окружения.

Jelastic cli 6

Ответ «result»: 0 означает, что операция прошла успешно и без ошибок;

для запуска окружения необходимо выполнить следующую команду:

~/jelastic/environment/control/startenv --envName {env_name}

Jelastic cli 7

Переустановка Docker-контейнера

Окружения основанные на Docker-стандарте также полностью поддерживают интерфейс командной строки. В качестве примера рассмотрим обновление версии шаблона для одного контейнера или одновременно для группы контейнеров.

для начала узнаем список доступных версий для шаблона:

~/jelastic/environment/control/getdockertags --image {template_name} [--userName {login}] [--password {password}]

где {template_name} — идентификатор шаблона;
{login} и {password} — необязательные параметры, указываются в случае использования пользовательского репозитория.

Если соответствующий шаблон находится в Hub-регистре, имя хоста может быть пропущено (в нашем случае jelastic/wordpress-db). В противном случае потребуется указание полного имени:

Jelastic cli 8

В нашем случае доступны две версии шаблона: default и latest;

далее вам необходимо узнать уникальные идентификаторы узлов с помощью команды:

~/jelastic/environment/control/getenvinfo --envName {env_name} | grep -B 5 {image} | grep id

В нашем примере доступен один контейнер с указанным шаблоном:

Jelastic cli 9

далее выберите контейнер, который вы хотите обновить:

~/jelastic/environment/control/redeploycontainerbyid --envName {env_name} --nodeId {node_id} --tag {tag}

где {env_name} — название окружения;
{node_id} — идентификатор узла, который должен быть обновлен;
{tag} — версия шаблона.

Если вам потребуется обновить версию шаблона для группы контейнеров, необходимо использовать следующую команду:

~/jelastic/environment/control/redeploycontainersbygroup --envName {env_name} --nodeGroup {group_id} --tag {tag} [--sequential {true/false}]

где {group_id} — идентификатор группы узлов (его можно узнать, выполнив приведенную во втором пункте команду с указанием параметра -A 30 {image} | grep nodeGroup).
sequential — является не обязательной опцией (определяет значение true/false) Это позволяет остальным узлам продолжать обрабатывать входящие запросы, в то время как запускается обновление, для обеспечения доступности услуг.

Этот процесс может занять несколько минут, дождитесь пока он будет завершен:

Jelastic cli 10