community.aws.ecs_taskdefinition_facts – Описание определения задачи в ECS
Примечание
Этот плагин является частью коллекции community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач, укажите: community.aws.ecs_taskdefinition_facts.
Новая версия 1.0.0: из community.aws
Обзор
- Описывает определение задачи в ECS.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- botocore
- json
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_access_key и profile устарело и будет сделано взаимоисключающим после 2022-06-01. алиасы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла сертификата CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл сертификата CA читается на стороне модуля и, возможно, требует явного копирования с контроллера, если выполняется не локально. | |
| aws_config словарь | Словарь для изменения настроек botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительных настроек boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело и будет сделано взаимоисключающим после 2022-06-01. алиасы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический |
| Использовать логгер botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие» во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. алиасы: aws_endpoint_url, endpoint_url | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token. Поддержка одновременного указания этих параметров с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. алиасы: aws_profile | |
| 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. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело и будет сделано взаимоисключающим после 2022-06-01. алиасы: aws_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_PROFILEилиAWS_DEFAULT_PROFILE,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,AWS_CA_BUNDLE - 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.
- community.aws.ecs_taskdefinition_info:
task_definition: test-td
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| container_definitions complex | успех | Возвращает список объектов 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 строка | при наличии | Имя другого контейнера в том же определении задачи для монтирования томов. | ||
| workingDirectory строка | при наличии | Рабочий каталог, в котором выполняются команды внутри контейнера. | ||
| family строка | всегда | Семейство вашего определения задачи, используемое в качестве имени определения | ||
| network_mode строка | всегда | Режим сети для контейнеров | ||
| placement_constraints complex | всегда | Список объектов ограничений размещения, используемых для задач | ||
| expression строка | при наличии | Выражение языка запросов кластера для применения к ограничению. | ||
| type строка | при наличии | Тип ограничения. | ||
| requires_attributes complex | при наличии | Атрибуты экземпляра контейнера, необходимые вашей задачей | ||
| name строка | при наличии | Имя атрибута. | ||
| targetId строка | при наличии | Идентификатор целевого объекта. | ||
| targetType string | when present | Тип целевого объекта, к которому следует прикрепить атрибут. | ||
| value string | when present | Значение атрибута. | ||
| revision integer | always | Номер версии, который был запрошен | ||
| status string | always | Статус определения задачи | ||
| task_definition_arn string | always | ARN определения задачи | ||
| task_role_arn string | when role is set | ARN роли IAM, которую могут принять контейнеры в этой задаче | ||
| volumes complex | always | Список томов в задаче | ||
| host boolean | when present | Содержимое параметра host определяет, сохраняется ли ваш том данных на экземпляре контейнера-хоста и где он хранится. | ||
| name string | when present | Имя тома. | ||
| source_path string | when present | Путь на экземпляре контейнера-хоста, предоставляемый контейнеру. | ||
Авторы
- 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.10/collections/community/aws/ecs_taskdefinition_facts_module.html
