Spec-Zone.ru › Ansible 2.8

ecs_taskdefinition_facts – описание определения задачи в ecs

Новое в версии 2.5.

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

Обзор

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

Требования

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

  • 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:action», выполненных во время задачи, выводив набор в ключ 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
  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета 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_facts:
    task_definition: test-td

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

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

Ключ Возвращаемое значение Описание
container_definitions
complex
success
Возвращает список комплексных объектов, представляющих контейнеры

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
при наличии
Список ограничений ulimits для установки в контейнере.

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

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

softLimit
целое число
при наличии
Мягкий лимит для типа ограничения ulimit.

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

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

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

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

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

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

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

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

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

тип
строка
при наличии
Тип ограничения.

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

имя
строка
при наличии
Имя атрибута.

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

targetType
строка
при наличии
Тип целевого объекта, к которому необходимо прикрепить атрибут.

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

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

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

task_definition_arn
строка
всегда
ARN определения задачи.

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

volumes
сложное
всегда
Список томов в задаче.

host
булево
при наличии
Содержимое параметра 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.8/modules/ecs_taskdefinition_facts_module.html

Spec-Zone.ru

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