community.aws.ec2_lc – Создание или удаление конфигураций запуска AWS Autoscaling
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач укажите: community.aws.ec2_lc.
Новое в версии 1.0.0: of community.aws
Обзор
- Может создавать или удалять конфигурации запуска AWS Autoscaling.
- Работает с модулем ec2_asg для управления группами Autoscaling.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- boto
- boto3 >= 1.4.4
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| assign_public_ip boolean |
| Используется для групп автоматического масштабирования, которые запускают экземпляры в Amazon Virtual Private Cloud. Указывает, следует ли назначать общедоступный IP-адрес каждому экземпляру, запущенному в Amazon VPC. | |
| associate_public_ip_address boolean |
| Параметр associate_public_ip_address ничего не делает и будет удален после 2022-06-01 | |
| aws_access_key string | Ключ доступа 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'. Подробнее о настройках boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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 | ||
| classic_link_vpc_id строка | Идентификатор VPC с включенной функцией ClassicLink | ||
| classic_link_vpc_security_groups список / элементы=строка | Список идентификаторов групп безопасности, которые необходимо применить к экземплярам VPC ClassicLink. | ||
| debug_botocore_endpoint_logs boolean |
| Используйте обработчик логов botocore.endpoint для анализа уникальных (а не общих) вызовов API "resource:action" во время задачи, выводя список в ключ task results с именем resource_actions. Используйте обратный вызов aws_resource_action для вывода полного списка вызовов, выполненных в ходе выполнения playbook. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS. | |
| ebs_optimized boolean |
| Указывает, оптимизирован ли экземпляр для ввода/вывода EBS (true) или нет (false). | |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется модулями, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL, если таковая есть. псевдонимы: aws_endpoint_url, endpoint_url | ||
| image_id строка | Уникальный идентификатор AMI, который будет использоваться для группы. | ||
| instance_id строка | Идентификатор работающего экземпляра, который используется в качестве основы для конфигурации запуска. Может использоваться вместо image_id и instance_type. | ||
| instance_monitoring boolean |
| Указывает, запускаются ли экземпляры с подробным мониторингом. | |
| instance_profile_name строка | Имя или Amazon Resource Name (ARN) профиля экземпляра, связанного с ролью IAM для экземпляров. | ||
| instance_type строка | Тип экземпляра, который следует использовать для экземпляра. Требуется при создании новой конфигурации запуска. | ||
| kernel_id строка | Идентификатор ядра для экземпляра EC2. | ||
| key_name строка | Имя SSH-ключа, который будет использоваться для доступа к управляемым экземплярам. | ||
| name строка / требуется | Уникальное имя для конфигурации. | ||
| placement_tenancy строка |
| Определяет, работает ли экземпляр на оборудовании с арендой на одного пользователя или нет. Если не указано, AWS по умолчанию будет default. | |
| 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 | ||
| ramdisk_id строка | Идентификатор диска оперативной памяти для экземпляров. | ||
| region строка | AWS-регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковая есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | ||
| security_groups список / элементы=строка | Список групп безопасности, которые следует применить к экземплярам. Начиная с версии 2.4 можно указать либо имена, либо ID групп безопасности, либо их комбинацию. До версии 2.4 для экземпляров VPC указывать ID групп безопасности, а для экземпляров EC2-Classic — либо имена, либо ID. | ||
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если установлен параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token | ||
| spot_price число с плавающей точкой | Цена, которую вы предлагаете на аукционе. Применимо только для группы автоматического масштабирования со спотовыми экземплярами. | ||
| state строка |
| Регистрация или дерегистрация экземпляра. | |
| user_data строка | Необработанные данные, доступные экземпляру ec2. Взаимоисключающее с user_data_path. | ||
| user_data_path путь | Путь к файлу, содержащему пользовательские данные для экземпляров ec2. Взаимоисключающее с user_data. | ||
| validate_certs boolean |
| Если значение равно "no", SSL-сертификаты не будут проверены для версий boto >= 2.6.0. | |
| volumes список / элементы=словарь | Список словарей, определяющих создаваемые тома. Для любого тома размер тома меньше 1 будет интерпретироваться как запрос на отказ от создания тома. | ||
| delete_on_termination boolean |
| Следует ли автоматически удалять том при завершении работы экземпляра. | |
| device_name строка / требуется | Имя для тома (например /dev/sda). | ||
| encrypted boolean |
| Следует ли шифровать том с использованием KMS CMK 'aws/ebs'. | |
| ephemeral строка | Следует ли том быть временным. Данные на временных томах теряются при остановке экземпляра. Взаимоисключающее с параметром snapshot. | ||
| iops целое число | Количество операций ввода/вывода в секунду (IOPS), подлежащих выделению для тома. Требуется при volume_type=io1. | ||
| no_device boolean |
| При no_device=true устройство не будет создано. | |
| snapshot string | Идентификатор моментального снимка EBS для копирования при создании тома. Взаимоисключительно с параметром ephemeral. | ||
| volume_size integer | Размер тома (в GiB). Требуется, если не задан один из параметров ephemeral, snapshot или no_device. | ||
| volume_type string | Тип создаваемого тома. См. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html для получения дополнительной информации о доступных типах томов. | ||
| vpc_id string | ID VPC, используется для преобразования имен сетевых групп в ID. | ||
Примечания
Примечание
- Конфигурации запуска Amazon ASG Autoscaling неизменяемы после создания, поэтому изменение конфигурации после ее изменения не приведет к изменению конфигурации запуска на AWS. Необходимо создать новую конфигурацию и назначить ее ASG вместо этого.
- Тома с шифрованием поддерживаются в версиях >= 2.4
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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
Примеры
# create a launch configuration using an AMI image and instance type as a basis
- name: note that encrypted volumes are only supported in >= Ansible 2.4
community.aws.ec2_lc:
name: special
image_id: ami-XXX
key_name: default
security_groups: ['group', 'group2' ]
instance_type: t1.micro
volumes:
- device_name: /dev/sda1
volume_size: 100
volume_type: io1
iops: 3000
delete_on_termination: true
encrypted: true
- device_name: /dev/sdb
ephemeral: ephemeral0
- name: create a launch configuration using a running instance id as a basis
community.aws.ec2_lc:
name: special
instance_id: i-00a48b207ec59e948
key_name: default
security_groups: ['launch-wizard-2' ]
volumes:
- device_name: /dev/sda1
volume_size: 120
volume_type: io1
iops: 3000
delete_on_termination: true
- name: create a launch configuration to omit the /dev/sdf EBS device that is included in the AMI image
community.aws.ec2_lc:
name: special
image_id: ami-XXX
key_name: default
security_groups: ['group', 'group2' ]
instance_type: t1.micro
volumes:
- device_name: /dev/sdf
no_device: true
- name: Use EBS snapshot ID for volume
block:
- name: Set Volume Facts
ansible.builtin.set_fact:
volumes:
- device_name: /dev/sda1
volume_size: 20
ebs:
snapshot: snap-XXXX
volume_type: gp2
delete_on_termination: true
encrypted: no
- name: Create launch configuration
community.aws.ec2_lc:
name: lc1
image_id: ami-xxxx
assign_public_ip: yes
instance_type: t2.medium
key_name: my-key
security_groups: "['sg-xxxx']"
volumes: "{{ volumes }}"
register: lc_info
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| arn строка | при state=present | Amazon Resource Name (ARN) конфигурации запуска. Пример: arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name | |||
| changed булево | всегда | Изменилось ли состояние конфигурации запуска. | |||
| created_time строка | при state=present | Дата и время создания конфигурации запуска. Пример: 2017-11-03 23:46:44.841000 | |||
| image_id строка | при state=present | Идентификатор Amazon Machine Image, используемой конфигурацией запуска. Пример: ami-9be6f38c | |||
| instance_type строка | при state=present | Тип экземпляра для экземпляров. Пример: t1.micro | |||
| name строка | при state=present | Имя конфигурации запуска. Пример: launch_config_name | |||
| result сложный | при state=present | Подробные данные конфигурации запуска. | |||
| associate_public_ip_address булево | при state=present | (EC2-VPC) Указывает, нужно ли назначать публичный IP-адрес каждому экземпляру. | |||
| block_device_mappings сложный | при state=present | Карта блочных устройств, указывающая на блочные устройства. | |||
| device_name строка | при state=present | Имя устройства, доступного для EC2-экземпляра (например, /dev/sdh или xvdh). Пример: /dev/sda1 | |||
| ebs сложный | при state=present | Информация об Amazon EBS-томе. | |||
| snapshot_id строка | при state=present | Идентификатор снимка. | |||
| volume_size строка | при state=present | Размер тома в GiB. Пример: 100 | |||
| virtual_name строка | при state=present | Имя виртуального устройства (например, ephemeral0). Пример: ephemeral0 | |||
| classic_link_vpc_id строка | при state=present | Идентификатор VPC с включённым ClassicLink для связи с вашими экземплярами EC2-Classic. | |||
| classic_link_vpc_security_groups список / элементы=строка | при state=present | Идентификаторы одного или нескольких наборов правил безопасности для VPC, указанного в ClassicLinkVPCId. | |||
| created_time строка | при state=present | Дата и время создания конфигурации запуска. Пример: 2017-11-03 23:46:44.841000 | |||
| delete_on_termination булево | при state=present | Указывает, удаляется ли том при завершении работы экземпляра. Пример: True | |||
| ebs_optimized булево | при state=present | Указывает, оптимизирован ли экземпляр для ввода-вывода EBS (true) или нет (false). | |||
| image_id строка | при state=present | Идентификатор Amazon Machine Image, используемой конфигурацией запуска. Пример: ami-9be6f38c | |||
| instance_monitoring булево | при state=present | Указывает, запускаются ли экземпляры в этой группе с подробным (true) или базовым (false) мониторингом. Пример: True | |||
| instance_profile_name строка | при state=present | Имя или Amazon Resource Name (ARN) профиля экземпляра, связанного с ролью IAM для экземпляра. | |||
| instance_type строка | при state=present | Тип экземпляра для экземпляров. Пример: t1.micro | |||
| iops целое число | при state=present | Количество операций ввода-вывода в секунду (IOPS), которые нужно предоставить для тома. | |||
| kernel_id строка | при state=present | Идентификатор ядра, связанного с AMI. | |||
| key_name строка | при state=present | Имя пары ключей. Пример: testkey | |||
| launch_configuration_arn строка | при state=present | Amazon Resource Name (ARN) конфигурации запуска. Пример: arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name | |||
| member строка | при state=present | Пример: | |||
| name строка | при state=present | Имя конфигурации запуска. Пример: launch_config_name | |||
| PlacementTenancy строка | при state=present | Используемая аренда экземпляров, либо default, либо dedicated. Пример: default | |||
| ramdisk_id строка | при state=present | Идентификатор RAM-диска, связанного с AMI. | |||
| security_groups список / элементы=строка | при state=present | Наборы правил безопасности для привязки к экземплярам. Пример: ['sg-5e27db2f'] | |||
| spot_price вещественное число | при state=present | Цена для ставок при запуске Spot-экземпляров. | |||
| use_block_device_types булево | при state=present | Указывает, нужно ли подавлять сопоставление устройств. | |||
| user_data строка | при state=present | Пользовательские данные, доступные экземплярам. | |||
| volume_type строка | при state=present | Тип тома (один из standard, io1, gp2). Пример: io1 | |||
| security_groups список / элементы=строка | при state=present | Наборы правил безопасности для привязки к экземплярам. Пример: ['sg-5e27db2f'] | |||
Авторы
- Gareth Rushgrove (@garethr)
- Willem van Ketwich (@wilvk)
© 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/ec2_lc_module.html