ec2_launch_template – Управление шаблонами запуска EC2
Новое в версии 2.8.
Обзор
- Создание, изменение и удаление шаблонов запуска EC2, которые можно использовать для создания отдельных экземпляров или в группах автомасштабирования.
- Модули ec2_instance и ec2_asg вместо указания всех параметров в этих задачах могут принять шаблон запуска, который содержит настройки, такие как размер экземпляра, тип диска, подсеть и многое другое.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3 >= 1.6.0
- botocore
- 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 | |||
| block_device_mappings - | Карта отображения блочных устройств. Задание и идентификатора моментального снимка, и значения шифрования в качестве аргументов для карты отображения блочных устройств приводит к ошибке. Это связано с тем, что только пустые тома могут быть зашифрованы при запуске, а такие тома не создаются из моментального снимка. Если тома основаны на снимке, они содержат данные по определению, и их состояние шифрования нельзя изменить с помощью этого действия. | |||
| device_name - | Имя устройства (например, /dev/sdh или xvdh). | |||
| ebs - | Параметры, используемые для автоматической настройки томов EBS при запуске экземпляра. | |||
| delete_on_termination логическое |
| Указывает, удаляется ли том EBS при завершении работы экземпляра. | ||
| encrypted - | Указывает, зашифрован ли том EBS. Зашифрованные тома могут быть подключены только к экземплярам, поддерживающим шифрование Amazon EBS. Если вы создаёте том из моментального снимка, вы не можете указать значение шифрования. | |||
| iops - | Количество операций ввода-вывода в секунду (IOPS), которые поддерживает том. Для io1 это количество IOPS, выделенных для тома. Для gp2 это базовая производительность тома и скорость, с которой том накапливает кредиты ввода-вывода для повышения производительности. Более подробную информацию о базовой производительности твердотельных накопителей общего назначения, кредитах ввода-вывода и повышении производительности см. в руководстве пользователя Amazon Elastic Compute Cloud в разделе Amazon EBS Volume Types. Условие: Этот параметр требуется для запросов на создание томов io1; он не используется в запросах на создание томов gp2, st1, sc1 или стандартных томов. | |||
| kms_key_id - | ARN ключа управления ключами AWS KMS (AWS KMS CMK), используемого для шифрования. | |||
| snapshot_id - | Идентификатор моментального снимка, для создания тома из него | |||
| volume_size - | Размер тома в ГиБ. Значение по умолчанию: Если вы создаете том из моментального снимка и не указываете размер тома, значение по умолчанию — размер моментального снимка. | |||
| volume_type - | Тип тома | |||
| no_device - | Исключает указанное устройство из отображения блочных устройств AMI. | |||
| virtual_name - | Виртуальное имя устройства (ephemeralN). Тома памяти экземпляра нумеруются, начиная с 0. Тип экземпляра с 2 доступными томами памяти экземпляра может указать отображения для ephemeral0 и ephemeral1. Количество доступных томов памяти экземпляра зависит от типа экземпляра. После подключения к экземпляру вы должны смонтировать том. | |||
| cpu_options - | Выберите параметры процессора для экземпляров EC2, которые будут созданы с помощью этой шаблона. Дополнительная информация: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html
| |||
| core_count - | Количество ядер процессора для экземпляра. | |||
| threads_per_core - | Количество потоков на ядро процессора. Для отключения технологии Intel Hyper-Threading для экземпляра укажите значение 1. В противном случае укажите значение по умолчанию 2. | |||
| credit_specification - | Вариант кредитования для использования ЦП экземпляра. Действительно только для экземпляров T2 или T3. | |||
| cpu_credits - |
| Вариант кредитования для использования ЦП экземпляра T2 или T3. Допустимые значения — standard и unlimited. | ||
| debug_botocore_endpoint_logs логическое добавлено в 2.8 |
| Используйте регистрирующий модуль botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выведя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, выполненного во время выполнения задачи. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS. | ||
| default_version - | По умолчанию: "latest" | Какая версия должна быть по умолчанию, когда пользователи запускают новые экземпляры на основе этого шаблона? По умолчанию последняя версия будет установлена по умолчанию. | ||
| disable_api_termination логическое |
| Это помогает защитить экземпляры от случайного завершения работы. Если установлено в значение true, вы не сможете завершить работу экземпляра с помощью консоли Amazon EC2, командной строки или API. Чтобы изменить этот атрибут на значение false после запуска, используйте ModifyInstanceAttribute. | ||
| ebs_optimized логическое |
| Указывает, оптимизирован ли экземпляр для операций ввода-вывода Amazon EBS. Эта оптимизация предоставляет выделенную пропускную способность для Amazon EBS и оптимизированную конфигурационную сборку для обеспечения оптимальной производительности операций ввода-вывода Amazon EBS. Эта оптимизация не доступна для всех типов экземпляров. При использовании экземпляра, оптимизированного для EBS, взимаются дополнительные сборы за использование. | ||
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. | |||
| elastic_gpu_specifications - | Настройки для подключения Elastic GPU. Подробная информация см. в https://aws.amazon.com/ec2/elastic-gpus/ | |||
| type - | Тип Elastic GPU для подключения | |||
| iam_instance_profile - | Имя или ARN профиля IAM экземпляра. Требует разрешений для описания существующих ролей экземпляра, чтобы подтвердить, что ARN сформирован правильно. | |||
| image_id - | Идентификатор AMI, который следует использовать для новых экземпляров, запущенных с этим шаблоном. Это значение зависит от региона, так как AMI не являются глобальными ресурсами. | |||
| instance_initiated_shutdown_behavior - |
| Указывает, останавливается или завершается экземпляр при запуске команды завершения работы с операционной системы. | ||
| instance_market_options словарь | Параметры для альтернативных рынков экземпляров, в настоящее время поддерживается только рынок spot. | |||
| Тип рынка - | Тип рынка. Должен всегда быть 'spot'. | |||
| Параметры spot-рынка - | Настройки, специфичные для рынка spot | |||
| Продолжительность блока (минут) - | Требуемая продолжительность экземпляров Spot (также известных как блоки Spot), в минутах. Это значение должно быть кратно 60 (60, 120, 180, 240, 300 или 360). | |||
| Поведение при прерывании экземпляра Spot - |
| Поведение при прерывании экземпляра Spot. По умолчанию - terminate
| ||
| Максимальная цена - | Максимальная часовая цена, которую вы готовы платить за этот экземпляр Spot. | |||
| Тип экземпляра Spot - |
| Тип запроса, который необходимо отправить. | ||
| Тип экземпляра - | Тип экземпляра, например, c5.2xlarge. Полный список типов экземпляров см. на странице http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html | |||
| ID ядра - | ID ядра. Рекомендуется использовать PV-GRUB вместо ядер и дисков RAM. Дополнительную информацию см. на странице http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
| |||
| Имя пары ключей - | Имя пары ключей. Вы можете создать пару ключей с помощью CreateKeyPair или ImportKeyPair. Если вы не укажете пару ключей, вы не сможете подключиться к экземпляру, если не выберете AMI, настроенный для авторизации пользователей другим способом. | |||
| Мониторинг - | Настройки мониторинга экземпляра | |||
| Включено boolean |
| Включить подробный мониторинг новых экземпляров. Это повлечет дополнительные расходы. | ||
| Сетевые интерфейсы - | Один или несколько сетевых интерфейсов. | |||
| Привязать публичный IP-адрес boolean |
| Привязывает публичный IPv4-адрес к eth0 для нового сетевого интерфейса. | ||
| Удалить при завершении boolean |
| Указывает, будет ли удалён сетевой интерфейс при завершении работы экземпляра. | ||
| Описание - | Описание сетевого интерфейса. | |||
| Индекс устройства - | Индекс устройства для подключения сетевого интерфейса. | |||
| Группы - | Список идентификаторов групп безопасности, которые необходимо включить в этот экземпляр | |||
| Количество IPv6-адресов - | Количество IPv6-адресов, которые необходимо назначить сетевому интерфейсу. Amazon EC2 автоматически выбирает IPv6-адреса из диапазона подсети. Вы не можете использовать этот параметр, если указан параметр ipv6_addresses. | |||
| IPv6-адреса - | Список одного или нескольких определённых IPv6-адресов из диапазона IPv6-CIDR блока вашей подсети. Вы не можете использовать этот параметр, если указан параметр ipv6_address_count. | |||
| ID сетевого интерфейса - | ID eni сетевого интерфейса для подключения. | |||
| Приватный IP-адрес - | Основной приватный IPv4-адрес сетевого интерфейса. | |||
| Список приватных IP-адресов - | Один или несколько приватных IPv4-адресов. | |||
| Основной - | Указывает, является ли приватный IPv4-адрес основным приватным IPv4-адресом. Только один IPv4-адрес может быть назначен основным. | |||
| Приватный IP-адрес - | Основной приватный IPv4-адрес сетевого интерфейса. | |||
| Количество дополнительных приватных IP-адресов - | Количество дополнительных приватных IPv4-адресов, которые необходимо назначить сетевому интерфейсу. | |||
| ID подсети - | Идентификатор подсети для сетевого интерфейса. | |||
| Размещение - | Настройки группы размещения для экземпляра. | |||
| Привязка - | Настройка привязки экземпляра к выделенному хосту. | |||
| Зона доступности - | Зона доступности для экземпляра. | |||
| Имя группы - | Имя группы размещения для экземпляра. | |||
| ID выделенного хоста - | Идентификатор выделенного хоста для экземпляра. | |||
| Тип аренды - | Тип аренды экземпляра (если экземпляр работает в VPC). Экземпляр с типом аренды dedicated работает на оборудовании с арендой на одного клиента. | |||
| Профиль строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |||
| ID диска RAM - | Идентификатор диска RAM для запуска экземпляра. Рекомендуется использовать PV-GRUB вместо ядер и дисков RAM. Дополнительную информацию см. на странице http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
| |||
| Регион строка | AWS-регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region | |||
| Идентификаторы групп безопасности список | Список идентификаторов групп безопасности (VPC или EC2-Classic), к которым будут добавлены новые экземпляры. | |||
| Группы безопасности список | Список имён групп безопасности (VPC или EC2-Classic), к которым будут добавлены новые экземпляры. | |||
| Токен безопасности строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |||
| состояние - |
| Указывает, должно ли шаблон запуска существовать. Удаление конкретных версий шаблона запуска в настоящее время не поддерживается. | ||
| метки словарь | Набор пар ключ-значение, которые будут применены к ресурсам при использовании этого шаблона запуска. Ограничения на ключи меток: ключи меток регистрозависимы и принимают не более 127 символов Юникода. Не могут начинаться с aws:
Ограничения на значения меток: значения меток регистрозависимы и принимают не более 255 символов Юникода. | |||
| id_шаблона - | Идентификатор шаблона запуска, который можно использовать во всех случаях, кроме создания нового шаблона запуска. псевдонимы: id | |||
| название_шаблона - | Имя шаблона. Оно должно быть уникальным в сочетании региона и учетной записи. псевдонимы: имя | |||
| пользовательские_данные - | Пользовательские данные в кодировке Base64, доступные экземпляру. Для получения дополнительной информации, см. документацию по Linux http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html и Windows http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data о пользовательских данных. | |||
| проверять_сертификаты boolean |
| При значении «нет» сертификаты SSL не будут проверяться для версий boto ≥ 2.6.0. | ||
Примечания
Примечание
- Если параметры не заданы внутри модуля, следующие переменные окружения могут использоваться в порядке убывания приоритета
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
Примеры
- name: Create an ec2 launch template
ec2_launch_template:
name: "my_template"
image_id: "ami-04b762b4289fba92b"
key_name: my_ssh_key
instance_type: t2.micro
iam_instance_profile: myTestProfile
disable_api_termination: true
- name: >
Create a new version of an existing ec2 launch template with a different instance type,
while leaving an older version as the default version
ec2_launch_template:
name: "my_template"
default_version: 1
instance_type: c5.4xlarge
- name: Delete an ec2 launch template
ec2_launch_template:
name: "my_template"
state: absent
# This module does not yet allow deletion of specific versions of launch templates
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| версия_по_умолчанию целое число | при состоянии=текущее | Версия, которая будет использоваться, если указано только имя шаблона. Часто это совпадает с последней версией, но не всегда. |
| последняя_версия целое число | при состоянии=текущее | Последняя доступная версия шаблона запуска |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Ryan Scott Brown (@ryansb)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/ec2_launch_template_module.html
