CycleCloud CLI

Интерфейс командной строки Azure CycleCloud позволяет управлять установкой из консоли или файла скриптов.

Глобальные параметры CLI

Эти параметры доступны для всех команд.

-h, --help

Отображает сообщение справки и завершает работу.

-v, --version

Отображает версию интерфейса командной строки.

--config=CONFIG_FILE

Указывает путь к файлу конфигурации, отличному от default, который будет использоваться для этой команды.

--loglevel=LOG_LEVEL

Задает уровень журнала по умолчанию для интерфейса командной строки.

учетная запись cyclecloud

Управление учетными записями поставщика облачных служб.

cyclecloud account <command> [-o OUTPUT_FILE]
                             [--dry-run]
                             [-f INPUT_FILE]
                             [--force]

subcommand	описание
list	Список учетных записей.
show <account_name>	Отображение сведений об учетной записи.
create	Создайте новую учетную запись.
edit <account_name>	Изменение существующей учетной записи.
delete <account_name>	Удаление существующей учетной записи.

список учетных записей cyclecloud

Список учетных записей.

cyclecloud account list

отображение учетной записи cyclecloud

Отображение сведений об учетной записи.

cyclecloud account show <account_name>

создание учетной записи cyclecloud

Создайте новую учетную запись.

cyclecloud account create [-o OUTPUT_FILE]
                          [--dry-run]
                          [-f INPUT_FILE]

-o OUTPUT_FILE

Записывает параметры конфигурации на диск

--dry-run

Запрашивает и проверяет информацию, но не принимает никаких изменений.

-f INPUT_FILE

Считывает определение из файла конфигурации вместо запроса

изменение учетной записи cyclecloud

Изменение существующей учетной записи.

cyclecloud account edit <account_name> [-o OUTPUT_FILE]
                                       [--dry-run]
                                       [-f INPUT_FILE]

-o OUTPUT_FILE

Записывает параметры конфигурации на диск.

--dry-run

Запрашивает и проверяет информацию, но не принимает никаких изменений.

-f INPUT_FILE

Считывает определение из файла конфигурации вместо запроса.

удаление учетной записи cyclecloud

Удаление существующей учетной записи.

cyclecloud account delete <account_name> [--force]

--force

Если значение true, не запрашивает удаление учетной записи.

cyclecloud add_node

Добавляет дополнительные узлы в кластер.

cyclecloud add_node <CLUSTER> [--template=TEMPLATE]
                              [--count=COUNT]
                              [--fixed]

-t TEMPLATE, --template=TEMPLATE

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

-c COUNT, --count=COUNT

Сколько узлов нужно запустить. Если значение не указано, значение по умолчанию равно 1.

-f, --fixed

Если задано, узел постоянно добавляется (пока не удаляется) в шаблон кластера. В противном случае узел автоматически удаляется при завершении.

конфигурация CycleCloud

Легко переключаться между конфигурациями cyclecloud.

cyclecloud config <command>

Subcommand	Описание
show	Отображение текущей конфигурации.
list	Список доступных конфигураций.
create <config_name>	Создайте новую конфигурацию.
rename <old_name> <new_name>	Переименуйте существующую конфигурацию.
use <config_name>	Переключитесь на указанную конфигурацию.
remove <config_name>	Удалите именованную конфигурацию.

показать конфигурацию cyclecloud

Отображение текущей конфигурации.

cyclecloud config show

список конфигураций cyclecloud

Список доступных конфигураций.

cyclecloud config list

создание конфигурации cyclecloud

Создайте новую конфигурацию.

cyclecloud config create <config_name>

переименование конфигурации cyclecloud

Переименуйте существующую конфигурацию.

cyclecloud config rename <old_name> <new_name>

использование конфигурации cyclecloud

Переключитесь на указанную конфигурацию.

cyclecloud config use <config_name>

cyclecloud config remove — удалить конфигурацию

Удалите именованную конфигурацию.

cyclecloud config remove <config_name>

cyclecloud connect

Подключается к работающему экземпляру в кластере. По состоянию на 7.8 имя может быть именем узла, именем хоста или IP-адресом.

