Spec-Zone.ru › Ansible 2.7

ec2_lc – Создание или удаление конфигураций запуска AWS Autoscaling

Новая версия с 1.6.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

  • Может создавать или удалять конфигурации запуска AWS Autoscaling
  • Работает с модулем ec2_asg для управления группами Autoscaling

Требования

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

  • boto
  • boto3 >= 1.4.4
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
assign_public_ip
-
добавлен в 1.8
Используется для групп Auto Scaling, запускающих экземпляры в Amazon Virtual Private Cloud. Указывает, следует ли назначать общедоступный IP-адрес каждому экземпляру, запущенному в Amazon VPC.
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
classic_link_vpc_id
-
добавлен в 2.0
Идентификатор VPC с включенной функцией ClassicLink.
classic_link_vpc_security_groups
-
добавлен в 2.0
Список идентификаторов групп безопасности, которые нужно связать с экземплярами ClassicLink VPC.
ebs_optimized
-
добавлен в 1.8
По умолчанию:
"нет"
Указывает, оптимизирован ли экземпляр для ввода/вывода EBS (true) или нет (false).
ec2_url
-
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
image_id
-
Уникальный идентификатор AMI, который будет использоваться для группы.
instance_id
-
добавлен в 2.4
Идентификатор работающего экземпляра, который используется в качестве основы для конфигурации запуска. Может использоваться вместо image_id и instance_type.
instance_monitoring
boolean
    Варианты:
  • нет ←
  • да
Указывает, запускаются ли экземпляры с подробным мониторингом.
instance_profile_name
-
добавлен в 1.8
Имя или Amazon Resource Name (ARN) профиля экземпляра, связанного с ролью IAM для экземпляров.
instance_type
- / обязательно
Тип экземпляра для использования в экземпляре
kernel_id
-
Идентификатор ядра для экземпляра EC2
key_name
-
Имя SSH-ключа, которое используется для доступа к управляемым экземплярам
name
- / обязательно
Уникальное имя конфигурации
placement_tenancy
-
добавлен в 2.4
По умолчанию:
"по умолчанию"
Определяет, работает ли экземпляр на одноарендаторском оборудовании или нет.
profile
-
добавлен в 1.6
Использует профиль boto. Работает только с boto >= 2.24.0.
ramdisk_id
-
добавлен в 1.8
Идентификатор RAM-диска для экземпляров.
region
-
AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
security_groups
-
Список групп безопасности, которые нужно применить к экземплярам. С версии 2.4 можно указать имена или ID групп безопасности, или их смесь. До версии 2.4 для экземпляров VPC указывались ID групп безопасности, а для экземпляров EC2-Classic — имена или ID групп безопасности.
security_token
-
добавлен в 1.6
AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

псевдонимы: access_token
spot_price
-
Цена, которую вы предлагаете. Применимо только для группы autoscaling с экземплярами spot.
state
-
    Варианты:
  • present ←
  • absent
Регистрация или отмена регистрации экземпляра
user_data
-
Необработанные данные, которые предоставляются экземпляру ec2. Взаимоисключающее с user_data_path.
user_data_path
-
добавлен в 2.3
Путь к файлу, содержащему данные пользователя для экземпляров ec2. Взаимоисключающее с user_data.
validate_certs
boolean
добавлен в 1.5
    Варианты:
  • нет
  • да ←
Если установлено «нет», сертификаты SSL для boto версий >= 2.6.0 не будут проверены.
volumes
-
Список словарей томов, каждый из которых содержит имя устройства и необязательно ephemeral id или id снимка. Размер и тип (и количество iops для типа устройства io) должны быть указаны для нового тома или корневого тома, и могут быть переданы для тома снимка. Для любого тома размер тома меньше 1 будет интерпретироваться как запрос не создавать том.
vpc_id
-
добавлен в 2.4
Идентификатор VPC, используемый при разрешении имен групп безопасности до ID.

Примечания

Примечание

  • Конфигурации запуска Amazon ASG Autoscaling являются неизменяемыми после создания, поэтому изменение конфигурации после её изменения не повлияет на конфигурацию запуска в AWS. Вы должны создать новую конфигурацию и назначить её ASG вместо этого.
  • Шифрованные тома поддерживаются в версиях >= 2.4
  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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

Примеры

# create a launch configuration using an AMI image and instance type as a basis

- name: note that encrypted volumes are only supported in >= Ansible 2.4
  ec2_lc:
    name: special
    image_id: ami-XXX
    key_name: default
    security_groups: ['group', 'group2' ]
    instance_type: t1.micro
    volumes:
    - device_name: /dev/sda1
      volume_size: 100
      volume_type: io1
      iops: 3000
      delete_on_termination: true
      encrypted: true
    - device_name: /dev/sdb
      ephemeral: ephemeral0

# create a launch configuration using a running instance id as a basis

