Модуль community.aws.ecs_taskdefinition_info — описание определения задачи в ECS
Примечание
Этот модуль входит в коллекцию community.aws (версия 10.1.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.34.0
- botocore >= 1.34.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
aws_ca_bundle путь | Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логическое значение | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url строка | URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
profile псевдонимы: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region строка | Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка | Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
session_token псевдонимы: aws_session_token строка | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды Параметры session_token и profile являются взаимоисключающими. |
task_definition строка / обязательный | Имя определения задачи, сведения о котором необходимо получить |
validate_certs логическое значение | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Сведения о параметрах и возвращаемых значениях см. в документации: http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для подключаемых модулей поиска и соединения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
- Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» 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 |
Количество единиц CPU, зарезервированных для контейнера. Возвращается: всегда |
|
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 |
Массив строк с командой, которую выполняет контейнер для определения своего состояния. Возвращается: при успешном выполнении |
|
interval integer |
Интервал в секундах между выполнениями проверки состояния. Возвращается: при успешном выполнении |
|
retries integer |
Количество повторных попыток после неудачной проверки состояния, прежде чем контейнер будет признан неисправным. Возвращается: при успешном выполнении |
|
startPeriod integer |
Необязательный льготный период, предоставляемый контейнерам для запуска до начала регистрации неудачных проверок. Возвращается: при успешном выполнении |
|
timeout integer |
Время ожидания в секундах успешного завершения проверки состояния, после которого она считается неудачной. Возвращается: при успешном выполнении |
|
hostname string |
Имя хоста, используемое для контейнера. Возвращается: при наличии |
|
image string |
Образ, используемый для запуска контейнера. Возвращается: всегда |
|
links string |
Связи с другими контейнерами. Возвращается: при наличии |
|
logConfiguration string |
Спецификация конфигурации журналирования контейнера. Возвращается: при наличии |
|
memoryReservation integer |
Мягкий лимит объёма памяти (в МиБ), резервируемой для контейнера. Возвращается: при наличии |
|
mountPoints complex |
Точки монтирования томов данных в контейнере. Возвращается: всегда |
|
containerPath string |
Путь в контейнере, по которому монтируется том хоста. Возвращается: при наличии |
|
readOnly boolean |
Если это значение равно true, контейнер имеет доступ к тому только для чтения. Если это значение равно false, контейнер может записывать данные в том. Возвращается: при наличии |
|
sourceVolume string |
Имя монтируемого тома. Возвращается: при наличии |
|
name string |
Имя контейнера. Возвращается: всегда |
|
options string |
Параметры конфигурации, передаваемые драйверу журналирования. Возвращается: при наличии |
|
portMappings complex |
Список сопоставлений портов контейнера. Возвращается: всегда |
|
containerPort integer |
Номер порта в контейнере. Возвращается: при наличии |
|
hostPort integer |
Номер порта экземпляра контейнера, резервируемого для контейнера. Возвращается: при наличии |
|
protocol string |
Протокол, используемый для сопоставления портов. Возвращается: при наличии |
|
privileged boolean |
Если значение этого параметра равно true, контейнер получает повышенные привилегии на экземпляре контейнера хоста (аналогично пользователю root). Возвращается: при наличии |
|
readonlyRootFilesystem boolean |
Если значение этого параметра равно true, контейнер получает доступ к корневой файловой системе только для чтения. Возвращается: при наличии |
|
resourceRequirements dictionary |
Тип и количество ресурса, выделяемого контейнеру. Возвращается: при наличии |
|
type string |
Тип ресурса, выделяемого контейнеру. Возвращается: при успешном выполнении |
|
value string |
Значение для указанного типа ресурса. Возвращается: при успешном выполнении |
|
systemControls dictionary |
Список параметров ядра с пространствами имён, которые следует задать в контейнере. Возвращается: при наличии |
|
namespace string |
Пространство имён ядра. Возвращается: при успешном выполнении |
|
value string |
Значение для пространства имён ядра. Возвращается: при успешном выполнении |
|
ulimits complex |
Список ограничений ulimit, задаваемых в контейнере. Возвращается: при наличии |
|
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 |
Выражение языка запросов кластера, применяемое к ограничению. Возвращается: если присутствует |
|
type string |
Тип ограничения. Возвращается: если присутствует |
requires_attributes complex | Атрибуты экземпляра контейнера, необходимые для задачи Возвращается: если присутствует |
|
name string |
Имя атрибута. Возвращается: если присутствует |
|
targetId string |
Идентификатор целевого объекта. Возвращается: если присутствует |
|
targetType string |
Тип целевого объекта, к которому следует прикрепить атрибут. Возвращается: если присутствует |
|
value string |
Значение атрибута. Возвращается: если присутствует |
revision integer | Номер запрошенной редакции Возвращается: всегда |
status string | Статус определения задачи Возвращается: всегда |
task_definition_arn string | ARN определения задачи Возвращается: всегда |
task_role_arn string | ARN роли IAM, которую могут принимать контейнеры в этой задаче Возвращается: если указана роль |
volumes complex | Список томов в задаче Возвращается: всегда |
|
host boolean |
Содержимое параметра host определяет, сохраняется ли том данных на экземпляре контейнера хоста и где он хранится. Возвращается: если присутствует |
|
name string |
Имя тома. Возвращается: если присутствует |
|
source_path string |
Путь на экземпляре контейнера хоста, доступный контейнеру. Возвращается: если присутствует |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/ecs_taskdefinition_info_module.html