ecs_taskdefinition_info – описание определения задачи в ecs
Новая версия 2.5.
Обзор
- Описывает определение задачи в ecs.
Псевдонимы: ecs_taskdefinition_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- json
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический тип добавлен в 2.8 |
| Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводить набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы выводить в полный список, созданный во время выполнения playbook. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она существует. | |
| profile строка | Использует профиль 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 строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| task_definition - / обязательный | Имя определения задачи для получения подробностей. | |
| validate_certs логический тип |
| При значении "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Подробности о параметрах и возвращаемых значениях см. на http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition
- Этот модуль назывался
ecs_taskdefinition_factsдо Ansible 2.9. Использование не изменилось. - Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета
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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/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_info:
task_definition: test-td
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| container_definitions complex | успех | Возвращает список сложных объектов, представляющих контейнеры | ||
| command строка | при наличии | Команда, передаваемая контейнеру. | ||
| cpu целое число | всегда | Количество единиц ЦП, резервированных для контейнера. | ||
| disableNetworking логическое | при наличии | Если этот параметр равен true, сеть внутри контейнера отключена. | ||
| dnsSearchDomains строка | при наличии | Список областей поиска DNS, представленных контейнеру. | ||
| dnsServers строка | при наличии | Список DNS-серверов, представленных контейнеру. | ||
| dockerLabels строка | при наличии | Ключевое отображение меток для добавления к контейнеру. | ||
| dockerSecurityOptions строка | при наличии | Список строк для предоставления пользовательских меток для многоуровневых систем безопасности SELinux и AppArmor. | ||
| entryPoint строка | при наличии | Точка входа, передаваемая контейнеру. | ||
| environment complex | всегда | Переменные окружения, передаваемые контейнеру. | ||
| name строка | при наличии | Имя переменной окружения. | ||
| value строка | при наличии | Значение переменной окружения. | ||
| essential логическое | всегда | Является ли этот контейнер необходимым или нет. | ||
| extraHosts complex | при наличии | Список сопоставлений имен хостов и IP-адресов для добавления в файл /etc/hosts контейнера. | ||
| hostname строка | при наличии | Имя хоста для использования в записи /etc/hosts. | ||
| ipAddress строка | при наличии | IP-адрес для использования в записи /etc/hosts. | ||
| hostname строка | при наличии | Имя хоста для использования в вашем контейнере. | ||
| image строка | всегда | Изображение, используемое для запуска контейнера. | ||
| links строка | при наличии | Ссылки на другие контейнеры. | ||
| logConfiguration строка | при наличии | Спецификация конфигурации логов для контейнера. | ||
| memoryReservation целое число | при наличии | Мягкое ограничение (в МБ) памяти для резервирования контейнера. | ||
| mountPoints complex | всегда | Точки монтирования томов данных в вашем контейнере. | ||
| containerPath строка | при наличии | Путь в контейнере для монтирования тома хоста. | ||
| readOnly логическое | при наличии | Если значение равно true, контейнер имеет только чтение для тома. Если значение равно false, контейнер может записывать в том. | ||
| sourceVolume строка | при наличии | Имя монтируемого тома. | ||
| name строка | всегда | Имя контейнера. | ||
| options строка | при наличии | Конфигурационные параметры для отправки драйверу логов. | ||
| portMappings complex | всегда | Список сопоставлений портов для контейнера. | ||
| containerPort целое число | при наличии | Номер порта в контейнере. | ||
| hostPort целое число | при наличии | Номер порта на экземпляре контейнера для резервирования вашего контейнера. | ||
| protocol строка | при наличии | Протокол, используемый для сопоставления портов. | ||
| privileged логическое | при наличии | Если этот параметр равен true, контейнеру предоставляются повышенные привилегии на хост-экземпляре контейнера (аналогично пользователю root). | ||
| readonlyRootFilesystem логическое | при наличии | Если этот параметр равен true, контейнеру предоставляется доступ только для чтения к его корневой файловой системе. | ||
| ulimits complex | при наличии | Список ограничений ulimit для установки в контейнере. | ||
| hardLimit целое число | при наличии | Жесткое ограничение для типа ulimit. | ||
| name строка | при наличии | Тип ограничения ulimit. | ||
| softLimit целое число | при наличии | Мягкое ограничение для типа ulimit. | ||
| user строка | при наличии | Имя пользователя для использования внутри контейнера. | ||
| volumesFrom complex | всегда | Тома данных для монтирования из другого контейнера. | ||
| readOnly логическое | при наличии | Если значение равно true, контейнер имеет только чтение для тома. Если значение равно false, контейнер может записывать в том. | ||
| sourceContainer строка | при наличии | Имя другого контейнера в том же определении задачи для монтирования томов. | ||
| рабочий_каталог строка | при наличии | Рабочий каталог, в котором будут выполняться команды внутри контейнера. | ||
| семейство строка | всегда | Семейство определения задачи, используемое в качестве имени определения. | ||
| режим_сети строка | всегда | Режим сети для контейнеров. | ||
| ограничения_размещения сложное | всегда | Список объектов ограничений размещения для задач. | ||
| выражение строка | при наличии | Выражение языка запросов кластера, применяемое к ограничению. | ||
| тип строка | при наличии | Тип ограничения. | ||
| требуемые_атрибуты сложное | при наличии | Атрибуты экземпляра контейнера, необходимые для вашей задачи. | ||
| имя строка | при наличии | Имя атрибута. | ||
| targetId строка | при наличии | Идентификатор целевого объекта. | ||
| targetType строка | при наличии | Тип целевого объекта, к которому необходимо прикрепить атрибут. | ||
| значение строка | при наличии | Значение атрибута. | ||
| ревизия целое_число | всегда | Номер ревизии, который был запрошен. | ||
| статус строка | всегда | Статус определения задачи. | ||
| task_definition_arn строка | всегда | ARN определения задачи. | ||
| task_role_arn строка | при назначении роли | ARN роли IAM, которую контейнеры в этой задаче могут принять. | ||
| тома сложное | всегда | Список томов в задаче. | ||
| хост булево | при наличии | Содержимое параметра host определяет, сохраняются ли ваши тома данных в контейнере хоста и где они хранятся. | ||
| имя строка | при наличии | Имя тома. | ||
| source_path строка | при наличии | Путь на экземпляре хост-контейнера, представленный контейнеру. | ||
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/ecs_taskdefinition_info_module.html