cyclecloud connect <NAME> [--keyfile=KEYFILE]
                          [--cluster=CLUSTER]
                          [--user=USER]
                          [--bastion-host=BASTION-HOST]
                          [--bastion-port=BASTION-PORT]
                          [--bastion-user=BASTION-USER]
                          [--bastion-key=BASTION-KEY]

-k KEYFILE, --keyfile=KEYFILE

Пара ключей, используемая, если она не указана на узле или узел не существует.

-c CLUSTER, --cluster=CLUSTER

Кластер, в котором находится узел, если указано имя узла. Необязательный вариант, если не существует нескольких узлов с одинаковым именем.

-u USER, --user=USER

Пользователь должен войти в узел.

--bastion-host=BASTION-HOST

Узел SSH-бастиона для маршрутизации подключений.

--bastion-port=BASTION-PORT

Порт SSH для подключения к бастиону.

--bastion-user=BASTION-USER

Имя пользователя для подключения к бастиону.

--bastion-key=BASTION-KEY

Файл закрытого ключа для подключения к бастиону.

cyclecloud copy_cluster

Создает копию кластера.

cyclecloud copy_cluster <source_cluster_name> <new_cluster_name> [--parameters=PARAMETERS]

-p PARAMETERS, --parameters=PARAMETERS

Используемый файл параметров.

cyclecloud create_cluster (создать кластер)

Создает кластер из существующего шаблона.

cyclecloud create_cluster <TEMPLATE> <NAME> [--force]
                                            [--parameters=PARAMETERS]
                                            [--parameter-override=PARAMETER_OVERRIDE]

--force

Если он указан, кластер заменяется, если он существует.

-p PARAMETERS, --parameters=PARAMETERS

Используемый файл параметров.

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

Добавление или переопределение определенного параметра. Этот параметр имеет приоритет над значениями, указанными в -p.

учетные данные CycleCloud

Управление учетными данными учетной записи поставщика облачных служб.

cyclecloud credential <command>

Subcommand	Описание
list	Список учетных данных.
create	Создайте новую учетную запись.
edit <account_name>	Измените существующие учетные данные.
delete <account_name>	Удалите существующие учетные данные.

список учетных данных cyclecloud

Список учетных данных.

cyclecloud credential list

создать учетные данные CycleCloud

Создайте новую учетную запись.

cyclecloud credential create

изменение учетных данных cyclecloud

Измените существующие учетные данные.

cyclecloud credential edit <account_name>

удаление учетных данных cyclecloud

Удалите существующие учетные данные.

cyclecloud credential delete <account_name>

cyclecloud delete_cluster

Удалить неработающий кластер.

cyclecloud delete_cluster <CLUSTER> [--recursive]
                                    [--force]

-r, --recursive

Рекурсивно удалите этот кластер и все его подкластеры.

--force

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

cyclecloud delete_template

Удаление шаблона кластера.

cyclecloud delete_template <TEMPLATE>

Параметры экспорта cyclecloud

Экспорт параметров для данного кластера.

cyclecloud export_parameters <cluster_name> [-o OUTPUT_FILE]
                                            [--format=OUTPUT_FORMAT]

-o OUTPUT_FILE

Для создания записывает параметры кластера на диск.

--format=OUTPUT_FORMAT

Формат вывода.

изображение CycleCloud

Управление пользовательскими изображениями.

cyclecloud image <command> [--account=ACCOUNTS]
                           [--name=NAME]
                           [--label=LABEL]
                           [--package-version=PACKAGE_VERSION]
                           [--bump-version=BUMP_VERSION]
                           [--os=OS]
                           [--jetpack-version=JETPACK_VERSION]
                           [--install-jetpack]
                           [--jetpack-platform=JETPACK_PLATFORM]
                           [--dry-run]

Subcommand	Описание
add <image_name> [...]	Добавьте один или несколько изображений.

Добавление образа CycleCloud

Добавьте один или несколько изображений.

