Spec-Zone.ru › Ansible 2.7

ec2_elb_lb – Создаёт или удаляет Amazon ELB.

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

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

Описание

  • Возвращает информацию о балансировщике нагрузки.
  • Будет помечен как изменённый, только если состояние изменено.

Требования

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

  • python >= 2.6
  • boto

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_logs
-
добавлен в 2.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
connection_draining_timeout
-
добавлен в 1.8
Ожидание заданного таймаута, позволяющего завершить соединения перед завершением работы экземпляра
cross_az_load_balancing
boolean
добавлен в 1.8
    Варианты:
  • нет ←
  • да
Распределение нагрузки по всем настроенным зонам доступности
ec2_url
-
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она задана.
health_check
-
Ассоциативный массив настроек проверки работоспособности (см. пример)
idle_timeout
-
добавлен в 2.0
Соединения ELB от клиентов и к серверам отключаются по истечении этого времени
instance_ids
boolean
добавлен в 2.1
    Варианты:
  • нет ←
  • да
Список идентификаторов экземпляров, которые необходимо подключить к данному ELB
listeners
-
Список портов/протоколов, на которых этот ELB должен прослушивать (см. пример)
name
- / обязательно
Имя ELB
profile
-
добавлен в 1.6
Использует профиль boto. Работает только с boto >= 2.24.0.
purge_instance_ids
boolean
добавлен в 2.1
    Варианты:
  • нет ←
  • да
Очистить существующие идентификаторы экземпляров в ELB, которых нет в instance_ids
purge_listeners
boolean
    Варианты:
  • нет
  • да ←
Очистить существующие слушатели в ELB, которых нет в listeners
purge_subnets
-
добавлен в 1.7
По умолчанию:
"нет"
Очистить существующие подсети в ELB, которых нет в подсетях
purge_zones
boolean
    Варианты:
  • нет ←
  • да
Очистить существующие зоны доступности в ELB, которых нет в зонах
region
-
AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она задана. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
scheme
-
добавлен в 1.7
    Варианты:
  • внутренний
  • обращённый к интернету ←
Схема для использования при создании ELB. Для частного ELB, видимого в VPC, используйте 'внутренний'. Если вы выберете обновление вашей схемы с другим значением, ELB будет уничтожен и пересоздан. Для обновления схемы необходимо использовать параметр wait.
security_group_ids
-
добавлен в 1.6
Список идентификаторов групп безопасности, которые необходимо применить к elb
security_group_names
-
добавлен в 2.0
Список имён групп безопасности, которые необходимо применить к elb
security_token
-
добавлен в 1.6
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

псевдонимы: access_token
state
- / обязательно
    Варианты:
  • present
  • absent
Создать или уничтожить ELB
stickiness
-
добавлен в 2.0
Ассоциативный массив настроек политики прилипания. Политика будет применена ко всем слушателям (см. пример)
subnets
-
добавлен в 1.7
Список подсетей VPC, которые необходимо использовать при создании ELB. Зоны должны быть пустыми, если используется этот параметр.
tags
-
добавлен в 2.1
Ассоциативный массив тегов. Для удаления всех тегов, укажите пустой словарь.
validate_certs
boolean
добавлен в 1.5
    Варианты:
  • нет
  • да ←
При значении "нет", сертификаты SSL не будут проверяться для версий boto >= 2.6.0.
wait
boolean
добавлен в 2.1
    Варианты:
  • нет ←
  • да
В случае указания этого параметра Ansible проверит состояние балансировщика нагрузки, чтобы убедиться, что он был успешно удален из AWS.
wait_timeout
-
добавлен в 2.1
По умолчанию:
60
Используется совместно с wait. Количество секунд ожидания завершения работы elb. Максимальное время ожидания — 600 секунд (10 минут).
zones
-
Список зон доступности, которые необходимо включить для этого ELB

Примечания

Примечание

  • Если параметры не установлены в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета 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: None of these examples set aws_access_key, aws_secret_key, or region.
# It is assumed that their matching environment variables are set.

# Basic provisioning example (non-VPC)

- local_action:
    module: ec2_elb_lb
    name: "test-please-delete"
    state: present
    zones:
      - us-east-1a
      - us-east-1d
    listeners:
      - protocol: http # options are http, https, ssl, tcp
        load_balancer_port: 80
        instance_port: 80
        proxy_protocol: True
      - protocol: https
        load_balancer_port: 443
        instance_protocol: http # optional, defaults to value of protocol setting
        instance_port: 80
        # ssl certificate required for https or ssl
        ssl_certificate_id: "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert"

# Internal ELB example

