Spec-Zone.ru › Ansible 2.7

spotinst_aws_elastigroup – Создание, обновление или удаление Spotinst AWS Elastigroups

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

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

Обзор

  • Может создавать, обновлять или удалять Spotinst AWS Elastigroups. Конфигурация запуска (launch configuration) является частью конфигурации elastigroup, поэтому для обработки конфигурации запуска дополнительных модулей не требуется. Вам потребуется файл с учетными данными в этом расположении - <home>/.spotinst/credentials. Файл учетных данных должен содержать строку, которая выглядит так: token = <Ваш токен>. Полная документация доступна по адресу https://help.spotinst.com/hc/en-us/articles/115003530285-Ansible.

Требования

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

  • spotinst >= 1.0.21
  • python >= 2.7

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account_id
-
(Строка) Необязательный параметр, позволяющий установить account-id в настройках модуля. По умолчанию он извлекается из пути к учетным данным.
availability_vs_cost
- / обязательно
    Варианты:
  • availabilityOriented
  • costOriented
  • balanced
(Строка) Стратегия ориентации.
availability_zones
- / обязательно
(Список объектов) Список словарей/списков зон доступности, настроенных в elastigroup; '[{"key":"value", "key":"value"}]'; разрешенные ключи — name (Строка), subnet_id (Строка), placement_group_name (Строка),
block_device_mappings
-
(Список объектов) Список словарей/списков отображений блочных устройств для экземпляров elastigroup; Вы можете указать виртуальные устройства и тома EBS.; '[{"key":"value", "key":"value"}]'; разрешенные ключи — device_name (Список строк), virtual_name (Строка), no_device (Строка), ebs (Объект, ожидаются следующие ключи — delete_on_termination(Булево), encrypted(Булево), iops (Целое число), snapshot_id(Целое число), volume_type(Строка), volume_size(Целое число))
chef
-
(Объект) Настройки интеграции Chef.; Ожидаются следующие ключи — chef_server (Строка), organization (Строка), user (Строка), pem_key (Строка), chef_version (Строка)
credentials_path
-
(Строка) Необязательный параметр, позволяющий задать путь к учетным данным, отличный от стандартного. По умолчанию — ~/.spotinst/credentials
down_scaling_policies
-
(Список объектов) Список словарей/списков политик масштабирования для настройки в elastigroup; '[{"key":"value", "key":"value"}]'; разрешенные ключи — policy_name (Строка, обязательно), namespace (Строка, обязательно), metric_name (Строка, обязательно), dimensions ((Список объектов), Разрешенные ключи — name (Строка, обязательно) и value (Строка)), statistic (Строка, обязательно), evaluation_periods (Строка, обязательно), period (Строка, обязательно), threshold (Строка, обязательно), cooldown (Строка, обязательно), unit (Строка, обязательно), operator (Строка, обязательно), action_type (Строка, обязательно), adjustment (Строка), max_target_capacity (Строка), target (Строка), maximum (Строка), minimum (Строка)
draining_timeout
-
(Целое число) Время для того, чтобы экземпляр был выведен из работы (drain) от входящих запросов и дерегистрирован из ELB до завершения.
ebs_optimized
-
(Булево) Включить оптимизацию EBS для поддерживаемых экземпляров, которые по умолчанию отключены.; Примечание — будут добавлены дополнительные расходы.
ebs_volume_pool
-
(Список объектов) Список словарей/списков устройств EBS, которые нужно повторно подключить к elastigroup при наличии; '[{"key":"value", "key":"value"}]'; разрешенные ключи — volume_ids (Список строк), device_name (Строка)
ecs
-
(Объект) Настройки интеграции ECS.; Ожидается следующий ключ — cluster_name (Строка)
elastic_ips
-
(Список строк) Список идентификаторов распределения ElasticIps (Пример eipalloc-9d4e16f8) для ассоциации с экземплярами группы.
fallback_to_od
-
(Булево) В случае отсутствия доступных Spot-инстансов Elastigroup запустит экземпляр On-demand вместо этого.
health_check_grace_period
-
По умолчанию:
300
(Целое число) Количество секунд после запуска экземпляра для начала и проверки его состояния.
health_check_type
-
    Варианты:
  • ELB
  • HCS
  • TARGET_GROUP
  • MLB
  • EC2
