Spec-Zone.ru › Ansible

Модуль community.aws.ecs_taskdefinition_info — Описание определения задачи в ECS

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные зависимости, см. Требования для подробностей.

Для использования в плейбуке укажите: community.aws.ecs_taskdefinition_info.

Добавлена в community.aws 1.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Описывает определение задачи в ECS.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

Идентификатор ключа доступа AWS.

Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключают друг друга.

Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

Расположение файла CA-сертификатов для проверки SSL-сертификатов.

Также может использоваться переменная среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

булево

Использование логгера botocore.endpoint для анализа уникальных (а не всех) "resource:action" API-вызовов, произведённых во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения книги задач.

Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только для AWS.

Также могут использоваться переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

profile

псевдонимы: aws_profile

строка

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

Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также может использоваться переменная среды AWS_PROFILE.

Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token.

region

псевдонимы: aws_region, ec2_region

строка

Используемый регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также могут использоваться переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key

строка

Секретный ключ доступа AWS.

Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключают друг друга.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_token

строка

Токен сессии AWS STS для использования с временными учетными данными.

Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключают друг друга.

Псевдонимы aws_session_token и session_token добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

task_definition

строка / обязательный

Имя определения задачи для получения подробных данных

validate_certs

boolean

При установке в false, сертификаты SSL для связи с API AWS не будут проверены.

Настройка validate_certs=false крайне не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Подробную информацию о параметрах и возвращаемых значениях см. на странице http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition
  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хоста», а не «контроллера». В связи с этим, файлы могут потребоваться скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллера», а не «хоста».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из конфигурационных файлов в контексте Ansible «хоста» (обычно ~/.aws/credentials). Более подробную информацию см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- community.aws.ecs_taskdefinition_info:
    task_definition: test-td

Возвращаемые значения

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

Ключ

Описание

container_definitions

complex

Возвращает список сложных объектов, представляющих контейнеры

Возвращено: успех

command

string

Команда, передаваемая в контейнер.

Возвращено: если присутствует

cpu

integer

Количество зарезервированных для контейнера единиц процессора.

Возвращено: всегда

disableNetworking

boolean

Когда этот параметр имеет значение true, сетевое взаимодействие в контейнере отключено.

Возвращено: если присутствует

dnsSearchDomains

string

Список доменов поиска DNS, предоставляемых контейнеру.

Возвращено: если присутствует

dnsServers

string

Список DNS-серверов, предоставляемых контейнеру.

Возвращено: если присутствует

dockerLabels

string

Котображение ключ/значение меток для добавления в контейнер.

Возвращено: если присутствует

dockerSecurityOptions

string

Список строк для предоставления пользовательских меток для систем многоуровневой безопасности SELinux и AppArmor.

Возвращено: если присутствует

entryPoint

string

Точка входа, передаваемая в контейнер.

Возвращено: если присутствует

environment

complex

Переменные среды для передачи в контейнер.

Возвращено: всегда

name

string

Имя переменной среды.

Возвращено: если присутствует

value

string

Значение переменной среды.

Возвращено: если присутствует

essential

boolean

Является ли это необходимым контейнером или нет.

Возвращено: всегда

extraHosts

complex

Список сопоставлений имен хостов и IP-адресов для добавления в файл /etc/hosts в контейнере.

Возвращено: если присутствует

hostname

string

Имя хоста для использования в записи /etc/hosts.

Возвращено: если присутствует

ipAddress

string

IP-адрес для использования в записи /etc/hosts.

Возвращено: если присутствует

firelensConfiguration

dictionary

Конфигурация FireLens для контейнера.

Возвращено: если присутствует

options

dictionary

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

Возвращено: успех

type

string

Маршрутизатор журналов.

Возвращено: успех

healthCheck

dictionary

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

Возвращено: если присутствует

command

list / elements=string

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

Возвращено: success

interval

integer

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

Возвращено: success

retries

integer

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

Возвращено: success

startPeriod

integer

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

Возвращено: success

timeout

integer

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

Возвращено: success

hostname

string

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

Возвращено: when present

image

string

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

Возвращено: always

links

string

Ссылки на другие контейнеры.

Возвращено: when present