cyclecloud image add <image_name> [...] [--account=ACCOUNTS]
                                        [--name=NAME]
                                        [--label=LABEL]
                                        [--package-version=PACKAGE_VERSION]
                                        [--bump-version=BUMP_VERSION]
                                        [--os=OS]
                                        [--jetpack-version=JETPACK_VERSION]
                                        [--install-jetpack]
                                        [--jetpack-platform=JETPACK_PLATFORM]
                                        [--dry-run]

--account=ACCOUNTS

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

--name=NAME

Имя создаваемого пакета. Этот параметр является обязательным.

--label=LABEL

Метка создаваемого пакета.

--package-version=PACKAGE_VERSION

Используйте эту версию для нового образа вместо 1.0.0.0 по умолчанию.

--bump-version=BUMP_VERSION

Используйте --bump-version minor, чтобы увеличить последнюю минорную версию на 1 (например, с 1.1 до 1.2), или используйте --bump-version major или --bump-version patch.

--os=OS

Используется --os linux/windows для указания операционной системы на изображении.

--jetpack-version=JETPACK_VERSION

Версия Jetpack, которая установлена или должна быть установлена на образе.

--install-jetpack

Установите Jetpack в процессе выполнения на этом образе.

--jetpack-platform=JETPACK_PLATFORM

Платформа Jetpack, используемая на изображении (например, centos-7, ubuntu-14.04, windows).

--dry-run

Ищет соответствующие изображения, но не хранит сведения о изображении.

cyclecloud import_cluster

Создает кластер из текстового файла. Если кластер не указан и файл содержит один кластер, используется имя этого кластера.

cyclecloud import_cluster [CLUSTER] [-c TEMPLATE]
                                    [--force]
                                    [--as-template]
                                    [--file=FILE]
                                    [--parameters=PARAMETERS]
                                    [--parameter-override=PARAMETER_OVERRIDE]
                                    [--recursive]

-c TEMPLATE

Кластер в файле для импорта. Если он не указан, используется имя нового кластера.

--force

Если он указан, кластер заменяется, если он существует.

-t, --as-template

При указании кластер хранится в виде шаблона, который можно использовать только для создания других кластеров.

-f FILE, --file=FILE

Файл для импорта шаблона.

-p PARAMETERS, --parameters=PARAMETERS

Используемый файл параметров.

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

Добавление или переопределение определенного параметра. Имеет приоритет перед значениями, указанными в -p.

-r, --recursive

Импортирует именованный кластер и все кластеры в файле, для которого он является родительским.

cyclecloud import_template

Импортирует шаблон кластера из текстового файла. Если имя не задано, а файл имеет один кластер, используется имя этого кластера.

cyclecloud import_template [NAME] [-c TEMPLATE]
                                  [--force]
                                  [--file=FILE]

-c TEMPLATE

Шаблон в файле для импорта. Если это не указано, используется имя нового шаблона.

--force

Если он указан, шаблон заменяется, если он существует.

-f FILE, --file=FILE

Файл для импорта шаблона.

инициализация CycleCloud

Инициализирует параметры CycleCloud.

cyclecloud initialize [--batch]
                      [--force]
                      [--url=URL]
                      [--username=USERNAME]
                      [--password=PASSWORD]
                      [--verify-ssl=VERIFY-SSL]
                      [--name=NAMED_CONFIG]

--batch

Если задано, аргументы должны быть предоставлены в командной строке. Считается, что ответы на вопросы – "нет".

--force

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

--url=URL

Базовый URL-адрес для установки CycleServer.

--username=USERNAME

Имя пользователя для установки CycleServer.

--password=PASSWORD

Пароль для установки CycleServer.

--verify-ssl=VERIFY-SSL

Нужно ли проверять (true) или нет (false) SSL-сертификаты при установке CycleServer.

--name=NAMED_CONFIG

Создайте именованную конфигурацию, которую можно использовать с командой конфигурации.

cyclecloud locker

Управляйте хранилищами CycleCloud.

cyclecloud locker <command>

Subcommand	Описание
list	Список хранилищ.
show <locker>	Отображение сведений о хранилище.

список хранилищ cyclecloud

Список шкафчиков.

cyclecloud locker list

