Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

create-container-service-deployment

Описание

Создаёт развертывание для вашей Amazon Lightsail службы контейнеров.

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

Вы можете развертывать контейнеры в своей службе контейнеров, используя образы контейнеров из общедоступного реестра, например, Amazon ECR Public, или с вашего локального компьютера. Дополнительные сведения см. в разделе Создание образов контейнеров для ваших служб Amazon Lightsail контейнеров в Руководстве разработчика Amazon Lightsail.

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

Синтаксис

  create-container-service-deployment
--service-name <value>
[--containers <value>]
[--public-endpoint <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]

Параметры

--service-name (строка)

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

--containers (массив)

Объект, описывающий настройки контейнеров, которые будут запущены в службе контейнеров.

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

значение -> (структура)

Описывает настройки контейнера, который будет запущен или запущен в службе Amazon Lightsail контейнеров.

image -> (строка)

Имя образа для контейнера.

Образы контейнеров, полученные из вашей службы Lightsail контейнеров, зарегистрированные и хранящиеся в вашей службе, начинаются с двоеточия (: ). Например, если имя вашей службы контейнеров - container-service-1 , метка образа контейнера - mystaticsite , и вы хотите использовать третью (3 ) версию зарегистрированного образа контейнера, то вы должны указать :container-service-1.mystaticsite.3 . Чтобы использовать последнюю версию образа контейнера, укажите latest вместо номера версии (например, :container-service-1.mystaticsite.latest ). Lightsail автоматически будет использовать версию зарегистрированного образа контейнера с наибольшим номером.

Образы контейнеров, полученные из общедоступного реестра, такого как Docker Hub, не начинаются с двоеточия. Например, nginx:latest или nginx .

command -> (список)

Команда запуска контейнера.

(строка)

environment -> (массив)

Переменные среды контейнера.

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

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

ports -> (массив)

Открытые порты брандмауэра контейнера.

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

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

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

KeyName1=image=string,command=string,string,environment={KeyName1=string,KeyName2=string},ports={KeyName1=string,KeyName2=string},KeyName2=image=string,command=string,string,environment={KeyName1=string,KeyName2=string},ports={KeyName1=string,KeyName2=string}

Синтаксис JSON:

{"string": {
      "image": "string",
      "command": ["string", ...],
      "environment": {"string": "string"
        ...},
      "ports": {"string": "HTTP"|"HTTPS"|"TCP"|"UDP"
        ...}
    }
  ...}

--public-endpoint (структура)

Объект, описывающий настройки общедоступной точки входа для службы контейнеров.

containerName -> (строка)

Имя контейнера для точки входа.

containerPort -> (целое число)

Порт контейнера, на который перенаправляется трафик.

healthCheck -> (структура)

Объект, описывающий конфигурацию проверки состояния контейнера.

healthyThreshold -> (целое число)

Количество последовательных успешных проверок состояния, необходимых для перевода контейнера в состояние Healthy. Значение по умолчанию - 2.

unhealthyThreshold -> (целое число)

Количество последовательных неудачных проверок состояния, необходимых для перевода контейнера в состояние Unhealthy. Значение по умолчанию - 2.

timeoutSeconds -> (целое число)

Время в секундах, в течение которого отсутствие ответа означает неудачную проверку состояния. Вы можете указать значение от 2 до 60 секунд. Значение по умолчанию - 2.

intervalSeconds -> (целое число)

Приблизительный интервал в секундах между проверками состояния отдельного контейнера. Вы можете указать значение от 5 до 300 секунд. Значение по умолчанию - 5.

path -> (строка)

Путь в контейнере, на котором выполняется проверка состояния. Значение по умолчанию - /.

successCodes -> (строка)

HTTP-коды, используемые при проверке успешного ответа от контейнера. Вы можете указать значения от 200 до 499. Вы можете указать несколько значений (например, 200,202) или диапазон значений (например, 200-299).

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

containerName=string,containerPort=integer,healthCheck={healthyThreshold=integer,unhealthyThreshold=integer,timeoutSeconds=integer,intervalSeconds=integer,path=string,successCodes=string}

Синтаксис JSON:

{
  "containerName": "string",
  "containerPort": integer,
  "healthCheck": {
    "healthyThreshold": integer,
    "unhealthyThreshold": integer,
    "timeoutSeconds": integer,
    "intervalSeconds": integer,
    "path": "string",
    "successCodes": "string"
  }
}

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Вывод

