Spec-Zone.ru › Ansible 2.7

ec2 – создание, завершение, запуск или остановка экземпляра в ec2

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Статус

Краткое описание

  • Создаёт или завершает экземпляры ec2.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.6
  • boto

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
assign_public_ip
boolean
добавлен в 1.5
    Варианты:
  • no
  • yes
При развертывании внутри 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
-
добавлен в 1.5
Используется с 'exact_count' для определения, сколько узлов, соответствующих определенным критериям тегов, должно быть запущено. Это может быть выражено различными способами, как показано в разделе ПРИМЕРЫ. Например, можно запросить 25 серверов, помеченных тегом "class=webserver". Указанный тег должен уже существовать или быть передан как опция 'instance_tags'.
ebs_optimized
-
добавлен в 1.6
Значение по умолчанию:
"no"
Используются ли оптимизированные EBS-тома для экземпляра, см. http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
ec2_url
-
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть.
exact_count
-
добавлен в 1.5
Целочисленное значение, которое указывает, сколько экземпляров, соответствующих параметру 'count_tag', должно быть запущено. Экземпляры создаются или удаляются в соответствии с этим значением.
group
-
Группа безопасности (или список групп), используемая с экземпляром.

псевдонимы: groups
group_id
-
Идентификатор группы безопасности (или список идентификаторов) для использования с экземпляром.
id
-
Идентификатор для данного экземпляра или набора экземпляров, чтобы модуль был идемпотентным по отношению к экземплярам EC2. Этот идентификатор действителен не менее 24 часов после завершения работы экземпляра и не должен повторно использоваться для другого вызова позднее. Подробнее см. описание маркера клиента в http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html.
image
- / обязательно
ID AMI для использования в экземпляре
instance_ids
-
добавлен в 1.3
Список идентификаторов экземпляров, в настоящее время используется для состояний: absent, running, stopped

псевдонимы: instance_id
instance_initiated_shutdown_behavior
-
добавлен в 2.2
    Варианты:
  • stop ←
  • terminate
Установите, будет ли AWS останавливать или завершать работу экземпляра при выключении. Этот параметр игнорируется при использовании образов instance-store (которые требуют завершения работы при выключении).
instance_profile_name
-
добавлен в 1.3
Имя профиля IAM экземпляра (то, что обозначается в консоли EC2 как "роль IAM") для использования. Библиотека Boto должна быть версии 2.5.0+
instance_tags
-
Словарь тегов для добавления к новому экземпляру или для запуска/остановки экземпляра по тегу; '{"key":"value"}' и '{"key":"value","key":"value"}'
instance_type
- / обязательно
тип экземпляра для использования в экземпляре, см. http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
kernel
-
ядро для использования в экземпляре
key_name
-
пара ключей для использования в экземпляре

псевдонимы: keypair
monitoring
boolean
    Варианты:
  • no ←
  • yes
Включить подробное мониторинг (CloudWatch) для экземпляра
network_interfaces
-
добавлен в 2.0
Список существующих сетевых интерфейсов для подключения к экземпляру при запуске. При указании существующих сетевых интерфейсов не допускается использование параметров assign_public_ip, private_ip, vpc_subnet_id, group или group_id. (Эти параметры предназначены для создания нового сетевого интерфейса при запуске.)

псевдонимы: network_interface
placement_group
-
добавлен в 1.3
группа размещения для экземпляра при использовании EC2 Clustered Compute
private_ip
-
приватный IP-адрес для присвоения экземпляру (из подсети vpc)
profile
-
добавлен в 1.6
Использует профиль boto. Работает только с boto >= 2.24.0.
ramdisk
-
ramdisk для использования в экземпляре
region
-
Регион 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
Безопасный токен AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

псевдонимы: access_token
source_dest_check
boolean
добавлен в 1.6
    Варианты:
  • no
  • yes
Включить или отключить проверки источника/назначения (для экземпляров NAT и виртуальных маршрутизаторов). При первоначальном создании экземпляра API EC2 по умолчанию устанавливает это значение в True.
spot_launch_group
-
добавлен в 2.1
Группа запуска для запроса spot, см. http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-spot-instances-work.html#spot-launch-group
spot_price
-
добавлен в 1.5
Максимальная цена spot для торгов, если не задано, запрашивается обычный экземпляр on-demand. С этим максимальным значением делается запрос spot. При его выполнении экземпляр запускается.
spot_type
-
добавлен в 2.0
    Варианты:
  • one-time ←
  • persistent
Тип запроса на выделение; один из "one-time" или "persistent". По умолчанию "one-time", если не указано.
spot_wait_timeout
-
добавлен в 1.5
По умолчанию:
600
Сколько ждать выполнения запроса на выделение экземпляра
state
-
добавлен в 1.3
    Варианты:
  • present ←
  • absent
  • running
  • restarted
  • stopped
создание, завершение, запуск, остановка или перезапуск экземпляров. Состояние 'restarted' было добавлено в 2.2
tenancy
-
добавлен в 1.9
    Варианты:
  • default ←
  • dedicated
Экземпляр с tenancy "dedicated" работает на оборудовании с однопользовательской арендой и может быть запущен только в VPC. Обратите внимание, что для использования dedicated tenancy необходимо также указать vpc_subnet_id. Dedicated tenancy недоступен для экземпляров EC2 "micro".
termination_protection
boolean
добавлен в 2.0
    Варианты:
  • no ←
  • yes
Включить или отключить защиту от завершения
user_data
-
неструктурированные данные, доступные экземпляру ec2
validate_certs
boolean
добавлен в 1.5
    Варианты:
  • no
  • yes ←
Если установлено "no", сертификаты SSL не будут проверяться для версий boto >= 2.6.0.
volumes
-
добавлен в 1.5
список словарей с объёмами, добавляемыми к новому экземпляру; '[{"key":"value", "key":"value"}]'; разрешенные ключи - device_name (str; обязателен), delete_on_termination (bool; False), device_type (устарел), ephemeral (str), encrypted (bool; False), snapshot (str), volume_type (str), volume_size (int, ГБ), iops (int) - device_type устарел, используйте volume_type, iops должен быть установлен при volume_type='io1', ephemeral и snapshot взаимоисключающие.
vpc_subnet_id
-
Идентификатор подсети, в которой нужно запустить экземпляр (VPC)
wait
boolean
    Варианты:
  • no ←
  • yes
подождать, пока экземпляр достигнет желаемого состояния перед возвратом. Не ждёт 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

# 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
      with_items: "{{ ec2.instances }}"

    - name: Wait for SSH to come up
      delegate_to: "{{ item.public_dns_name }}"
      wait_for_connection:
        delay: 60
        timeout: 320
      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]
  • Этот модуль поддерживается Командой ядра Ansible. [core]

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля Red Hat можно найти в этой статье базы знаний 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.7/modules/ec2_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API