показать cyclecloud locker

Показать детали шкафчика.

cyclecloud locker show <locker>

проект cyclecloud

Управление проектами CycleCloud.

cyclecloud project <command> [--skip-teardown]
                             [--output-json=JSON_FILE]
                             [--junit-xml=JUNIT_FILE]
                             [--extra-var=EXTRA_VARS]
                             [--template=TEMPLATE]
                             [--name=CLUSTER_NAME]
                             [--global]
                             [--project-version=PROJECT_VERSION]
                             [--build-dir=BUILD_DIR]

Subcommand	Описание
init <name>	Создайте пустой проект.
fetch <url> <path>	Копировать проект из репозитория GitHub <URL-адреса> в <указанный путь>.
info	Отображение сведений о проекте.
add_spec <spec>	Добавьте спецификацию в проект.
default_locker <locker>	Установите хранилища по умолчанию для загрузки.
test	Выполните тест интеграции для заданного определения кластера.
build	Создайте проект.
upload [locker]	Сборка и загрузка проекта в указанные локеры (используется значение по умолчанию, если не указано).
download [locker]	Скачайте большие двоичные объекты проекта из указанных хранилищ (используются значения по умолчанию, если они не указаны).
generate_template <file>	Создайте шаблон кластера для проекта, записанный в <файл>.

инициализация проекта cyclecloud

Создайте пустой проект.

cyclecloud project init <name>

получение проекта cyclecloud

Загружает проект из GitHub <url> в <path>.

cyclecloud project fetch <url> <path>

сведения о проекте cyclecloud

Отображает сведения о проекте.

cyclecloud project info

add_spec проекта cyclecloud

Добавляет спецификацию в проект.

cyclecloud project add_spec <spec>

default_locker проекта cyclecloud

Задает хранилище по умолчанию для отправки.

cyclecloud project default_locker <locker> [--global]

--global

Задайте глобальное значение по умолчанию вместо конкретного значения проекта.

тест проекта cyclecloud

Выполняет тест интеграции для определения кластера.

cyclecloud project test [--skip-teardown]
                        [--output-json=JSON_FILE]
                        [--junit-xml=JUNIT_FILE]
                        [--extra-var=EXTRA_VARS]
                        [--template=TEMPLATE]
                        [--name=CLUSTER_NAME]

--skip-teardown

Пропустить разрыв кластера, созданного для тестирования.

--output-json=JSON_FILE

Выводит результаты в указанный json-файл.

--junit-xml=JUNIT_FILE

Выводит результаты в формате junit-xml в указанный json-файл.

-e EXTRA_VARS, --extra-var=EXTRA_VARS

Произвольные пары key=value, используемые для параметризации шаблона кластера при тестировании.

-t TEMPLATE, --template=TEMPLATE

Путь к файлу шаблона кластера.

-n CLUSTER_NAME, --name=CLUSTER_NAME

Имя конфигурации кластера для тестирования.

сборка проекта cyclecloud

Создайте проект.

cyclecloud project build [--project-version=PROJECT_VERSION]
                         [--build-dir=BUILD_DIR]

--project-version=PROJECT_VERSION

Переопределите версию проекта, присутствующую в project.ini.

--build-dir=BUILD_DIR

Каталог сборки.

загрузка проекта CycleCloud

Сборка и загрузка проекта в указанные локеры (используется значение по умолчанию, если не указано).

cyclecloud project upload [locker] [--project-version=PROJECT_VERSION]

--project-version=PROJECT_VERSION

Переопределите версию проекта, указанную в project.ini.

скачивание проекта cyclecloud

Скачайте файлы blobs проекта из указанных хранилищ. Если вы не указываете блокировщики, команда использует блокировщики по умолчанию.

cyclecloud project download [locker]

generate_template проекта cyclecloud

Создайте шаблон кластера для проекта. Команда записывает шаблон в <file>.

cyclecloud project generate_template <file>

cyclecloud reboot_node (перезагрузка_узла)

Перезагрузите запущенный узел.

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

Команда cyclecloud remove_node

Удалите узел из кластера. Команда завершает узел, если он запущен.

