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
ec2_url		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется.
profile (добавлено в 1.6)		Использует профиль 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)		Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
task_definition обязательно		Имя определения задачи для получения подробностей
validate_certs bool (добавлено в 1.5)	Варианты: no yes ←	Если установлено "no", сертификаты 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 complex			success	Возвращает список сложных объектов, представляющих контейнеры.
	name string		всегда	Имя контейнера.
	image string		всегда	Изображение, используемое для запуска контейнера.
	cpu int		всегда	Количество единиц ЦП, зарезервированных для контейнера.
	memoryReservation int		при наличии	Мягкий лимит (в MiB) памяти, которую нужно зарезервировать для контейнера.
	links string		при наличии	Ссылки на другие контейнеры.
	portMappings complex		всегда	Список сопоставлений портов для контейнера.
		containerPort int	при наличии	Номер порта в контейнере.
		hostPort int	при наличии	Номер порта в экземпляре контейнера, который нужно зарезервировать для вашего контейнера.
		protocol string	при наличии	Протокол, используемый для сопоставления портов.
	essential bool		всегда	Является ли этот контейнер обязательным или нет.
	entryPoint string		при наличии	Точка входа, которая передаётся контейнеру.
	command string		при наличии	Команда, которая передаётся контейнеру.
	environment complex		всегда	Переменные окружения, которые нужно передать контейнеру.
		name string	при наличии	Имя переменной окружения.
		value string	при наличии	Значение переменной окружения.
	mountPoints complex		всегда	Точки монтирования томов данных в вашем контейнере.
		sourceVolume string	при наличии	Имя тома, который нужно смонтировать.
		containerPath string	при наличии	Путь в контейнере, по которому нужно смонтировать том хоста.
		readOnly bool	при наличии	Если значение true, контейнер имеет только чтение для тома. Если значение false, контейнер может записывать в том.
	volumesFrom complex		всегда	Тома данных для монтирования из другого контейнера.
		sourceContainer string	при наличии	Имя другого контейнера в том же определении задачи для монтирования томов.
		readOnly bool	при наличии	Если значение true, контейнер имеет только чтение для тома. Если значение false, контейнер может записывать в том.
	hostname string		при наличии	Имя хоста для использования в контейнере.
	user string		при наличии	Имя пользователя для использования внутри контейнера.
	workingDirectory string		при наличии	Рабочая директория, в которой будут выполняться команды внутри контейнера.
	disableNetworking bool		при наличии	Когда этот параметр true, сетевое взаимодействие отключено внутри контейнера.
	privileged bool		при наличии	Когда этот параметр true, контейнеру предоставляются повышенные привилегии на хост-экземпляре контейнера (аналогично пользователю root).
	readonlyRootFilesystem bool		при наличии	Когда этот параметр true, контейнеру предоставляется только чтение для корневой файловой системы.
	dnsServers string		при наличии	Список DNS-серверов, представленных контейнеру.
	dnsSearchDomains string		при наличии	Список DNS-доменных зон, представленных контейнеру.
	extraHosts complex		при наличии	Список сопоставлений имен хостов и IP-адресов, которые нужно добавить в файл /etc/hosts в контейнере.
		hostname string	при наличии	Имя хоста для использования в записи /etc/hosts.
		ipAddress string	при наличии	IP-адрес для использования в записи /etc/hosts.
	dockerSecurityOptions string		при наличии	Список строк для предоставления пользовательских меток для систем многоуровневой безопасности SELinux и AppArmor.
	dockerLabels string		при наличии	Ключевое отображение меток, которые нужно добавить к контейнеру.
	ulimits complex		при наличии	Список лимитов ulimit для установки в контейнере.
		name string	при наличии	Тип лимита ulimit.
		softLimit int	при наличии	Мягкий лимит для типа лимита ulimit.
		hardLimit int	при наличии	Жесткий лимит для типа лимита ulimit.
	logConfiguration string		при наличии	Спецификация конфигурации логов для контейнера.
	options string		при наличии	Конфигурационные параметры для отправки драйверу логов.
family string			всегда	Семейство вашего определения задачи, используемое в качестве имени определения.
network_mode string			всегда	Режим сети для контейнеров

placement_constraints complex		always	Список объектов ограничений размещения для использования в задачах
	type string	при наличии	Тип ограничения.
	expression string	при наличии	Выражение языка запросов кластеров для применения к ограничению.
requires_attributes complex		при наличии	Атрибуты экземпляра контейнера, необходимые для вашей задачи
	name string	при наличии	Имя атрибута.
	value string	при наличии	Значение атрибута.
	targetType string	при наличии	Тип целевого объекта, к которому нужно прикрепить атрибут.
	targetId string	при наличии	Идентификатор целевого объекта.
revision int		всегда	Номер версии, который был запрошен
status string		всегда	Статус определения задачи
task_definition_arn string		всегда	ARN определения задачи
task_role_arn string		если роль установлена	ARN IAM роли, которую могут принять контейнеры в этой задаче
volumes complex		всегда	Список томов в задаче
	name string	при наличии	Имя тома.
	host bool	при наличии	Содержимое параметра host определяет, сохраняется ли ваш том данных на хост-контейнерном экземпляре и где он хранится.
	source_path string	при наличии	Путь на хост-контейнерном экземпляре, который предоставляется контейнеру.

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются сообществом 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.6/modules/ecs_taskdefinition_facts_module.html