ec2 – создание, завершение, запуск или остановка экземпляра в ec2
Краткое описание
- Создаёт или завершает экземпляры 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. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | AWS секретный ключ. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | |
| count целое число | Значение по умолчанию: 1 | Количество экземпляров для запуска. |
| count_tag - | Используется с параметром 'exact_count' для определения, сколько узлов, соответствующих определённым критериям тегов, должно работать. Это может быть выражено несколькими способами, как показано в разделе ПРИМЕРЫ. Например, можно запросить 25 серверов, помеченных тегом "class=webserver". Указанный тег должен уже существовать или быть передан в качестве параметра 'instance_tags'. | |
| debug_botocore_endpoint_logs boolean добавлено в 2.8 |
| Использовать регистратор botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action» во время задачи, выводимых в ключ 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, если таковая имеется. | |
| 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 идентификатор для использования с экземпляром. | |
| 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","key":"value"}'. | |
| instance_type строка / обязательно | Тип экземпляра для использования с экземпляром, см. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html. | |
| kernel строка | Ядро eki для использования с экземпляром. | |
| key_name строка | Пара ключей для использования на экземпляре. SSH-ключ должен существовать в AWS, чтобы использовать этот аргумент. Если вы хотите сгенерировать ключи из Ansible, посмотрите модуль `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. | |
| ramdisk строка | Рамдиск eri для использования с экземпляром. | |
| region строка | AWS регион для использования. Должен быть указан, если ec2_url не используется. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется.псевдонимы: aws_region, ec2_region | |
| security_token строка | AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_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. | |
| spot_price строка | Максимальная цена за использование spot. Если не задана, запрашивается обычный экземпляр по запросу. Запрос на spot выполняется с максимальной ставкой. При выполнении запрос экземпляр запускается. |
| spot_type строка |
| Тип запроса на зарезервированный экземпляр; один из "one-time" или "persistent". По умолчанию "one-time", если не указано. |
| spot_wait_timeout целое число | Значение по умолчанию: 600 | Сколько ждать, пока запрос на экземпляр зарезервированного ресурса будет выполнен. Влияет на 'Request valid until' для установки срока действия запроса на зарезервированный ресурс. |
| state строка |
| Создание, завершение, запуск, остановка или перезапуск экземпляров. Состояние 'restarted' было добавлено в Ansible 2.2. При 'absent', instance_ids требуется. При 'running', 'stopped' и 'restarted', instance_ids или instance_tags требуется. |
| tenancy строка |
| Экземпляр с типом tenancy "dedicated" работает на оборудовании с отдельным арендатором и может быть запущен только в VPC. Обратите внимание, что для использования dedicated tenancy необходимо также указать vpc_subnet_id. Dedicated tenancy недоступен для экземпляров EC2 "micro". |
| termination_protection булево |
| Включить или выключить защиту от завершения. |
| user_data строка | Непрозрачный блок данных, который доступен экземпляру EC2. | |
| validate_certs булево |
| Если установлено "no", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
| volumes список | Список хешей/словарей дисков для добавления к новому экземпляру; '[{"key":"value", "key":"value"}]'; разрешенные ключи - device_name (строка; обязательный), delete_on_termination (булево; False), ephemeral (строка), encrypted (булево; False), snapshot (строка), volume_type (строка), volume_size (целое число, GiB), iops (целое число) - iops должен быть установлен, когда volume_type='io1', ephemeral и snapshot взаимоисключающие. | |
| vpc_subnet_id строка | Идентификатор подсети, в которой должен быть запущен экземпляр (VPC). | |
| wait булево |
| Подождать, пока экземпляр достигнет желаемого состояния, прежде чем вернуть результат. Не ожидает SSH, см. пример 'wait_for_connection' для получения подробностей. |
| wait_timeout целое число | Значение по умолчанию: 300 | Сколько ждать, прежде чем ожидание прекратится, в секундах. |
| zone строка | Доступная зона AWS, в которой должен быть запущен экземпляр. алиасы: aws_zone, ec2_zone |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Basic provisioning example
- 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
- 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
- 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
- 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
- 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
- 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
- local_action:
module: 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
- 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
- ec2:
key_name: mykey
instance_type: t2.small
image: ami-f005ba11
network_interface: eni-deadbeef
- 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
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
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
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
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
#
- local_action:
module: ec2
instance_tags:
Name: ExtraPower
state: running
#
# Restart instances specified by tag
#
- local_action:
module: ec2
instance_tags:
Name: ExtraPower
state: restarted
#
# Enforce that 5 instances with a tag "foo" are running
# (Highly recommended!)
#
- 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"
#
- 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
- ec2:
count_tag:
foo:
# instances with tag foo=bar
- ec2:
count_tag:
foo: bar
# instances with tags foo=bar & baz
- ec2:
count_tag:
foo: bar
baz:
# instances with tags foo & bar & baz=bang
- ec2:
count_tag:
- foo
- bar
- baz: bang
Статус
- Этот модуль гарантирует обратную совместимость изменений интерфейса в дальнейшем. [stableinterface]
- Этот модуль поддерживается командой Ansible Core. [core]
Поддержка Red Hat
Дополнительная информация о поддержке Red Hat этого модуля доступна в этой статье базы знаний Red Hat.
Авторы
- Tim Gerla (@tgerla)
- Lester Wade (@lwade)
- Seth Vidal (@skvidal)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете изменить этот документ, чтобы улучшить его.
© 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_module.html