(Строка) Сервис для использования при проверке состояния.
health_check_unhealthy_duration_before_replacement
-
(Целое число) Минимальное время, в течение которого экземпляр должен быть в неудовлетворительном состоянии, чтобы считаться таким.
iam_role_arn
-
(Строка) ARN роли IAM профиля экземпляра.
Используйте только iam_role_arn или iam_role_name.
iam_role_name
-
(Строка) Имя роли IAM профиля экземпляра.
Используйте только iam_role_arn или iam_role_name.
id
-
(Строка) Идентификатор группы, если он уже существует и вы хотите обновить или удалить его. Это не сработает, если поле uniqueness_by не установлено на id. Если это установлено, а поле uniqueness_by установлено, группа будет либо обновлена, либо удалена, но не создана.
ignore_changes
-
    Варианты:
  • image_id
  • target
(Список строк) Список полей, изменения в которых должны игнорироваться при обновлении.
image_id
- / обязательно
(Строка) Идентификатор образа, используемого для запуска экземпляра.; В случае конфликта между типом экземпляра и типом образа будет возвращена ошибка.
key_pair
- / обязательно
(Строка) Укажите пару ключей для подключения к экземплярам.
kubernetes
-
(Объект) Настройки интеграции Kubernetes. Ожидаются следующие ключи — api_server (Строка), token (Строка)
lifetime_period
-
(Строка) Срок службы.
load_balancers
-
(Список строк) Список имен классических ELB.
max_size
- / обязательно
(Целое число) Максимальное количество экземпляров, до которого можно масштабировать.
mesosphere
-
(Объект) Настройки интеграции Mesosphere. Ожидается следующий ключ — api_server (Строка)
min_size
- / обязательно
(Целое число) Минимальное количество экземпляров, до которого можно масштабировать.
monitoring
- / обязательно
(Булево) Описывает, включена ли расширенная мониторинг экземпляров.
name
- / обязательно
(Строка) Уникальное имя для создаваемой, обновляемой или удаляемой группы elastigroup.
network_interfaces
-
(Список объектов) Список словарей/списков сетевых интерфейсов для добавления в elastigroup; '[{"key":"value", "key":"value"}]'; разрешенные ключи — description (Строка), device_index (Целое число), secondary_private_ip_address_count (Целое число), associate_public_ip_address (Булево), delete_on_termination (Булево), groups (Список строк), network_interface_id (Строка), private_ip_address (Строка), subnet_id (Строка), associate_ipv6_address (Булево), private_ip_addresses (Список объектов, ключи — privateIpAddress (Строка, обязательно) и primary (Булево))
on_demand_count
-
(Целое число) Необходимо, если risk не задан.
Количество экземпляров on demand для запуска. Все остальные экземпляры будут экземплярами spot.; Либо задайте этот параметр, либо параметр risk.
on_demand_instance_type
- / обязательно
(Строка) Тип экземпляра on-demand, который будет развернут.
opsworks
-
(Объект) Конфигурация интеграции elastigroup OpsWorks.; Ожидается следующий ключ — layer_id (Строка)
persistence
-
(Объект) Конфигурация сохранения состояния elastigroup.; Принимает следующие ключи — should_persist_root_device (Булево), should_persist_block_devices (Булево), should_persist_private_ip (Булево)
продукт
- / обязательно
    Варианты:
  • Linux/UNIX
  • SUSE Linux
  • Windows
  • Linux/UNIX (Amazon VPC)
  • SUSE Linux (Amazon VPC)
  • Windows