containerService -> (структура)

Объект, описывающий контейнерную службу.

containerServiceName -> (строка)

Название контейнерной службы.

arn -> (строка)

Amazon Resource Name (ARN) контейнерной службы.

createdAt -> (отметка времени)

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

location -> (структура)

Объект, описывающий расположение контейнерной службы, например, регион и зону доступности Amazon Web Services.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимый).

regionName -> (строка)

Название региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса Lightsail для контейнерной службы.

tags -> (список)

Ключи тегов и необязательные значения для ресурса. Более подробную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail .

(структура)

Описывает ключ тега и необязательное значение, назначенные ресурсу Amazon Lightsail.

Более подробную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail .

key -> (строка)

Ключ тега.

Ограничения: ключи тегов принимают не более 128 букв, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: значения тегов принимают не более 256 букв, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

power -> (строка)

Технические характеристики мощности контейнерной службы.

Мощность определяет объем ОЗУ, количество виртуальных процессоров и базовую стоимость контейнерной службы.

powerId -> (строка)

Идентификатор мощности контейнерной службы.

state -> (строка)

Текущее состояние контейнерной службы.

Возможны следующие состояния контейнерной службы:

  • PENDING - Контейнерная служба создается.
  • READY - Контейнерная служба работает, но не имеет активного развертывания контейнеров.
  • DEPLOYING - Контейнерная служба запускает развертывание контейнеров.
  • RUNNING - Контейнерная служба работает и имеет активное развертывание контейнеров.
  • UPDATING - В процессе обновления емкости контейнерной службы или ее настраиваемых доменных имен.
  • DELETING - Контейнерная служба удаляется.
  • DISABLED - Контейнерная служба отключена, и ее активное развертывание и контейнеры, если таковые имеются, остановлены.

stateDetail -> (структура)

Объект, описывающий текущее состояние контейнерной службы.

Примечание

Подробности состояния заполняются только когда контейнерная служба находится в состоянии PENDING , DEPLOYING или UPDATING.

code -> (строка)

Код состояния контейнерной службы.

Возможны следующие коды состояния:

  • Если ваша контейнерная служба находится в состоянии DEPLOYING или UPDATING, возможны следующие коды состояний:
    • CREATING_SYSTEM_RESOURCES - Системные ресурсы вашей контейнерной службы создаются.
    • CREATING_NETWORK_INFRASTRUCTURE - Сеть инфраструктуры вашей контейнерной службы создается.
    • PROVISIONING_CERTIFICATE - Сертификат SSL/TLS для вашей контейнерной службы создается.
    • PROVISIONING_SERVICE - Ваша контейнерная служба предоставляет ресурсы.
    • CREATING_DEPLOYMENT - Развертывание создается на вашей контейнерной службе.
    • EVALUATING_HEALTH_CHECK - Оценивается состояние вашего развертывания.
    • ACTIVATING_DEPLOYMENT - Ваше развертывание активируется.
  • Если ваша контейнерная служба находится в состоянии PENDING, возможны следующие коды состояний:
    • CERTIFICATE_LIMIT_EXCEEDED - Сертификат SSL/TLS, необходимый для вашей контейнерной службы, превышает максимальное количество сертификатов, разрешенных для вашей учетной записи.
    • UNKNOWN_ERROR - При создании контейнерной службы произошла ошибка.

message -> (строка)

Сообщение, предоставляющее дополнительную информацию для кода состояния.

Примечание

Подробности состояния заполняются только когда контейнерная служба находится в состоянии PENDING , DEPLOYING или UPDATING.

scale -> (целое число)

Параметр масштабирования контейнерной службы.

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

currentDeployment -> (структура)

Объект, описывающий текущее развертывание контейнеров контейнерной службы.

version -> (целое число)

Номер версии развертывания.

state -> (строка)

Состояние развертывания.

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

  • ACTIVATING - Развертывание создается.
  • ACTIVE - Развертывание успешно создано и в настоящее время выполняется в контейнерной службе. Контейнерная служба может иметь только одно развертывание в активном состоянии одновременно.
  • INACTIVE - Развертывание было ранее успешно создано, но в настоящее время не выполняется в контейнерной службе.
  • FAILED - Развертывание завершилось ошибкой. Используйте действие GetContainerLog, чтобы просмотреть журналы событий контейнеров в развертывании и попытаться определить причину ошибки.

