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_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 группы безопасности (или список ID) для использования с экземпляром. | |
| id строка | Идентификатор для данного экземпляра или набора экземпляров, чтобы модуль был идемпотентным по отношению к экземплярам EC2. Этот идентификатор действителен как минимум 24 часа после завершения работы экземпляра и не должен повторно использоваться для последующего вызова. Подробнее см. описание маркера клиента на https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html. | |
| image строка / обязательно |
AMI ID для использования экземпляром. | |
| instance_ids список | Список ID экземпляров, в настоящее время используется для состояний: отсутствует, запущен, остановлен псевдонимы: instance_id | |
| instance_initiated_shutdown_behavior строка добавлено в 2.2 |
| Устанавливает, будет ли AWS останавливать или прекращать работу экземпляра при выключении. Этот параметр игнорируется при использовании образов instance-store (которые требуют завершения работы при выключении). |
| instance_profile_name строка | Имя профиля IAM экземпляра (то, что обозначается в консоли EC2 как "роль IAM") для использования. Библиотека Boto должна быть версии 2.5.0 или выше. | |
| instance_tags словарь | Хэш/словарь тегов для добавления к новому экземпляру или для запуска/остановки экземпляра по тегу; '{"ключ":"значение"}' и '{"ключ":"значение","ключ":"значение"}'. | |
| instance_type строка / обязательно | Тип экземпляра для использования, см. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html. | |
| kernel строка | Ядро для использования экземпляром. | |
| key_name строка | Пара ключа для использования на экземпляре. псевдонимы: keypair | |
| monitoring boolean |
| Включить подробный мониторинг (CloudWatch) для экземпляра. |
| network_interfaces список добавлено в 2.0 | Список существующих сетевых интерфейсов для подключения к экземпляру при запуске. При указании существующих сетевых интерфейсов нельзя использовать ни один из параметров 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 строка | Диск RAM для использования экземпляром. | |
| region строка | AWS регион для использования. Должен быть указан, если ec2_url не используется. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть.псевдонимы: aws_region, ec2_region | |
| security_token строка | AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| source_dest_check boolean |
| Включить или выключить проверки источника/назначения (для экземпляров NAT и виртуальных маршрутизаторов). При первоначальном создании экземпляра API EC2 по умолчанию устанавливает это значение в True. |
| spot_launch_group строка добавлено в 2.1 | Группа запуска для запроса spot, см. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-spot-instances-work.html#spot-launch-group. |
| цена_рынка строка | Максимальная цена рынка для предложения. Если не установлено, запрашивается обычный экземпляр по требованию. Запрос на место осуществляется с этим максимальным предложением. При его выполнении экземпляр запускается. | |
| тип_места строка добавлен в 2.0 |
| Тип запроса на место; один из "одноразовое" или "постоянное". По умолчанию "одноразовое", если не указано. |
| время_ожидания_места целое | По умолчанию: 600 | Время ожидания выполнения запроса на экземпляр места. |
| состояние строка |
| Создание, завершение, запуск, остановка или перезапуск экземпляров. Состояние 'перезапущен' было добавлено в Ansible 2.2. При 'отсутствует', instance_ids требуется. При 'работает', 'остановлен' и 'перезапущен', instance_ids или instance_tags требуется. |
| tenancy строка |
| Экземпляр с арендой "специализированный" работает на оборудовании с единым арендатором и может быть запущен только в VPC. Обратите внимание, что для использования специализированной аренды вы ОБЯЗАТЕЛЬНО должны указать vpc_subnet_id. Специализированная аренда недоступна для экземпляров EC2 "микро". |
| защита_от_прекращения логическое добавлен в 2.0 |
| Включить или выключить защиту от прекращения работы. |
| user_data строка | Непрозрачный блок данных, который доступен экземпляру EC2. | |
| validate_certs логическое |
| При установке в "нет", сертификаты SSL не будут проверяться для версий boto >= 2.6.0. |
| volumes список | список хешей/словаря объемов для добавления в новый экземпляр; '[{"key":"value", "key":"value"}]'; разрешенные ключи - device_name (строка; требуется), delete_on_termination (логическое; False), device_type (устарело), ephemeral (строка), encrypted (логическое; False), snapshot (строка), volume_type (строка), volume_size (целое, GiB), iops (целое) - device_type устарел, используйте volume_type, iops должен быть установлен при volume_type='io1', ephemeral и snapshot взаимоисключающие. | |
| vpc_subnet_id строка | Идентификатор подсети, в которой нужно запустить экземпляр (VPC). | |
| wait логическое |
| Дождаться, пока экземпляр достигнет желаемого состояния перед возвратом. Не ждет SSH, см. пример 'wait_for_connection' для получения подробностей. |
| время_ожидания целое | По умолчанию: 300 | Сколько времени ждать, пока wait сдастся, в секундах. |
| зона строка | Доступная зона 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
# 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]
Поддержка 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.8/modules/ec2_module.html