- ec2_lc:
    name: special
    instance_id: i-00a48b207ec59e948
    key_name: default
    security_groups: ['launch-wizard-2' ]
    volumes:
    - device_name: /dev/sda1
      volume_size: 120
      volume_type: io1
      iops: 3000
      delete_on_termination: true

# create a launch configuration to omit the /dev/sdf EBS device that is included in the AMI image

- ec2_lc:
    name: special
    image_id: ami-XXX
    key_name: default
    security_groups: ['group', 'group2' ]
    instance_type: t1.micro
    volumes:
    - device_name: /dev/sdf
      no_device: true

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ Возвращаемое значение Описание
arn
строка
при state=present
Amazon Resource Name (ARN) конфигурации запуска.

Пример:
arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name
changed
логический тип
всегда
Изменилось ли состояние конфигурации запуска.

created_time
строка
при state=present
Дата и время создания конфигурации запуска.

Пример:
2017-11-03 23:46:44.841000
image_id
строка
при state=present
Идентификатор Amazon Machine Image, используемый конфигурацией запуска.

Пример:
ami-9be6f38c
instance_type
строка
при state=present
Тип экземпляра для экземпляров.

Пример:
t1.micro
name
строка
при state=present
Имя конфигурации запуска.

Пример:
launch_config_name
result
сложный тип
при state=present
Подробные параметры конфигурации запуска.

associate_public_ip_address
NoneType
при state=present
(EC2-VPC) Указывает, следует ли назначать общедоступный IP-адрес каждому экземпляру.

block_device_mappings
сложный тип
при state=present
Карта отображения блочных устройств, которая определяет блочные устройства.

device_name
строка
при state=present
Имя устройства, доступного экземпляру EC2 (например, /dev/sdh или xvdh).

Пример:
/dev/sda1
ebs
сложный тип
при state=present
Информация об Amazon EBS-томе.

snapshot_id
NoneType
при state=present
Идентификатор моментального снимка.

volume_size
строка
при state=present
Размер тома в ГБ.

Пример:
100
virtual_name
NoneType
при state=present
Имя виртуального устройства (например, ephemeral0).

classic_link_vpc_id
NoneType
при state=present
Идентификатор VPC, поддерживающей ClassicLink, для подключения экземпляров EC2-Classic.

classic_link_vpc_security_groups
список
при state=present
Идентификаторы одного или нескольких групп безопасности для VPC, указанной в ClassicLinkVPCId.

created_time
строка
при state=present
Дата и время создания конфигурации запуска.

Пример:
2017-11-03 23:46:44.841000
delete_on_termination
логический тип
при state=present
Указывает, будет ли том удален при завершении работы экземпляра.

Пример:
True
ebs_optimized
логический тип
при state=present
Указывает, оптимизирован ли экземпляр для ввода-вывода EBS (true) или нет (false).

image_id
строка
при state=present
Идентификатор Amazon Machine Image, используемый конфигурацией запуска.

Пример:
ami-9be6f38c
instance_monitoring
логический тип
при state=present
Указывает, будут ли экземпляры в этой группе запускаться с подробным (true) или базовым (false) мониторингом.

Пример:
True
instance_profile_name
строка
при state=present
Имя или Amazon Resource Name (ARN) профиля экземпляра, связанного с ролью IAM для экземпляра.

instance_type
строка
при state=present
Тип экземпляра для экземпляров.

Пример:
t1.micro
iops
NoneType
при state=present
Количество операций ввода-вывода в секунду (IOPS), которые необходимо выделить для тома.

kernel_id
строка
при state=present
Идентификатор ядра, связанного с AMI.

key_name
строка
при state=present
Имя пары ключей.

Пример:
testkey
launch_configuration_arn
строка
при state=present
Amazon Resource Name (ARN) конфигурации запуска.

Пример:
arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name
member
строка
при state=present
Пример:
name
строка
при state=present
Имя конфигурации запуска.

Пример:
launch_config_name
PlacementTenancy
строка
при state=present
Тип аренды экземпляров, либо default, либо dedicated.

Пример:
default
ramdisk_id
строка
при state=present
Идентификатор RAM-диска, связанного с AMI.

security_groups
список
при state=present
Группы безопасности, которые необходимо связать с экземплярами.

Пример:
['sg-5e27db2f']
spot_price
NoneType
when state=present
Цена предложения при запуске Spot-инстансов.

use_block_device_types
boolean
when state=present
Указывает, нужно ли подавлять отображение устройства.

user_data
string
when state=present
Данные пользователя, доступные для экземпляров.

volume_type
NoneType
when state=present
Тип тома (один из стандартных, io1, gp2).

security_groups
list
when state=present
Группы безопасности, которые нужно связать с экземплярами.

Пример:
['sg-5e27db2f']


Статус

  • Этот модуль гарантированно не будет содержать обратной несовместимости в будущем. [stableinterface]
  • Этот модуль обслуживается партнером Ansible. [certified]

Авторы

  • Gareth Rushgrove (@garethr)
  • Willem van Ketwich (@wilvk)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_lc_module.html

Spec-Zone.ru

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