cyclecloud remove_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
                                             [--instance-filter=INSTANCE_FILTER]
                                             [--creds=CREDS]
                                             [--no-prompt]
                                             [--force]

-f FILTER, --filter=FILTER

Удалите узлы, которые соответствуют полному выражению class-ad.

--instance-filter=INSTANCE_FILTER

Удалите узлы с активными инстанциями, соответствующими полному выражению класса-ad.

--creds=CREDS

Удалите узлы, которые вы запустили с использованием именованного набора учетных данных.

--no-prompt

Если задано, узлы, отобранные по фильтру, завершаются без запроса подтверждения.

--force

Принудительно удалите этот узел, даже если он не завершён. Используйте этот параметр, только если ресурсы для этого узла в поставщике облачных служб уже завершены.

повторная попытка cyclecloud

Повторные попытки инициализации для именованного кластера завершились неудачей.

cyclecloud retry <CLUSTER> [--recursive]

-r, --recursive

Рекурсивно повторите параметры в этом кластере и всех его подкластерах.

cyclecloud show_cluster

Отображает кластер или кластеры в CycleCloud.

cyclecloud show_cluster <CLUSTER> [--recursive]
                                  [--long]
                                  [--templates]

-r, --recursive

Отображение этого кластера и всех его подкластеров.

-l, --long

Перечисляет каждый узел, а не отображает сводку.

-t, --templates

Включите шаблоны кластеров в выходные данные.

cyclecloud show_nodes

Отображение сведений о выбранных узлах или экземплярах.

cyclecloud show_nodes [NAME] [--attrs=ATTRS]
                             [--filter=FILTER]
                             [--instance-filter=INSTANCE_FILTER]
                             [--output=OUTPUT]
                             [--format=FORMAT]
                             [--creds=CREDS]
                             [--cluster=CLUSTER]
                             [--states=STATES]
                             [--long]
                             [--summary]

-a ATTRS, --attrs=ATTRS

Отображение указанного набора атрибутов (разделенный запятыми список).

-f FILTER, --filter=FILTER

Отображение только узлов, соответствующих полному выражению class-ad.

--instance-filter=INSTANCE_FILTER

Показывать только узлы с активными экземплярами, соответствующими полному выражению class-ad.

--output=OUTPUT

Выводит соответствующие атрибуты узла, описанные строкой формата именованных параметров Python. Например: --output="Name: %(Name)s\t(ID: %(InstanceId)s)\n Cluster: %(ClusterName)s\n".

--format=FORMAT

Измените формат отображения выходных данных [xml | json | текст].

--creds=CREDS

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

-c CLUSTER, --cluster=CLUSTER

Показывать только узлы в указанном кластере.

--states=STATES

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

-l, --long

Отображение полного class-ad представления узла.

-s, --summary

Отобразите минимальное представление узла.

cyclecloud start_cluster

Запускает именованный кластер.

cyclecloud start_cluster <CLUSTER> [--recursive]
                                   [--test]

-r, --recursive

Рекурсивно запустите этот кластер и все его подкластеры.

-t, --test

Запуск кластера в тестовом режиме.

cyclecloud start_node

Запускает остановленные узлы в работающем кластере.

cyclecloud start_node <CLUSTER> <NODE_NAME>

cyclecloud terminate_cluster (команда для завершения работы кластера)

Прекращает работу именованного кластера.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

-r, --recursive

Рекурсивно прекратите этот кластер и все его подкластеры.

cyclecloud terminate_node

Завершает запущенный узел (но оставляет его в кластере).

cyclecloud terminate_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
                                                [--instance-filter=INSTANCE_FILTER]
                                                [--creds=CREDS]
                                                [--no-prompt]

-f FILTER, --filter=FILTER

Завершите узлы, соответствующие полному выражению class-ad.

--instance-filter=INSTANCE_FILTER

Завершать узлы с активными экземплярами, которые соответствуют полному class-ad выражению.

--creds=CREDS

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

--no-prompt

Если задано, не запрашивает подтверждение перед завершением узлов на основе фильтра.