(Строка) Тип операционной системы.
rancher
-
(Объект) Настройка интеграции Rancher; Ожидаются следующие ключи — access_key (строка), secret_key (строка), master_host (строка)
right_scale
-
(Объект) Настройка интеграции Rightscale; Ожидаются следующие ключи — account_id (строка), refresh_token (строка)
risk
-
(Целое число) требуется, если on demand не задано. Процент запусков Spot-инстансов (0—100).
roll_config
-
(Объект) Конфигурация развёртывания; Если вы хотите, чтобы группа обновлялась после обновления, используйте эту функцию. Принимает следующие ключи — batch_size_percentage(целое число, обязательно), grace_period - (целое число, обязательно), health_check_type(строка, необязательно)
scheduled_tasks
-
(Список объектов) Список хешей/словаря запланированных задач для настройки в elastigroup; '[{"key":"value", "key":"value"}]'; разрешенные ключи — adjustment (целое число), scale_target_capacity (целое число), scale_min_capacity (целое число), scale_max_capacity (целое число), adjustment_percentage (целое число), batch_size_percentage (целое число), cron_expression (строка), frequency (строка), grace_period (целое число), task_type (строка, обязательно), is_enabled (булево)
security_group_ids
- / обязательно
(Список строк) Один или несколько идентификаторов групп безопасности. ; В случае обновления он перезапишет существующую группу безопасности новым заданным массивом
shutdown_script
-
(Строка) Скрипт завершения работы, закодированный в Base64, который выполняется перед завершением работы экземпляра. Закодируйте перед установкой.
signals
-
(Список объектов) Список хешей/словаря сигналов для настройки в elastigroup; разрешенные ключи — name (строка, обязательно), timeout (целое число)
spin_up_time
-
(Целое число) Время запуска экземпляра в секундах
spot_instance_types
- / обязательно
(Список строк) Тип Spot-инстанса, который будет развернут.
state
-
    Варианты:
  • present
  • absent
(Строка) создать или удалить elastigroup
tags
-
(Список пар key:value тегов) список тегов для настройки в elastigroup. Укажите список ключей и значений (ключ двоеточие значение);
target
- / обязательно
(Целое число) Количество запускаемых экземпляров
target_group_arns
-
(Список строк) Список target group arn, к которым должны быть зарегистрированы экземпляры
target_tracking_policies
-
(Список объектов) Список хешей/словаря target tracking policies для настройки в elastigroup; '[{"key":"value", "key":"value"}]'; разрешенные ключи — policy_name (строка, обязательно), namespace (строка, обязательно), source (строка, обязательно), metric_name (строка, обязательно), statistic (строка, обязательно), unit (строка, обязательно), cooldown (строка, обязательно), target (строка, обязательно)
tenancy
-
    Варианты:
  • default
  • dedicated
(Строка) выделенная или общая аренда
terminate_at_end_of_billing_hour
-
(Булево) завершить в конце часа выставления счетов
uniqueness_by
-
    Варианты:
  • id
  • name
(Строка) Если имена ваших групп не уникальны, вы можете использовать эту функцию для обновления или удаления конкретной группы. Всякий раз, когда эта свойство установлено, вы должны установить group_id для обновления или удаления группы, в противном случае группа будет создана.
unit
- / обязательно
    Варианты:
  • instance
  • weight
(Строка) Единица измерения ресурсов для запуска экземпляров.
up_scaling_policies
-
(Список объектов) Список хешей/словаря scaling policies для настройки в elastigroup; '[{"key":"value", "key":"value"}]'; разрешенные ключи — policy_name (строка, обязательно), namespace (строка, обязательно), metric_name (строка, обязательно), dimensions (Список объектов, разрешенные ключи — name (строка, обязательно) и value (строка)), statistic (строка, обязательно) evaluation_periods (строка, обязательно), period (строка, обязательно), threshold (строка, обязательно), cooldown (строка, обязательно), unit (строка, обязательно), operator (строка, обязательно), action_type (строка, обязательно), adjustment (строка), min_target_capacity (строка), target (строка), maximum (строка), minimum (строка)
user_data
-
(Строка) MIME данные пользователя, закодированные в Base64. Закодируйте перед установкой значения.
utilize_reserved_instances
-
(Булево) В случае наличия зарезервированных экземпляров Elastigroup будет использовать ваши резервации, прежде чем приобретать Spot-инстансы.
wait_for_instances
-
(Булево) Должны ли действия создания/обновления elastigroup ожидать, пока экземпляры не будут запущены?
wait_timeout
-
(Целое число) Сколько времени модуль должен ждать экземпляры, прежде чем действие завершится ошибкой; Работает только если wait_for_instances равно True.