- local_action:
    module: ec2_elb_lb
    name: "test-vpc"
    scheme: internal
    state: present
    instance_ids:
      - i-abcd1234
    purge_instance_ids: true
    subnets:
      - subnet-abcd1234
      - subnet-1a2b3c4d
    listeners:
      - protocol: http # options are http, https, ssl, tcp
        load_balancer_port: 80
        instance_port: 80

# Configure a health check and the access logs
- local_action:
    module: ec2_elb_lb
    name: "test-please-delete"
    state: present
    zones:
      - us-east-1d
    listeners:
      - protocol: http
        load_balancer_port: 80
        instance_port: 80
    health_check:
        ping_protocol: http # options are http, https, ssl, tcp
        ping_port: 80
        ping_path: "/index.html" # not required for tcp or ssl
        response_timeout: 5 # seconds
        interval: 30 # seconds
        unhealthy_threshold: 2
        healthy_threshold: 10
    access_logs:
        interval: 5 # minutes (defaults to 60)
        s3_location: "my-bucket" # This value is required if access_logs is set
        s3_prefix: "logs"

# Ensure ELB is gone
- local_action:
    module: ec2_elb_lb
    name: "test-please-delete"
    state: absent

# Ensure ELB is gone and wait for check (for default timeout)
- local_action:
    module: ec2_elb_lb
    name: "test-please-delete"
    state: absent
    wait: yes

# Ensure ELB is gone and wait for check with timeout value
- local_action:
    module: ec2_elb_lb
    name: "test-please-delete"
    state: absent
    wait: yes
    wait_timeout: 600

# Normally, this module will purge any listeners that exist on the ELB
# but aren't specified in the listeners parameter. If purge_listeners is
# false it leaves them alone
- local_action:
    module: ec2_elb_lb
    name: "test-please-delete"
    state: present
    zones:
      - us-east-1a
      - us-east-1d
    listeners:
      - protocol: http
        load_balancer_port: 80
        instance_port: 80
    purge_listeners: no

# Normally, this module will leave availability zones that are enabled
# on the ELB alone. If purge_zones is true, then any extraneous zones
# will be removed
- local_action:
    module: ec2_elb_lb
    name: "test-please-delete"
    state: present
    zones:
      - us-east-1a
      - us-east-1d
    listeners:
      - protocol: http
        load_balancer_port: 80
        instance_port: 80
    purge_zones: yes

# Creates a ELB and assigns a list of subnets to it.
- local_action:
    module: ec2_elb_lb
    state: present
    name: 'New ELB'
    security_group_ids: 'sg-123456, sg-67890'
    region: us-west-2
    subnets: 'subnet-123456,subnet-67890'
    purge_subnets: yes
    listeners:
      - protocol: http
        load_balancer_port: 80
        instance_port: 80

# Create an ELB with connection draining, increased idle timeout and cross availability
# zone load balancing
- local_action:
    module: ec2_elb_lb
    name: "New ELB"
    state: present
    connection_draining_timeout: 60
    idle_timeout: 300
    cross_az_load_balancing: "yes"
    region: us-east-1
    zones:
      - us-east-1a
      - us-east-1d
    listeners:
      - protocol: http
        load_balancer_port: 80
        instance_port: 80

# Create an ELB with load balancer stickiness enabled
- local_action:
    module: ec2_elb_lb
    name: "New ELB"
    state: present
    region: us-east-1
    zones:
      - us-east-1a
      - us-east-1d
    listeners:
      - protocol: http
        load_balancer_port: 80
        instance_port: 80
    stickiness:
      type: loadbalancer
      enabled: yes
      expiration: 300

# Create an ELB with application stickiness enabled
- local_action:
    module: ec2_elb_lb
    name: "New ELB"
    state: present
    region: us-east-1
    zones:
      - us-east-1a
      - us-east-1d
    listeners:
      - protocol: http
        load_balancer_port: 80
        instance_port: 80
    stickiness:
      type: application
      enabled: yes
      cookie: SESSIONID

# Create an ELB and add tags
- local_action:
    module: ec2_elb_lb
    name: "New ELB"
    state: present
    region: us-east-1
    zones:
      - us-east-1a
      - us-east-1d
    listeners:
      - protocol: http
        load_balancer_port: 80
        instance_port: 80
    tags:
      Name: "New ELB"
      stack: "production"
      client: "Bob"

# Delete all tags from an ELB
- local_action:
    module: ec2_elb_lb
    name: "New ELB"
    state: present
    region: us-east-1
    zones:
      - us-east-1a
      - us-east-1d
    listeners:
      - protocol: http
        load_balancer_port: 80
        instance_port: 80
    tags: {}

Статус

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

Авторы

  • Jim Dalton (@jsdalton)

Подсказка

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

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

Spec-Zone.ru

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