amazon.aws.ec2 – создание, завершение, запуск или остановка экземпляра в ec2
Примечание
Этот плагин является частью коллекции amazon.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install amazon.aws.
Для использования в книге задач укажите: amazon.aws.ec2.
Новое в версии 1.0.0: от amazon.aws
Обзор
- Создает или завершает работу экземпляров ec2.
- Примечание: Этот модуль использует более старую библиотеку boto Python для взаимодействия с API EC2. amazon.aws.ec2 по-прежнему будет получать исправления ошибок, но без новых функций. Рассмотрите возможность использования модуля amazon.aws.ec2_instance вместо него. Если amazon.aws.ec2_instance не поддерживает необходимую функцию, которая доступна в amazon.aws.ec2, пожалуйста, отправьте запрос на добавление функции.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| assign_public_ip boolean |
| При развертывании в vpc, назначить публичный IP-адрес. Библиотека Boto должна быть версии 2.13.0+. | |
| 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 путь | Расположение файла с корневым сертификатом для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Корневой сертификат читается со стороны модуля и может потребоваться явное копирование с контроллера, если модуль не запускается локально. | ||
| 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 | ||
| count целое число | Значение по умолчанию: 1 | Количество экземпляров для запуска. | |
| count_tag сырое | Используется с параметром exact_count для определения количества узлов, соответствующих определенным критериям тегов, которые должны работать. Это может быть выражено различными способами, и примеры показаны в разделе ПРИМЕРЫ. Например, можно запросить 25 серверов, помеченных тегом class=webserver. Указанный тег должен уже существовать или быть передан в качестве параметра instance_tags. | ||
| debug_botocore_endpoint_logs boolean |
| Использовать логгер botocore.endpoint для парсинга уникальных (а не общих) API-вызовов «ресурс:действие», сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, сделанный во время выполнения playbook. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. | |
| ebs_optimized boolean |
| Используются ли оптимизированные тома EBS для экземпляра, см. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html. | |
| ec2_url строка | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url | ||
| exact_count целое число | Целое число, которое указывает, сколько экземпляров, соответствующих параметру «count_tag», должно работать. Экземпляры создаются или завершаются в соответствии с этим значением. | ||
| group список / элементы=строка | Группа безопасности (или список групп) для использования с экземпляром. псевдонимы: groups | ||
| group_id список / элементы=строка | Идентификатор группы безопасности (или список идентификаторов) для использования с экземпляром. | ||
| id строка | Идентификатор для этого экземпляра или набора экземпляров, чтобы модуль был идемпотентным по отношению к экземплярам EC2. Этот идентификатор действителен в течение как минимум 24 часов после завершения экземпляра и не должен повторно использоваться для последующего вызова. Для получения подробной информации см. описание маркера клиента по адресу https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html. | ||
| image строка |
Идентификатор ami для использования с экземпляром. Требуется при state=present. | ||
| instance_ids список / элементы=строка | список идентификаторов экземпляров, используется для состояний: absent, running, stopped псевдонимы: instance_id | ||
| instance_initiated_shutdown_behavior строка |
| Установите, будет ли AWS останавливать или завершать экземпляр при выключении. Этот параметр игнорируется при использовании образов instance-store (которые требуют завершения при выключении). | |
| instance_profile_name строка | Имя профиля экземпляра IAM (то, что EC2-консоль называет «ролью IAM») для использования. Библиотека Boto должна быть версии 2.5.0+. | ||
| instance_tags словарь | Хэш/словарь тегов для добавления к новому экземпляру или для запуска/остановки экземпляров по тегу. Например {"key":"value"} или {"key":"value","key2":"value2"}. | ||
| instance_type строка | Тип экземпляра для использования с экземпляром, см. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html. Требуется при создании нового экземпляра. псевдонимы: type | ||
| kernel строка | Ядро eki для использования с экземпляром. | ||
| key_name строка | Ключ пары для использования с экземпляром. SSH-ключ должен уже существовать в AWS, чтобы использовать этот аргумент. Ключи можно создавать/удалять с помощью модуля amazon.aws.ec2_key. псевдонимы: keypair | ||
| monitoring boolean |
| Включить подробное мониторинг (CloudWatch) для экземпляра. | |
| network_interfaces список / элементы=строка | Список существующих сетевых интерфейсов, которые необходимо подключить к экземпляру при запуске. При указании существующих сетевых интерфейсов нельзя использовать ни один из параметров assign_public_ip, private_ip, vpc_subnet_id, group или group_id. (Эти параметры предназначены для создания нового сетевого интерфейса при запуске.) псевдонимы: network_interface | ||
| placement_group строка | Группа размещения для экземпляра при использовании EC2 Clustered Compute. | ||
| private_ip строка | Приватный IP-адрес для назначения экземпляру (из подсети vpc). | ||
| 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 строка | Ramdisk eri для использования с экземпляром. | ||
| 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 | ||
| source_dest_check boolean |
| Включить или выключить проверки источника/назначения (для экземпляров NAT и виртуальных маршрутизаторов). При первоначальном создании экземпляра API EC2 по умолчанию устанавливает это значение в True. | |
| spot_launch_group строка | Группа запуска для запросов spot, см. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-spot-instances-work.html#spot-launch-group. | ||
| цена_рынка строка | Максимальная цена рынка для предложения. Если не задано, запрашивается обычный экземпляр по требованию. Запрос на экземпляр рынка выполняется с этим максимальным предложением. Когда он заполнен, экземпляр запускается. | ||
| тип_рынка строка |
| Тип запроса на экземпляр рынка. После прерывания экземпляр рынка persistent будет запущен, как только появится возможность повторно выполнить запрос. | |
| таймаут_ожидания_рынка целое число | По умолчанию: 600 | Сколько времени ждать выполнения запроса на экземпляр рынка. Оказывает влияние на «Запрос действителен до», для установки срока действия запроса на экземпляр рынка. | |
| состояние строка |
| Создание, завершение, запуск, остановка или перезапуск экземпляров. Состояние «перезапущен» было добавлено в Ansible 2.2. Когда состояние=отсутствует, требуется instance_ids. Когда состояние=работает, состояние=остановлен или состояние=перезапущен, требуется либо instance_ids, либо instance_tags. | |
| аренда строка |
| Экземпляр с арендой dedicated работает на оборудовании с однопользовательской арендой и может запускаться только в VPC.Обратите внимание, что для использования специализированной аренды вы ОБЯЗАТЕЛЬНО должны указать vpc_subnet_id. Специализированная аренда недоступна для экземпляров EC2 «микро». | |
| защита_от_прекращения логическое значение |
| Включить или выключить Защиту от прекращения. По умолчанию false. | |
| данные_пользователя строка | Непрозрачный блок данных, который доступен экземпляру EC2. | ||
| валидировать_сертификаты логическое значение |
| При значении «нет», SSL-сертификаты не будут проверяться для версий boto >= 2.6.0. | |
| тома список / элементы=словарь | Список хешей/словарей томов для добавления к новому экземпляру. | ||
| удалить_при_прекращении логическое значение |
| Должен ли том автоматически удаляться при прекращении работы экземпляра. | |
| имя_устройства строка / обязательно | Имя устройства (например, /dev/sda). | ||
| зашифровано логическое значение |
| Должен ли том быть зашифрован с использованием KMS CMK «aws/ebs». | |
| временный строка | Должен ли том быть временным. Данные на временных томах теряются при остановке экземпляра. Взаимоисключающий параметр с параметром снимок. | ||
| iops целое число | Количество операций ввода/вывода в секунду для выделения тома. Необходимо при volume_type=io1. | ||
| снимок строка | Идентификатор снимка EBS для копирования при создании тома. Взаимоисключающий параметр с параметром временный. | ||
| размер_тома целое число | Размер тома (в ГБ). | ||
| тип_тома строка | Тип тома для создания. См. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html для получения дополнительной информации о доступных типах томов. | ||
| vpc_subnet_id строка | Идентификатор подсети, в которой должен быть запущен экземпляр (VPC). | ||
| ожидание логическое значение |
| Дождаться, пока экземпляр достигнет желаемого состояния перед возвратом. Не ожидает подключения SSH, см. пример «wait_for_connection» для получения подробностей. | |
| таймаут_ожидания целое число | По умолчанию: 300 | Сколько времени ожидание будет ожидать, в секундах. | |
| зона строка | Доступная зона AWS, в которой нужно запустить экземпляр. псевдонимы: aws_zone, ec2_zone | ||
Примечания
Примечание
- Если параметры не установлены в модуле, следующие переменные среды могут использоваться в порядке убывания приоритета
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.
# Basic provisioning example
- amazon.aws.ec2:
key_name: mykey
instance_type: t2.micro
image: ami-123456
wait: yes
group: webserver
count: 3
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
# Advanced example with tagging and CloudWatch
- amazon.aws.ec2:
key_name: mykey
group: databases
instance_type: t2.micro
image: ami-123456
wait: yes
wait_timeout: 500
count: 5
instance_tags:
db: postgres
monitoring: yes
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
# Single instance with additional IOPS volume from snapshot and volume delete on termination
- amazon.aws.ec2:
key_name: mykey
group: webserver
instance_type: c3.medium
image: ami-123456
wait: yes
wait_timeout: 500
volumes:
- device_name: /dev/sdb
snapshot: snap-abcdef12
volume_type: io1
iops: 1000
volume_size: 100
delete_on_termination: true
monitoring: yes
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
# Single instance with ssd gp2 root volume
- amazon.aws.ec2:
key_name: mykey
group: webserver
instance_type: c3.medium
image: ami-123456
wait: yes
wait_timeout: 500
volumes:
- device_name: /dev/xvda
volume_type: gp2
volume_size: 8
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
count_tag:
Name: dbserver
exact_count: 1
# Multiple groups example
- amazon.aws.ec2:
key_name: mykey
group: ['databases', 'internal-services', 'sshable', 'and-so-forth']
instance_type: m1.large
image: ami-6e649707
wait: yes
wait_timeout: 500
count: 5
instance_tags:
db: postgres
monitoring: yes
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
# Multiple instances with additional volume from snapshot
- amazon.aws.ec2:
key_name: mykey
group: webserver
instance_type: m1.large
image: ami-6e649707
wait: yes
wait_timeout: 500
count: 5
volumes:
- device_name: /dev/sdb
snapshot: snap-abcdef12
volume_size: 10
monitoring: yes
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
# Dedicated tenancy example
- amazon.aws.ec2:
assign_public_ip: yes
group_id: sg-1dc53f72
key_name: mykey
image: ami-6e649707
instance_type: m1.small
tenancy: dedicated
vpc_subnet_id: subnet-29e63245
wait: yes
# Spot instance example
- amazon.aws.ec2:
spot_price: 0.24
spot_wait_timeout: 600
keypair: mykey
group_id: sg-1dc53f72
instance_type: m1.small
image: ami-6e649707
wait: yes
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
spot_launch_group: report_generators
instance_initiated_shutdown_behavior: terminate
# Examples using pre-existing network interfaces
- amazon.aws.ec2:
key_name: mykey
instance_type: t2.small
image: ami-f005ba11
network_interface: eni-deadbeef
- amazon.aws.ec2:
key_name: mykey
instance_type: t2.small
image: ami-f005ba11
network_interfaces: ['eni-deadbeef', 'eni-5ca1ab1e']
# Launch instances, runs some tasks
# and then terminate them
- name: Create a sandbox instance
hosts: localhost
gather_facts: False
vars:
keypair: my_keypair
instance_type: m1.small
security_group: my_securitygroup
image: my_ami_id
region: us-east-1
tasks:
- name: Launch instance
amazon.aws.ec2:
key_name: "{{ keypair }}"
group: "{{ security_group }}"
instance_type: "{{ instance_type }}"
image: "{{ image }}"
wait: true
region: "{{ region }}"
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
register: ec2
- name: Add new instance to host group
add_host:
hostname: "{{ item.public_ip }}"
groupname: launched
loop: "{{ ec2.instances }}"
- name: Wait for SSH to come up
delegate_to: "{{ item.public_dns_name }}"
wait_for_connection:
delay: 60
timeout: 320
loop: "{{ ec2.instances }}"
- name: Configure instance(s)
hosts: launched
become: True
gather_facts: True
roles:
- my_awesome_role
- my_awesome_test
- name: Terminate instances
hosts: localhost
tasks:
- name: Terminate instances that were previously launched
amazon.aws.ec2:
state: 'absent'
instance_ids: '{{ ec2.instance_ids }}'
# Start a few existing instances, run some tasks
# and stop the instances
- name: Start sandbox instances
hosts: localhost
gather_facts: false
vars:
instance_ids:
- 'i-xxxxxx'
- 'i-xxxxxx'
- 'i-xxxxxx'
region: us-east-1
tasks:
- name: Start the sandbox instances
amazon.aws.ec2:
instance_ids: '{{ instance_ids }}'
region: '{{ region }}'
state: running
wait: True
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
roles:
- do_neat_stuff
- do_more_neat_stuff
- name: Stop sandbox instances
hosts: localhost
gather_facts: false
vars:
instance_ids:
- 'i-xxxxxx'
- 'i-xxxxxx'
- 'i-xxxxxx'
region: us-east-1
tasks:
- name: Stop the sandbox instances
amazon.aws.ec2:
instance_ids: '{{ instance_ids }}'
region: '{{ region }}'
state: stopped
wait: True
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
#
# Start stopped instances specified by tag
#
- amazon.aws.ec2:
instance_tags:
Name: ExtraPower
state: running
#
# Restart instances specified by tag
#
- amazon.aws.ec2:
instance_tags:
Name: ExtraPower
state: restarted
#
# Enforce that 5 instances with a tag "foo" are running
# (Highly recommended!)
#
- amazon.aws.ec2:
key_name: mykey
instance_type: c1.medium
image: ami-40603AD1
wait: yes
group: webserver
instance_tags:
foo: bar
exact_count: 5
count_tag: foo
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
#
# Enforce that 5 running instances named "database" with a "dbtype" of "postgres"
#
- amazon.aws.ec2:
key_name: mykey
instance_type: c1.medium
image: ami-40603AD1
wait: yes
group: webserver
instance_tags:
Name: database
dbtype: postgres
exact_count: 5
count_tag:
Name: database
dbtype: postgres
vpc_subnet_id: subnet-29e63245
assign_public_ip: yes
#
# count_tag complex argument examples
#
# instances with tag foo
- amazon.aws.ec2:
count_tag:
foo:
# instances with tag foo=bar
- amazon.aws.ec2:
count_tag:
foo: bar
# instances with tags foo=bar & baz
- amazon.aws.ec2:
count_tag:
foo: bar
baz:
# instances with tags foo & bar & baz=bang
- amazon.aws.ec2:
count_tag:
- foo
- bar
- baz: bang
Авторы
- Tim Gerla (@tgerla)
- Lester Wade (@lwade)
- Seth Vidal (@skvidal)
© 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/amazon/aws/ec2_module.html