Примеры

# Basic configuration YAML example

- hosts: localhost
  tasks:
    - name: create elastigroup
      spotinst_aws_elastigroup:
          state: present
          risk: 100
          availability_vs_cost: balanced
          availability_zones:
            - name: us-west-2a
              subnet_id: subnet-2b68a15c
          image_id: ami-f173cc91
          key_pair: spotinst-oregon
          max_size: 15
          min_size: 0
          target: 0
          unit: instance
          monitoring: True
          name: ansible-group
          on_demand_instance_type: c3.large
          product: Linux/UNIX
          load_balancers:
            - test-lb-1
          security_group_ids:
            - sg-8f4b8fe9
          spot_instance_types:
            - c3.large
          do_not_update:
            - image_id
            - target
      register: result
    - debug: var=result

# In this example, we create an elastigroup and wait 600 seconds to retrieve the instances, and use their private ips

- hosts: localhost
  tasks:
    - name: create elastigroup
      spotinst_aws_elastigroup:
          state: present
          account_id: act-1a9dd2b
          risk: 100
          availability_vs_cost: balanced
          availability_zones:
            - name: us-west-2a
              subnet_id: subnet-2b68a15c
          tags:
            - Environment: someEnvValue
            - OtherTagKey: otherValue
          image_id: ami-f173cc91
          key_pair: spotinst-oregon
          max_size: 5
          min_size: 0
          target: 0
          unit: instance
          monitoring: True
          name: ansible-group-tal
          on_demand_instance_type: c3.large
          product: Linux/UNIX
          security_group_ids:
            - sg-8f4b8fe9
          block_device_mappings:
            - device_name: '/dev/sda1'
              ebs:
                volume_size: 100
                volume_type: gp2
          spot_instance_types:
            - c3.large
          do_not_update:
            - image_id
          wait_for_instances: True
          wait_timeout: 600
      register: result

    - name: Store private ips to file
      shell: echo {{ item.private_ip }}\n >> list-of-private-ips
      with_items: "{{ result.instances }}"
    - debug: var=result

# In this example, we create an elastigroup with multiple block device mappings, tags, and also an account id
# In organizations with more than one account, it is required to specify an account_id

- hosts: localhost
  tasks:
    - name: create elastigroup
      spotinst_aws_elastigroup:
          state: present
          account_id: act-1a9dd2b
          risk: 100
          availability_vs_cost: balanced
          availability_zones:
            - name: us-west-2a
              subnet_id: subnet-2b68a15c
          tags:
            - Environment: someEnvValue
            - OtherTagKey: otherValue
          image_id: ami-f173cc91
          key_pair: spotinst-oregon
          max_size: 5
          min_size: 0
          target: 0
          unit: instance
          monitoring: True
          name: ansible-group-tal
          on_demand_instance_type: c3.large
          product: Linux/UNIX
          security_group_ids:
            - sg-8f4b8fe9
          block_device_mappings:
            - device_name: '/dev/xvda'
              ebs:
                volume_size: 60
                volume_type: gp2
            - device_name: '/dev/xvdb'
              ebs:
                volume_size: 120
                volume_type: gp2
          spot_instance_types:
            - c3.large
          do_not_update:
            - image_id
          wait_for_instances: True
          wait_timeout: 600
      register: result

    - name: Store private ips to file
      shell: echo {{ item.private_ip }}\n >> list-of-private-ips
      with_items: "{{ result.instances }}"
    - debug: var=result