logConfiguration

string

Спецификация конфигурации журнала для контейнера.

Возвращено: when present

memoryReservation

integer

Мягкий лимит (в MiB) памяти, который необходимо зарезервировать для контейнера.

Возвращено: when present

mountPoints

complex

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

Возвращено: always

containerPath

string

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

Возвращено: when present

readOnly

boolean

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

Возвращено: when present

sourceVolume

string

Имя монтируемого тома.

Возвращено: when present

name

string

Имя контейнера.

Возвращено: always

options

string

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

Возвращено: when present

portMappings

complex

Список сопоставлений портов для контейнера.

Возвращено: always

containerPort

integer

Номер порта в контейнере.

Возвращено: when present

hostPort

integer

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

Возвращено: when present

protocol

string

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

Возвращено: when present

privileged

boolean

Когда этот параметр равен true, контейнеру предоставляются повышенные привилегии на экземпляре контейнерного хоста (аналогично пользователю root).

Возвращается: при наличии

readonlyRootFilesystem

boolean

Когда этот параметр равен true, контейнеру предоставляется чтение-только доступ к корневой файловой системе.

Возвращается: при наличии

resourceRequirements

dictionary

Тип и количество ресурсов, которые нужно назначить контейнеру.

Возвращается: при наличии

type

string

Тип ресурса, который нужно назначить контейнеру.

Возвращается: при успехе

value

string

Значение для указанного типа ресурса.

Возвращается: при успехе

systemControls

dictionary

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

Возвращается: при наличии

namespace

string

Именное ядро.

Возвращается: при успехе

value

string

Значение для именного ядра.

Возвращается: при успехе

ulimits

complex

Список ulimits для настройки в контейнере.

Возвращается: при наличии

hardLimit

integer

Жесткое ограничение для типа ulimit.

Возвращается: при наличии

name

string

Тип ulimit.

Возвращается: при наличии

softLimit

integer

Мягкое ограничение для типа ulimit.

Возвращается: при наличии

user

string

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

Возвращается: при наличии

volumesFrom

complex

Тома данных для монтирования из другого контейнера.

Возвращается: всегда

readOnly

boolean

Если значение равно true, контейнер имеет чтение-только доступ к томам. Если значение равно false, контейнер может записывать в тома.

Возвращается: при наличии

sourceContainer

string

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

Возвращается: при наличии

workingDirectory

string

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

Возвращается: при наличии

family

string

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

Возвращается: всегда

network_mode

string

Режим сети для контейнеров

Возвращается: всегда

placement_constraints

complex

Список объектов ограничений размещения для использования в задачах

Возвращается: всегда

expression

string

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

Возвращается: при наличии

тип

строка

Тип ограничения.

Возвращается: при наличии

requires_attributes

сложное

Атрибуты экземпляра контейнера, необходимые для вашей задачи.

Возвращается: при наличии

имя

строка

Имя атрибута.

Возвращается: при наличии

targetId

строка

Идентификатор целевого объекта.

Возвращается: при наличии

targetType

строка

Тип целевого объекта, к которому нужно привязать атрибут.

Возвращается: при наличии

значение

строка

Значение атрибута.

Возвращается: при наличии

версия

целое число

Номер версии, который был запрошен.

Возвращается: всегда

состояние

строка

Состояние определения задачи.

Возвращается: всегда

task_definition_arn

строка

ARN определения задачи.

Возвращается: всегда

task_role_arn

строка

ARN роли IAM, которую могут использовать контейнеры в этой задаче.

Возвращается: если роль установлена

volumes

сложное

Список томов в задаче.

Возвращается: всегда

host

логическое

Содержимое параметра хоста определяет, сохраняется ли ваш том данных на экземпляре хост-контейнера и где он хранится.

Возвращается: при наличии

имя

строка

Имя тома.

Возвращается: при наличии

source_path

строка

Путь на экземпляре хост-контейнера, который предоставляется контейнеру.

Возвращается: при наличии

Авторы

  • Gustavo Maia (@gurumaia)
  • Mark Chance (@Java1Guy)
  • Darek Kaczynski (@kaczynskid)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/ecs_taskdefinition_info_module.html

Spec-Zone.ru

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