containers -> (карта)

Объект, описывающий конфигурацию контейнеров развертывания.

key -> (строка)

value -> (структура)

Описание настроек контейнера, который будет запущен или уже запущен в контейнерной службе Amazon Lightsail.

image -> (строка)

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

Изображения контейнеров, полученные из вашей контейнерной службы Lightsail, зарегистрированные и сохраненные в вашей службе, начинаются с двоеточия (: ). Например, если имя вашей контейнерной службы - container-service-1 , метка изображения контейнера - mystaticsite , и вы хотите использовать третью (3 ) версию зарегистрированного изображения контейнера, то вы должны указать :container-service-1.mystaticsite.3 . Для использования последней версии изображения контейнера укажите latest вместо номера версии (например, :container-service-1.mystaticsite.latest ). Lightsail автоматически будет использовать самую высокую версию зарегистрированного изображения контейнера.

Изображения контейнеров, полученные из общедоступного репозитория, например, Docker Hub, не начинаются с двоеточия. Например, nginx:latest или nginx.

command -> (список)

Команда запуска контейнера.

(строка)

environment -> (карта)

Переменные среды контейнера.

key -> (строка)

value -> (строка)

ports -> (карта)

Открытые порты брандмауэра контейнера.

key -> (строка)

value -> (строка)

publicEndpoint -> (структура)

Объект, описывающий конечную точку развертывания.

containerName -> (строка)

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

containerPort -> (целое число)

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

healthCheck -> (структура)

Объект, описывающий конфигурацию проверки работоспособности контейнера.

healthyThreshold -> (целое число)

Количество последовательных успешных проверок работоспособности, необходимых для перевода контейнера в состояние Healthy. Значение по умолчанию - 2.

unhealthyThreshold -> (целое число)

Количество последовательных неудачных проверок работоспособности, необходимых для перевода контейнера в состояние Unhealthy. Значение по умолчанию - 2.

timeoutSeconds -> (целое число)

Время в секундах, в течение которого отсутствие ответа означает проваленную проверку работоспособности. Можно указать от 2 до 60 секунд. Значение по умолчанию - 2.

intervalSeconds -> (целое число)

Приблизительный интервал в секундах между проверками работоспособности отдельного контейнера. Можно указать от 5 до 300 секунд. Значение по умолчанию - 5.

path -> (строка)

Путь в контейнере, на котором выполняется проверка работоспособности. Значение по умолчанию - /.

successCodes -> (строка)

HTTP-коды, используемые при проверке успешного ответа от контейнера. Можно указать значения от 200 до 499. Можно указать несколько значений (например, 200,202) или диапазон значений (например, 200-299).

createdAt -> (отметка времени)

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

nextDeployment -> (структура)

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

Это значение равно null, когда развертывание не находится в состоянии pending.

version -> (целое число)

Номер версии развертывания.

state -> (строка)

Состояние развертывания.

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

  • ACTIVATING - Развертывание создается.
  • ACTIVE - Развертывание успешно создано и в настоящее время работает в контейнерной службе. Контейнерная служба может иметь только одно развертывание в активном состоянии за раз.
  • INACTIVE - Развертывание ранее было успешно создано, но в настоящее время не работает в контейнерной службе.
  • FAILED - Развертывание завершилось с ошибкой. Используйте действие GetContainerLog, чтобы просмотреть события журнала для контейнеров в развертывании и попытаться определить причину ошибки.

containers -> (карта)

Объект, описывающий конфигурацию контейнеров развертывания.

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

значение -> (структура)

Описывает настройки контейнера, который будет запущен или запущен в контейнерной службе Amazon Lightsail.

image -> (строка)

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

Образы контейнеров, полученные из вашей контейнерной службы Lightsail, зарегистрированные и хранящиеся в вашей службе, начинаются с двоеточия (:). Например, если имя вашей контейнерной службы — container-service-1, метка образа контейнера — mystaticsite, и вы хотите использовать третью (3) версию зарегистрированного образа контейнера, вам следует указать :container-service-1.mystaticsite.3. Чтобы использовать последнюю версию образа контейнера, укажите latest вместо номера версии (например, :container-service-1.mystaticsite.latest). Lightsail автоматически будет использовать самую последнюю версию зарегистрированного образа контейнера.