# In this example we have set up block device mapping with ephemeral devices

- hosts: localhost
  tasks:
    - name: create elastigroup
      spotinst_aws_elastigroup:
          state: present
          risk: 100
          availability_vs_cost: balanced
          availability_zones:
            - name: us-west-2a
              subnet_id: subnet-2b68a15c
          image_id: ami-f173cc91
          key_pair: spotinst-oregon
          max_size: 15
          min_size: 0
          target: 0
          unit: instance
          block_device_mappings:
            - device_name: '/dev/xvda'
              virtual_name: ephemeral0
            - device_name: '/dev/xvdb/'
              virtual_name: ephemeral1
          monitoring: True
          name: ansible-group
          on_demand_instance_type: c3.large
          product: Linux/UNIX
          load_balancers:
            - test-lb-1
          security_group_ids:
            - sg-8f4b8fe9
          spot_instance_types:
            - c3.large
          do_not_update:
            - image_id
            - target
      register: result
    - debug: var=result

# In this example we create a basic group configuration with a network interface defined.
# Each network interface must have a device index

- hosts: localhost
  tasks:
    - name: create elastigroup
      spotinst_aws_elastigroup:
          state: present
          risk: 100
          availability_vs_cost: balanced
          network_interfaces:
            - associate_public_ip_address: true
              device_index: 0
          availability_zones:
            - name: us-west-2a
              subnet_id: subnet-2b68a15c
          image_id: ami-f173cc91
          key_pair: spotinst-oregon
          max_size: 15
          min_size: 0
          target: 0
          unit: instance
          monitoring: True
          name: ansible-group
          on_demand_instance_type: c3.large
          product: Linux/UNIX
          load_balancers:
            - test-lb-1
          security_group_ids:
            - sg-8f4b8fe9
          spot_instance_types:
            - c3.large
          do_not_update:
            - image_id
            - target
      register: result
    - debug: var=result


# In this example we create a basic group configuration with a target tracking scaling policy defined

- hosts: localhost
  tasks:
    - name: create elastigroup
      spotinst_aws_elastigroup:
          account_id: act-92d45673
          state: present
          risk: 100
          availability_vs_cost: balanced
          availability_zones:
            - name: us-west-2a
              subnet_id: subnet-79da021e
          image_id: ami-f173cc91
          fallback_to_od: true
          tags:
            - Creator: ValueOfCreatorTag
            - Environment: ValueOfEnvironmentTag
          key_pair: spotinst-labs-oregon
          max_size: 10
          min_size: 0
          target: 2
          unit: instance
          monitoring: True
          name: ansible-group-1
          on_demand_instance_type: c3.large
          product: Linux/UNIX
          security_group_ids:
            - sg-46cdc13d
          spot_instance_types:
            - c3.large
          target_tracking_policies:
            - policy_name: target-tracking-1
              namespace: AWS/EC2
              metric_name: CPUUtilization
              statistic: average
              unit: percent
              target: 50
              cooldown: 120
          do_not_update:
            - image_id
      register: result
    - debug: var=result

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
group_id
строка
успех
Идентификатор созданной/обновленной группы.

Пример:
sig-12345
instances
словарь
успех
Список активных экземпляров elastigroup и их подробностей.

Пример:
[{'spotInstanceRequestId': 'sir-regs25zp', 'instanceId': 'i-09640ad8678234c', 'instanceType': 'm4.large', 'product': 'Linux/UNIX', 'availabilityZone': 'us-west-2b', 'privateIp': '180.0.2.244', 'createdAt': '2017-07-17T12:46:18.000Z', 'status': 'fulfilled'}]


Статус

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

Авторы

  • Spotinst

Подсказка

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

© 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/spotinst_aws_elastigroup_module.html

Spec-Zone.ru

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