ec2 - создание, завершение, запуск или остановка экземпляра в ec2
Описание
- Создаёт или завершает экземпляры ec2.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| assign_public_ip (добавлено в 1.5) |
| при развертывании внутри vpc, назначить публичный IP-адрес. Библиотека Boto должна быть версии 2.13.0+ |
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key |
| count | Значение по умолчанию: 1 | количество экземпляров для запуска |
| count_tag (добавлено в 1.5) | Значение по умолчанию: None | Используется с 'exact_count' для определения, сколько узлов, соответствующих определенным критериям тега, должно работать. Это может быть выражено различными способами, что показано в разделе ПРИМЕРЫ. Например, можно запросить 25 серверов, помеченных тегом "class=webserver". Указанный тег должен уже существовать или быть передан в качестве параметра 'instance_tags'. |
| ebs_optimized (добавлено в 1.6) | Значение по умолчанию: false | используются ли оптимизированные EBS-тома для экземпляра, см. http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
|
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. |
| exact_count (добавлено в 1.5) | Значение по умолчанию: None | Целочисленное значение, указывающее количество экземпляров, соответствующих параметру 'count_tag', которые должны работать. Экземпляры либо создаются, либо завершаются в зависимости от этого значения. |
| group | Значение по умолчанию: None | группа безопасности (или список групп) для использования с экземпляром псевдонимы: groups |
| group_id | Значение по умолчанию: None | идентификатор группы безопасности (или список идентификаторов) для использования с экземпляром |
| id | Значение по умолчанию: None | идентификатор этого экземпляра или набора экземпляров, чтобы модуль был идемпотентным по отношению к экземплярам EC2. Этот идентификатор действителен в течение как минимум 24 часов после завершения работы экземпляра и не должен повторно использоваться для другого вызова позже. Подробнее см. описание маркера клиента по адресу http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html. |
| image обязательно | Значение по умолчанию: None |
ID ami для использования экземпляром |
| instance_ids (добавлено в 1.3) | Значение по умолчанию: None | список идентификаторов экземпляров, в настоящее время используется для состояний: отсутствующий, работающий, остановленный псевдонимы: instance_id |
| instance_initiated_shutdown_behavior (добавлено в 2.2) |
| Указывает, будет ли AWS останавливать или завершать экземпляр при выключении. Этот параметр игнорируется при использовании образов с хранилищем экземпляра (которые требуют завершения при выключении). |
| instance_profile_name (добавлено в 1.3) | Значение по умолчанию: None | Имя профиля экземпляра IAM для использования. Библиотека Boto должна быть версии 2.5.0+ |
| instance_tags | Значение по умолчанию: None | словарь тегов для добавления к новому экземпляру или для запуска/остановки экземпляра по тегу; '{"key":"value"}' и '{"key":"value","key":"value"}' |
| instance_type обязательно | Значение по умолчанию: None | тип экземпляра для использования, см. http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
| kernel | Значение по умолчанию: None | ядро eki для использования экземпляром |
| key_name | Значение по умолчанию: None | ключ пары для использования на экземпляре псевдонимы: keypair |
| monitoring |
| включить подробный мониторинг (CloudWatch) для экземпляра |
| network_interfaces (добавлено в 2.0) | Значение по умолчанию: None | Список существующих сетевых интерфейсов для подключения к экземпляру при запуске. При указании существующих сетевых интерфейсов ни один из параметров assign_public_ip, private_ip, vpc_subnet_id, group или group_id не может быть использован. (Эти параметры предназначены для создания нового сетевого интерфейса при запуске.) псевдонимы: network_interface |
| placement_group (добавлено в 1.3) | Значение по умолчанию: None | группа размещения для экземпляра при использовании EC2 Clustered Compute |
| private_ip | Значение по умолчанию: None | приватный IP-адрес для назначения экземпляра (из подсети vpc) |
| profile (добавлено в 1.6) | Значение по умолчанию: None | Использует профиль boto. Работает только с boto >= 2.24.0. |
| ramdisk | Значение по умолчанию: None | диск оперативной памяти eri для использования экземпляром |
| region | Значение по умолчанию: None | Регион AWS для использования. Должен быть указан, если ec2_url не используется. Если не указан, используется значение переменной окружения EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region |
| security_token (добавлено в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token |
| source_dest_check (добавлено в 1.6) |
| Включить или выключить проверки источника/назначения (для экземпляров NAT и виртуальных маршрутизаторов) |
| spot_launch_group (добавлено в 2.1) | Значение по умолчанию: None | Группа запуска для запроса spot, см. http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-spot-instances-work.html#spot-launch-group
|
| spot_price (добавлено в 1.5) | Значение по умолчанию: None | Максимальная цена spot-запроса, если не задана, запрашивается обычный экземпляр на основе спроса. С этим максимальным значением делается запрос spot. Когда он заполняется, экземпляр запускается. |
| spot_type (добавлено в 2.0) |
| Тип запроса spot; один из "одноразовый" или "постоянный". По умолчанию "одноразовый", если не указано. |
| spot_wait_timeout (добавлено в 1.5) | Значение по умолчанию: 600 | время ожидания выполнения запроса spot-экземпляра |
| state (добавлено в 1.3) |
| создание, завершение, запуск, остановка или перезагрузка экземпляров. Состояние 'restarted' было добавлено в 2.2 |
| tenancy (added in 1.9) |
| Экземпляр с tenancy «dedicated» работает на оборудовании с единым арендатором и может быть запущен только в VPC. Обратите внимание, что для использования dedicated tenancy НЕОБХОДИМО указать vpc_subnet_id. Dedicated tenancy недоступно для экземпляров EC2 «micro». |
| termination_protection (added in 2.0) |
| Включить или отключить защиту от завершения работы |
| user_data | Default: None | неструктурированные данные, доступные для экземпляра ec2 |
| validate_certs (added in 1.5) |
| При значении «no» сертификаты SSL не будут проверяться для версий boto >= 2.6.0. |
| volumes (added in 1.5) | Default: None | список словарей объёмов для добавления в новый экземпляр; '[{"key":"value", "key":"value"}]'; разрешенные ключи — device_name (строка; обязательна), delete_on_termination (логическое значение; False), device_type (устарел), ephemeral (строка), encrypted (логическое значение; False), snapshot (строка), volume_type (строка), iops (целое число) — device_type устарел, используйте volume_type, iops должен быть задан, когда volume_type='io1', ephemeral и snapshot взаимоисключающие. |
| vpc_subnet_id | Default: None | идентификатор подсети, в которой необходимо запустить экземпляр (VPC) |
| wait |
| ожидание достижения экземпляром желаемого состояния перед возвратом. Не ожидает SSH, см. пример «wait_for» для получения подробностей. |
| wait_timeout | Default: 300 | время ожидания, прежде чем wait прекратит работу, в секундах |
| zone | Default: None | доступная зона 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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
# 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:
key_name: 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
with_items: "{{ ec2.instances }}"
- name: Wait for SSH to come up
wait_for:
host: "{{ item.public_dns_name }}"
port: 22
delay: 60
timeout: 320
state: started
with_items: "{{ 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
connection: local
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
connection: local
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
connection: local
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, что означает, что разработчики этого модуля гарантируют отсутствие несовместимых с предыдущими версиями изменений интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний
Автор
- Tim Gerla (@tgerla)
- Lester Wade (@lwade)
- Seth Vidal
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ec2_module.html