ecs_taskdefinition_facts - описание определения задачи в ecs
Новое в версии 2.5.
Обзор
- Описывает определение задачи в ecs.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- json
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | По умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key |
| aws_secret_key | По умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key |
| ec2_url | По умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. |
| profile (добавлено в 1.6) | По умолчанию: None | Использует профиль boto. Работает только с boto >= 2.24.0. |
| region | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token (добавлено в 1.6) | По умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token |
| task_definition обязательно | Имя определения задачи для получения подробных данных | |
| validate_certs (добавлено в 1.5) |
| Если установлено «нет», сертификаты SSL для boto версий >= 2.6.0 не будут проверяться. |
Примечания
Примечание
- Подробные сведения о параметрах и возвращаемых значениях см. на http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONможно использовать для указания региона AWS, если это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- ecs_taskdefinition_facts:
task_definition: test-td
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| container_definitions сложный | успех | Возвращает список сложных объектов, представляющих контейнеры | ||
| dnsSearchDomains строка | при наличии | Список доменных имён DNS, предоставленных контейнеру. | ||
| disableNetworking булево | при наличии | Если параметр имеет значение true, сеть внутри контейнера отключена. | ||
| links строка | при наличии | Ссылки на другие контейнеры. | ||
| mountPoints сложный | всегда | Точки монтирования томов данных в вашем контейнере. | ||
| sourceVolume строка | при наличии | Имя тома для монтирования. | ||
| readOnly булево | при наличии | Если значение равно true, контейнер имеет только чтение для тома. Если значение равно false, контейнер может записывать в том. | ||
| containerPath строка | при наличии | Путь в контейнере для монтирования хост-тома. | ||
| image строка | всегда | Изображение, используемое для запуска контейнера. | ||
| logConfiguration строка | при наличии | Спецификация конфигурации логов для контейнера. | ||
| dockerSecurityOptions строка | при наличии | Список строк для предоставления пользовательских меток для систем многоуровневой безопасности SELinux и AppArmor. | ||
| entryPoint строка | при наличии | Точка входа, передаваемая контейнеру. | ||
| user строка | при наличии | Имя пользователя, используемое внутри контейнера. | ||
| essential булево | всегда | Является ли этот контейнер важным. | ||
| memoryReservation целое | при наличии | Мягкое ограничение (в МБ) памяти для резервирования контейнера. | ||
| readonlyRootFilesystem булево | при наличии | Если этот параметр равен true, контейнер получает доступ только для чтения к своей корневой файловой системе. | ||
| name строка | всегда | Имя контейнера. | ||
| workingDirectory строка | при наличии | Рабочий каталог для запуска команд внутри контейнера. | ||
| hostname строка | при наличии | Имя хоста для вашего контейнера. | ||
| dockerLabels строка | при наличии | Ключ/значение карты меток для добавления в контейнер. | ||
| privileged булево | при наличии | Если этот параметр равен true, контейнер получает повышенные привилегии на хост-экземпляре контейнера (аналогично пользователю root). | ||
| environment сложный | всегда | Переменные среды, передаваемые контейнеру. | ||
| name строка | при наличии | Имя переменной среды. | ||
| value строка | при наличии | Значение переменной среды. | ||
| dnsServers строка | при наличии | Список DNS-серверов, предоставляемых контейнеру. | ||
| command строка | при наличии | Команда, передаваемая контейнеру. | ||
| ulimits сложный | при наличии | Список ограничений ulimits для установки в контейнере. | ||
| softLimit целое | при наличии | Мягкое ограничение для типа ulimit. | ||
| name строка | при наличии | Тип ограничения ulimit. | ||
| hardLimit целое | при наличии | Жесткое ограничение для типа ulimit. | ||
| extraHosts сложный | при наличии | Список сопоставлений имён хостов и IP-адресов для добавления в файл /etc/hosts контейнера. | ||
| hostname строка | при наличии | Имя хоста для использования в записи /etc/hosts. | ||
| ipAddress строка | при наличии | IP-адрес для использования в записи /etc/hosts. | ||
| portMappings сложный | всегда | Список сопоставлений портов для контейнера. | ||
| protocol строка | при наличии | Протокол, используемый для сопоставления портов. | ||
| containerPort целое | при наличии | Номер порта в контейнере. | ||
| hostPort целое | при наличии | Номер порта на экземпляре контейнера для резервирования контейнера. | ||
| cpu целое | всегда | Количество процессорных единиц, резервируемых для контейнера. | ||
| options строка | при наличии | Параметры конфигурации для отправки в драйвер логов. | ||
| volumesFrom сложный | всегда | Тома данных для монтирования из другого контейнера. | ||
| readOnly булево | при наличии | Если значение равно true, контейнер имеет только чтение для тома. Если значение равно false, контейнер может записывать в том. | ||
| sourceContainer строка | при наличии | Имя другого контейнера в том же определении задачи для монтирования томов. | ||
| family строка | всегда | Семейство вашего определения задачи, используемое в качестве имени определения. | ||
| network_mode строка | всегда | Режим сети для контейнеров | ||
| placement_constraints complex | always | Список объектов ограничений размещения для использования в задачах | ||
| type string | при наличии | Тип ограничения. | ||
| expression string | при наличии | Выражение языка запросов кластеров для применения к ограничению. | ||
| requires_attributes complex | при наличии | Атрибуты экземпляра контейнера, необходимые для вашей задачи | ||
| targetType string | при наличии | Тип целевого объекта для привязки атрибута. | ||
| targetId string | при наличии | Идентификатор целевого объекта. | ||
| name string | при наличии | Имя атрибута. | ||
| value string | при наличии | Значение атрибута. | ||
| revision int | всегда | Номер ревизии, которая была запрошена | ||
| status string | всегда | Статус определения задачи | ||
| task_definition_arn string | всегда | ARN определения задачи | ||
| task_role_arn string | при установке роли | ARN IAM-роли, которую контейнеры в этой задаче могут принять | ||
| volumes complex | всегда | Список томов в задаче | ||
| host bool | при наличии | Содержимое параметра host определяет, сохраняется ли ваш том данных на хост-экземпляре контейнера и где он хранится. | ||
| source_path string | при наличии | Путь на хост-экземпляре контейнера, который предоставляется контейнеру. | ||
| name string | при наличии | Имя тома. | ||
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Gustavo Maia(@gurumaia)
- Mark Chance(@Java1Guy)
- Darek Kaczynski (@kaczynskid)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ecs_taskdefinition_facts_module.html