Spec-Zone.ru › Ansible 2.11

community.aws.ecs_taskdefinition_info – Описание определения задачи в ECS

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.ecs_taskdefinition_info.

Новое в версии 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
успех
Возвращает список комплексных объектов, представляющих контейнеры
command
string
при наличии
Команда, передаваемая контейнеру.
cpu
integer
всегда
Количество единиц ЦП, резервированных для контейнера.
disableNetworking
boolean
при наличии
Если этот параметр имеет значение true, сетевое взаимодействие внутри контейнера отключено.
dnsSearchDomains
string
при наличии
Список доменов поиска DNS, представленных контейнеру.
dnsServers
string
при наличии
Список DNS-серверов, представленных контейнеру.
dockerLabels
string
при наличии
Карта ключ/значение меток для добавления в контейнер.
dockerSecurityOptions
string
при наличии
Список строк для предоставления пользовательских меток для многоуровневых систем безопасности SELinux и AppArmor.
entryPoint
string
при наличии
Точка входа, передаваемая контейнеру.
environment
complex
всегда
Переменные среды для передачи контейнеру.
name
string
при наличии
Имя переменной среды.
value
string
при наличии
Значение переменной среды.
essential
boolean
всегда
Является ли этот контейнер необходимым.
extraHosts
complex
при наличии
Список сопоставлений хост-имен и IP-адресов для добавления в файл /etc/hosts контейнера.
hostname
string
при наличии
Имя хоста для использования в записи /etc/hosts.
ipAddress
string
при наличии
IP-адрес для использования в записи /etc/hosts.
hostname
string
при наличии
Имя хоста для использования в вашем контейнере.
image
string
всегда
Изображение, используемое для запуска контейнера.
links
string
при наличии
Ссылки на другие контейнеры.
logConfiguration
string
при наличии
Спецификация конфигурации логов для контейнера.
memoryReservation
integer
при наличии
Минимальное значение (в МБ) памяти для резервирования контейнера.
mountPoints
complex
всегда
Точки монтирования томов данных в вашем контейнере.
containerPath
string
при наличии
Путь в контейнере для монтирования тома хоста.
readOnly
boolean
при наличии
Если значение true, контейнер имеет только чтение для тома. Если false, контейнер может записывать в том.
sourceVolume
string
при наличии
Имя тома для монтирования.
name
string
всегда
Имя контейнера.
options
string
при наличии
Параметры конфигурации для отправки в драйвер журналов.
portMappings
complex
всегда
Список сопоставлений портов для контейнера.
containerPort
integer
при наличии
Номер порта в контейнере.
hostPort
integer
при наличии
Номер порта на экземпляре контейнера, резервируемый для вашего контейнера.
protocol
string
при наличии
Протокол, используемый для сопоставления портов.
privileged
boolean
при наличии
Если этот параметр равен true, контейнеру предоставляются повышенные привилегии на хост-экземпляре контейнера (аналогично пользователю root).
readonlyRootFilesystem
boolean
при наличии
Если этот параметр равен true, контейнеру предоставляется доступ только для чтения к его корневой файловой системе.
ulimits
complex
при наличии
Список ulimits для установки в контейнере.
hardLimit
integer
при наличии
Жесткое ограничение для типа ulimit.
name
string
при наличии
Тип ulimit.
softLimit
integer
при наличии
Мягкое ограничение для типа ulimit.
user
string
при наличии
Имя пользователя для использования внутри контейнера.
volumesFrom
complex
всегда
Тома данных для монтирования из другого контейнера.
readOnly
boolean
при наличии
Если значение true, контейнер имеет только чтение для тома. Если false, контейнер может записывать в том.
sourceContainer
string
при наличии
Имя другого контейнера в том же определении задачи для монтирования томов.
workingDirectory
string
при наличии
Рабочий каталог для выполнения команд внутри контейнера.
family
string
всегда
Семейство вашего определения задачи, используемое в качестве имени определения.
network_mode
string
всегда
Режим сети для контейнеров
placement_constraints
complex
всегда
Список объектов ограничений размещения для использования в задачах
expression
string
при наличии
Выражение языка запросов кластера, применяемое к ограничению.
type
string
при наличии
Тип ограничения.
requires_attributes
complex
при наличии
Атрибуты экземпляра контейнера, необходимые вашей задачей
name
string
при наличии
Имя атрибута.
targetId
string
при наличии
Идентификатор целевого объекта.
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ecs_taskdefinition_info_module.html

Spec-Zone.ru

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