CycleCloud CLI
Интерфейс командной строки Azure CycleCloud позволяет управлять установкой из консоли или файла скрипта.
Глобальные параметры CLI
Они доступны для всех команд.
-h, --help
отображение этого справочного сообщения и выход
-v, --version
Показывает версию интерфейса командной строки.
--config=CONFIG_FILE
Указывает путь к файлу конфигурации, отличному от используемого по умолчанию для этой команды.
--loglevel=LOG_LEVEL
Задает уровень журнала по умолчанию для интерфейса командной строки.
Учетная запись cyclecloud
Управление учетными записями поставщиков облачных служб.
cyclecloud account <command> [-o OUTPUT_FILE]
[--dry-run]
[-f INPUT_FILE]
[--force]
вложенная команда | description |
---|---|
list | перечисление учетных записей |
показать <account_name> | Отображение сведений об учетной записи |
create | создание учетной записи |
изменение <account_name> | изменение существующей учетной записи |
удаление <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>
вложенная команда | description |
---|---|
show | отображение текущей используемой конфигурации |
list | список доступных конфигураций |
создание <config_name> | создание новой конфигурации |
переименование <><old_name new_name> | переименование существующей конфигурации |
использование <config_name> | переключение на указанную конфигурацию |
удаление <config_name> | удаление именованной конфигурации |
cyclecloud config show
отображение текущей используемой конфигурации
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
Используемая keypair, если она не задана на узле или узле не существует.
-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>
вложенная команда | description |
---|---|
list | перечисление учетных данных |
create | создание новых учетных данных |
изменение <account_name> | изменение существующих учетных данных |
удаление <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 export_parameters
Экспорт параметров для заданного кластера.
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]
вложенная команда | description |
---|---|
добавить <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.
--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
Управление блокировщиками CycleCloud.
cyclecloud locker <command>
вложенная команда | description |
---|---|
list | списки блокировщиков |
показать <шкафчик> | Отображение сведений о хранилище |
Список раздевалок cyclecloud
списки блокировщиков
cyclecloud locker list
Cyclecloud Locker Show
Отображение сведений о хранилище
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]
вложенная команда | description |
---|---|
имя инициализации <> | создание пустого проекта |
Путь к URL-адресу><для выборки <> | извлекает проект из URL-адреса> GitHub <в <путь> |
сведения | отображение сведений о проекте |
<спецификация add_spec> | добавляет спецификацию в проект |
<default_locker шкафчик> | задает хранилища по умолчанию для отправки в |
номер | Выполнение теста интеграции для заданного определения кластера |
build; | сборка проекта |
upload [locker] | сборка и отправка проекта указанных locker(используется по умолчанию, если не указано) |
скачать [хранилище] | скачайте большие двоичные объекты проекта из указанных locker(используется по умолчанию, если не указано) |
<файл generate_template> | создание шаблона кластера для проекта, записанного в <файл> |
инициализация проекта cyclecloud
создание пустого проекта
cyclecloud project init <name>
Выборка проекта cyclecloud
Получение проекта из URL-адреса> Github <по <пути>
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
сборка и отправка проекта указанных locker(используется по умолчанию, если не указано)
cyclecloud project upload [locker] [--project-version=PROJECT_VERSION]
--project-version=PROJECT_VERSION
Переопределите версию проекта, присутствующих в project.ini
Скачивание проекта cyclecloud
скачайте большие двоичные объекты проекта из указанных locker(используется по умолчанию, если не указано)
cyclecloud project download [locker]
generate_template проекта cyclecloud
создание шаблона кластера для проекта, записанного в <файл>
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
Удалите узлы, соответствующие полному выражению класса ad.
--instance-filter=INSTANCE_FILTER
Удалите узлы с активными экземплярами, соответствующими полному выражению class-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
Отображение полного представления узла в объявлении класса.
-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
Завершение узлов, соответствующих полному выражению класса ad.
--instance-filter=INSTANCE_FILTER
Завершать узлы активными экземплярами, соответствующими полному выражению class-ad.
--creds=CREDS
Завершение работы узлов с использованием именованного набора учетных данных.
--no-prompt
Если этот параметр указан, не будет запрашивать подтверждение перед завершением узлов на основе фильтра.