Образы контейнеров, полученные из общедоступного репозитория, например, Docker Hub, не начинаются с двоеточия. Например, nginx:latest или nginx.

command -> (список)

Команда запуска контейнера.

(строка)

environment -> (карта)

Переменные среды контейнера.

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

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

ports -> (карта)

Открытые порты брандмауэра контейнера.

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

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

publicEndpoint -> (структура)

Объект, описывающий конечную точку развертывания.

containerName -> (строка)

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

containerPort -> (целое число)

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

healthCheck -> (структура)

Объект, описывающий конфигурацию проверки состояния контейнера.

healthyThreshold -> (целое число)

Число последовательных успешных проверок состояния, необходимое для перевода контейнера в состояние Healthy. Значение по умолчанию — 2.

unhealthyThreshold -> (целое число)

Число последовательных неудачных проверок состояния, необходимое для перевода контейнера в состояние Unhealthy. Значение по умолчанию — 2.

timeoutSeconds -> (целое число)

Время в секундах, в течение которого отсутствие ответа означает неудачную проверку состояния. Вы можете указать значение от 2 до 60 секунд. Значение по умолчанию — 2.

intervalSeconds -> (целое число)

Приблизительный интервал в секундах между проверками состояния отдельного контейнера. Вы можете указать значение от 5 до 300 секунд. Значение по умолчанию — 5.

path -> (строка)

Путь в контейнере, на котором выполняется проверка состояния. Значение по умолчанию — /.

successCodes -> (строка)

HTTP-коды, используемые при проверке успешного ответа от контейнера. Вы можете указать значения от 200 до 499. Вы можете указать несколько значений (например, 200,202) или диапазон значений (например, 200-299).

createdAt -> (метка времени)

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

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

Логическое значение, указывающее, отключена ли контейнерная служба.

principalArn -> (строка)

ARN принципала контейнерной службы.

ARN принципала может использоваться для создания отношений доверия между вашей стандартной учетной записью Amazon Web Services и вашей контейнерной службой Lightsail. Это позволяет предоставить вашей службе разрешение на доступ к ресурсам в вашей стандартной учетной записи Amazon Web Services.

privateDomainName -> (строка)

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

Приватное доменное имя доступно только для других ресурсов в виртуальной частной сети (VPC) по умолчанию вашей учетной записи Lightsail.

publicDomainNames -> (карта)

Общедоступное доменное имя контейнерной службы, такое как example.com и www.example.com.

Вы можете указать до четырех общедоступных доменных имен для контейнерной службы. Доменные имена, которые вы укажете, используются при создании развертывания с контейнером, настроенным как общедоступная конечная точка вашей контейнерной службы.

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

Предупреждение

Необходимо создать и проверить сертификат SSL/TLS перед использованием общедоступных доменных имен с контейнерной службой. Используйте действие CreateCertificate для создания сертификата для общедоступных доменных имен, которые вы хотите использовать с контейнерной службой.

См. CreateContainerService или UpdateContainerService, чтобы узнать, как указать общедоступные доменные имена для вашей контейнерной службы Lightsail.

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

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

(строка)

url -> (строка)

Общедоступный URL-адрес контейнерной службы.

Если в currentDeployment не указана общедоступная конечная точка, этот URL-адрес возвращает ответ 404.

privateRegistryAccess -> (структура)

Объект, описывающий конфигурацию контейнерной службы для доступа к репозиториям частных образов контейнеров, таким как приватные репозитории Amazon Elastic Container Registry (Amazon ECR).

Дополнительную информацию см. в разделе Настройка доступа к частному репозиторию Amazon ECR для контейнерной службы Amazon Lightsail в руководстве разработчика Amazon Lightsail.

ecrImagePullerRole -> (структура)

Объект, описывающий состояние активации роли, которую вы можете использовать для предоставления контейнерной службе Lightsail доступа к частным репозиториям Amazon ECR. Если роль активирована, также указан Amazon Resource Name (ARN) роли.

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

Логическое значение, указывающее, активирована ли роль.

principalArn -> (строка)

Amazon Resource Name (ARN) роли, если она активирована.

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

Spec-Zone.ru

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