Spec-Zone.ru › Ansible 2.4

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

  • Краткое описание
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Примечания
    • Состояние
    • Информация о техническом обслуживании

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

  • Создает или завершает экземпляры ec2.
  • state=restarted добавлено в 2.2

Требования (к хосту, на котором выполняется модуль)

  • python >= 2.6
  • boto

Параметры

параметр обязательный значение по умолчанию варианты комментарии
assign_public_ip
(добавлено в 1.5)
нет
  • да
  • нет
при развертывании внутри 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)
нет false
использует ли экземпляр оптимизированные 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 группы безопасности (или список идентификаторов) для использования с экземпляром
id
нет
идентификатор для этого экземпляра или набора экземпляров, чтобы модуль был идемпотентным относительно экземпляров EC2. Этот идентификатор действителен как минимум 24 часа после завершения работы экземпляра и не должен повторно использоваться для другого вызова позже. Подробнее см. описание токена клиента по адресу http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html.
image
да
ami ID для использования экземпляром
instance_ids
(добавлено в 1.3)
нет
список идентификаторов экземпляров, в настоящее время используется для состояний: absent, running, stopped
псевдонимы: instance_id
instance_initiated_shutdown_behavior
(добавлено в 2.2)
нет stop
  • stop
  • terminate
Установить, будет ли AWS останавливать или завершать работу экземпляра при выключении. Этот параметр игнорируется при использовании образов instance-store (которые требуют завершения работы при выключении).
instance_profile_name
(добавлено в 1.3)
нет
Имя профиля экземпляра 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
нет
eki ядра для использования экземпляром
key_name
нет
пара ключей для использования на экземпляре
псевдонимы: keypair
monitoring
нет
  • да
  • нет
включить подробный мониторинг (CloudWatch) для экземпляра
network_interfaces
(добавлено в 2.0)
нет
Список существующих сетевых интерфейсов, которые необходимо подключить к экземпляру при запуске. При указании существующих сетевых интерфейсов нельзя использовать параметры assign_public_ip, private_ip, vpc_subnet_id, group или group_id. (Эти параметры предназначены для создания нового сетевого интерфейса при запуске.)
псевдонимы: network_interface
placement_group
(добавлено в 1.3)
нет
группа размещения для экземпляра при использовании EC2 кластерного вычисления
private_ip
нет
приватный IP-адрес для назначения экземпляра (из подсети vpc)
profile
(добавлено в 1.6)
нет
Использует профиль boto. Работает только с boto >= 2.24.0.
ramdisk
нет
ramdisk eri для использования экземпляром
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
(добавлено в 1.6)
нет True
  • да
  • нет
Включить или выключить проверки источника/назначения (для экземпляров NAT и виртуальных маршрутизаторов)
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
  • one-time
  • persistent
Тип запроса spot; один из "one-time" или "persistent". По умолчанию "one-time", если не указан.
spot_wait_timeout
(добавлено в 1.5)
нет 600
сколько времени ждать, пока запрос на spot-экземпляр не будет выполнен
state
(добавлено в 1.3)
нет present
  • present
  • absent
  • running
  • restarted
  • stopped
создать или завершить работу экземпляров
tenancy
(добавлено в 1.9)
нет default
  • default
  • dedicated
Экземпляр с арендой "dedicated" работает на оборудовании с арендой одного клиента и может быть запущен только в VPC. Обратите внимание, что для использования аренды "dedicated" ОБЯЗАТЕЛЬНО нужно указать vpc_subnet_id. Аренда "dedicated" недоступна для экземпляров EC2 "micro".
termination_protection
(добавлено в 2.0)
нет
  • да
  • нет
Включить или выключить защиту от завершения работы
user_data
нет
неструктурированные данные, доступные экземпляру ec2
validate_certs
(добавлено в 1.5)
нет да
  • да
  • нет
При значении "нет", сертификаты 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), iops (int) - device_type устарел, используйте volume_type, iops должен быть установлен, когда volume_type='io1', ephemeral и snapshot взаимоисключающие.
vpc_subnet_id
нет
ID подсети, в которой необходимо запустить экземпляр (VPC)
wait
нет нет
  • да
  • нет
подождать, пока экземпляр достигнет желаемого состояния, прежде чем возвращаться. Не ждет SSH, см. пример 'wait_for' для подробностей.
wait_timeout
нет 300
время ожидания, прежде чем ожидание прекращается, в секундах
zone
нет
зона доступности AWS, в которой необходимо запустить экземпляр
псевдонимы: aws_zone, ec2_zone

Примеры

# 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
    count_tag:
        foo:

    # instances with tag foo=bar
    count_tag:
        foo: bar

    # instances with tags foo=bar & baz
    count_tag:
        foo: bar
        baz:

    # instances with tags foo & bar & baz=bang
    count_tag:
        - foo
        - bar
        - baz: bang

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые с предыдущими версиями изменения интерфейса.

Информация о техническом обслуживании

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этом knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, прочитайте Информацию о сообществе и внесении вклада, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ec2_module.html

Spec-Zone.ru

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