Spec-Zone.ru › AWS CLI v2

[ aws . opsworks ]

create-deployment

Описание

Выполняет команды развертывания или управления стеком. Дополнительную информацию см. в разделах Развертывание приложений и Выполнение команд управления стеком.

Требуемые разрешения: для использования этого действия пользователь IAM должен иметь уровень разрешений «Развернуть» или «Управлять» для стека, или прикрепленный политикой, которая явно предоставляет разрешения. Дополнительную информацию о разрешениях пользователей см. в разделе Управление разрешениями пользователей.

См. также: Документация по API AWS

Синтаксис

  create-deployment
--stack-id <value>
[--app-id <value>]
[--instance-ids <value>]
[--layer-ids <value>]
--command <value>
[--comment <value>]
[--custom-json <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--stack-id (строка)

Идентификатор стека.

--app-id (строка)

Идентификатор приложения. Этот параметр обязателен для развертывания приложений, но не обязателен для других команд развертывания.

--instance-ids (список)

Идентификаторы экземпляров для целей развертывания.

(строка)

Синтаксис:

"string" "string" ...

--layer-ids (список)

Идентификаторы слоев для целей развертывания.

(строка)

Синтаксис:

"string" "string" ...

--command (структура)

Объект DeploymentCommand, который определяет команду развертывания и любые связанные аргументы.

Имя -> (строка)

Указывает операцию. Можно указать только одну команду.

Для стеков доступны следующие команды:

  • execute_recipes: Выполнить одну или несколько рецептов. Для указания рецептов установите параметр Args с именем recipes в список рецептов, которые нужно выполнить. Например, для выполнения phpapp::appsetup, установите Args в значение {"recipes":["phpapp::appsetup"]}.
  • install_dependencies: Установить зависимости стека.
  • update_custom_cookbooks: Обновить пользовательские кулинарные книги стека.
  • update_dependencies: Обновить зависимости стека.

Примечание

Команды update_dependencies и install_dependencies поддерживаются только для экземпляров Linux. Вы можете успешно выполнить команды на экземплярах Windows, но они ничего не сделают.

Для приложений доступны следующие команды:

  • deploy: Развернуть приложение. Приложения Ruby on Rails имеют необязательный параметр Args с именем migrate. Установите Args в {“migrate”:[“true”]} для миграции базы данных. Значение по умолчанию — {“migrate”:[“false”]}.
  • rollback: Вернуть приложение к предыдущей версии. При обновлении приложения OpsWorks Stacks сохраняет предыдущую версию, до максимального значения в пять версий. С помощью этой команды вы можете вернуть приложение до четырех предыдущих версий.
  • start: Запустить веб-сервер или прикладной сервер приложения.
  • stop: Остановить веб-сервер или прикладной сервер приложения.
  • restart: Перезапустить веб-сервер или прикладной сервер приложения.
  • undeploy: Снять приложение с развертывания.

Аргументы -> (карта)

Аргументы тех команд, которые принимают аргументы. Должно быть установлено в JSON-объект со следующим форматом:

{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}

Команда upgrade_os_to принимает два аргумента:

  • upgrade_os_to — Указывает версию Amazon Linux, которую вы хотите запустить на экземплярах, например, Amazon Linux 2. Также необходимо установить аргумент allow_reboot в значение true.
  • allow_reboot — Указывает, разрешить ли OpsWorks Stacks перезагрузить экземпляры при необходимости после установки обновлений. Этот аргумент может быть установлен в значения true или false. Значение по умолчанию — false.

Например, чтобы обновить экземпляр до Amazon Linux 2018.03, установите Args в следующее значение.

{ "upgrade_os_to":["Amazon Linux 2018.03"], "allow_reboot":["true"] }

ключ -> (строка)

значение -> (список)

(строка)

Сокращенный синтаксис:

Name=string,Args={KeyName1=string,string,KeyName2=string,string}

Синтаксис JSON:

{
  "Name": "install_dependencies"|"update_dependencies"|"update_custom_cookbooks"|"execute_recipes"|"configure"|"setup"|"deploy"|"rollback"|"start"|"stop"|"restart"|"undeploy",
  "Args": {"string": ["string", ...]
    ...}
}

--comment (строка)

Пользовательский комментарий.

--custom-json (строка)

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

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

Дополнительную информацию о пользовательском JSON см. в разделах Использование пользовательского JSON для изменения атрибутов конфигурации стека и Переопределение атрибутов с помощью пользовательского JSON.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения будут переопределять значения из JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. При отсутствии значения или указании значения input выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при указании значения yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. При указании значения output он проверит входные данные команды и вернет JSON-пример выходных данных для данной команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в генерируемом JSON-скелете.

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

--debug (логическое значение)

Включить отладку регистрации.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

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

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

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

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого файла, которое отображается как двоичный блок, fileb:// всегда будет обрабатываться как двоичный, и будет использоваться содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file://, содержимое файла должно быть должным образом отформатировано для настроенной cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров входных данных CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования unix-подобного типа. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Пример 1: Развертывание приложений и выполнение команд управления стеком

В следующих примерах показано, как использовать команду create-deployment для развертывания приложений и выполнения команд управления стеком. Обратите внимание, что символы кавычек (") в JSON-объекте, который определяет команду, все предваряются символами экранирования (\). Без символов экранирования команда может вернуть ошибку недействительного JSON.

Следующий пример create-deployment развертывает приложение в указанном стеке.

aws opsworks create-deployment \
    --stack-id cfb7e082-ad1d-4599-8e81-de1c39ab45bf \
    --app-id 307be5c8-d55d-47b5-bd6e-7bd417c6c7eb
    --command "{\"Name\":\"deploy\"}"

Вывод:

{
    "DeploymentId": "5746c781-df7f-4c87-84a7-65a119880560"
}

Пример 2: Развертывание приложения Rails и миграция базы данных

Следующая команда create-deployment развертывает приложение Ruby on Rails в указанный стек и выполняет миграцию базы данных.

aws opsworks create-deployment \
    --stack-id cfb7e082-ad1d-4599-8e81-de1c39ab45bf \
    --app-id 307be5c8-d55d-47b5-bd6e-7bd417c6c7eb \
    --command "{\"Name\":\"deploy\", \"Args\":{\"migrate\":[\"true\"]}}"

Вывод:

{
    "DeploymentId": "5746c781-df7f-4c87-84a7-65a119880560"
}

Дополнительную информацию о развертывании см. в разделе Развертывание приложений в Руководстве пользователя AWS OpsWorks.

Пример 3: Выполнение рецепта

Следующая команда create-deployment выполняет пользовательский рецепт phpapp::appsetup на экземплярах в указанном стеке.

aws opsworks create-deployment \
    --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb \
    --command "{\"Name\":\"execute_recipes\", \"Args\":{\"recipes\":[\"phpapp::appsetup\"]}}"

Вывод:

{
    "DeploymentId": "5cbaa7b9-4e09-4e53-aa1b-314fbd106038"
}

Дополнительную информацию см. в разделе Выполнение команд управления стеком в Руководстве пользователя AWS OpsWorks.

Пример 4: Установка зависимостей

Следующая команда create-deployment устанавливает зависимости, такие как пакеты или Ruby gems, на экземплярах в указанном стеке.

aws opsworks create-deployment \
    --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb \
    --command "{\"Name\":\"install_dependencies\"}"

Вывод:

{
    "DeploymentId": "aef5b255-8604-4928-81b3-9b0187f962ff"
}

Дополнительную информацию см. в разделе Выполнение команд управления стеком в Руководстве пользователя AWS OpsWorks.

Вывод

DeploymentId -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API