elb_target_group - Управление целевой группой для балансировщика нагрузки приложения
Новая версия с 2.4.
- Синопсис
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Синопсис
- Управление целевой группой балансировщика нагрузки AWS приложения. Подробнее см. http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- boto
Параметры
| параметр | обязательно | значение по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| 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 | ||
| deregistration_delay_timeout | нет | Время ожидания балансировщиком Elastic Load Balancing перед изменением состояния дерегистрируемого целевого сервера с состояния "ожидание" на "неиспользуемый". Диапазон значений: 0-3600 секунд. | ||
| ec2_url | нет | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. | ||
| health_check_interval | нет | Приблизительное время в секундах между проверками состояния целевого сервера. | ||
| health_check_path | нет | Путь для проверки состояния целевых серверов. Путь должен быть определён для настройки проверки состояния. | ||
| health_check_port | нет | Порт на целевом сервере, который получает трафик от балансировщика. | Порт, используемый балансировщиком при проверке состояния целевого сервера. | |
| health_check_protocol | нет |
| Протокол, используемый балансировщиком при проверке состояния целевых серверов. | |
| health_check_timeout | нет | Время в секундах, в течение которого отсутствие ответа от целевого сервера означает неудачную проверку состояния. | ||
| healthy_threshold_count | нет | Количество последовательных успешных проверок состояния, необходимых для перевода целевого сервера из состояния "неисправен" в "исправен". | ||
| modify_targets | нет | True | Изменять ли существующие целевые серверы в группе, чтобы соответствовать переданным параметрам? | |
| name | да | Название целевой группы. | ||
| port | нет | Порт на целевом сервере, который получает трафик. Используется, если не указан порт при регистрации целевого сервера. Требуется, если state — present. | ||
| profile (добавлено в 1.6)
| нет | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| protocol | нет |
| Протокол для маршрутизации трафика на целевые серверы. Требуется, если state — present. | |
| purge_tags | нет | True |
| Если да, существующие метки будут удалены, чтобы точно соответствовать параметру tags. Если параметр tags не установлен, метки не будут изменены. |
| region | нет | Регион AWS. Если не указан, используется значение переменной среды AWS_REGION или 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 | ||
| state | да |
| Создать или удалить целевую группу. | |
| stickiness_enabled | нет |
| Указывает, включены ли сеансы с привязкой. | |
| stickiness_lb_cookie_duration | нет | Период времени в секундах, в течение которого запросы клиента должны направляться на тот же целевой сервер. По истечении этого периода времени cookie, сгенерированный балансировщиком, считается устаревшим. Диапазон значений: 1 секунда до 1 недели (604800 секунд). | ||
| stickiness_type | нет | lb_cookie | Тип сеансов с привязкой. Возможные значения: lb_cookie. | |
| successful_response_codes | нет | HTTP-коды, используемые при проверке успешного ответа от целевого сервера. Можно указать несколько значений (например, "200,202") или диапазон значений (например, "200-299"). | ||
| tags | нет | Словарь одной или нескольких меток для назначения целевой группе. | ||
| targets | нет | Список целевых серверов для назначения целевой группе. По умолчанию список пуст. Если не установлен параметр 'modify_targets', все существующие целевые серверы будут удалены из группы. Список должен содержать параметры Id и Port. Подробности см. в примерах. | ||
| unhealthy_threshold_count | нет | Количество последовательных неудачных проверок состояния, необходимых для перевода целевого сервера в состояние "неисправен". | ||
| validate_certs (добавлено в 1.5)
| нет | да |
| При значении "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
| vpc_id | нет | Идентификатор виртуальной частной сети (VPC). Требуется, если state — present. |
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Create a target group with a default health check
- elb_target_group:
name: mytargetgroup
protocol: http
port: 80
vpc_id: vpc-01234567
state: present
# Modify the target group with a custom health check
- elb_target_group:
name: mytargetgroup
protocol: http
port: 80
vpc_id: vpc-01234567
health_check_path: /
successful_response_codes: "200, 250-260"
state: present
# Delete a target group
- elb_target_group:
name: mytargetgroup
state: absent
# Create a target group with targets
- elb_target_group:
name: mytargetgroup
protocol: http
port: 81
vpc_id: vpc-01234567
health_check_path: /
successful_response_codes: "200,250-260"
targets:
- Id: i-01234567
Port: 80
- Id: i-98765432
Port: 80
state: present
wait_timeout: 200
wait: True
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для этого модуля:
| name | description | returned | type | sample |
|---|---|---|---|---|
| deregistration_delay_timeout_seconds | Время ожидания Elastic Load Balancing перед изменением состояния удаляемого целевого сервера с состояния «вывод» на «неиспользуемый». | при наличии состояния | int | 300 |
| health_check_interval_seconds | Приблизительное время (в секундах) между проверками работоспособности отдельного целевого сервера. | при наличии состояния | int | 30 |
| health_check_path | Путь для запроса проверки работоспособности. | при наличии состояния | string | /index.html |
| health_check_port | Порт для подключения к целевому серверу. | при наличии состояния | string | traffic-port |
| health_check_protocol | Протокол для подключения к целевому серверу. | при наличии состояния | string | HTTP |
| health_check_timeout_seconds | Время (в секундах), в течение которого отсутствие ответа означает неудачную проверку работоспособности. | при наличии состояния | int | 5 |
| healthy_threshold_count | Количество последовательных успешных проверок работоспособности, необходимых для перевода целевого сервера из состояния «неработоспособный» в «работоспособный». | при наличии состояния | int | 5 |
| load_balancer_arns | Amazon Resource Names (ARN) балансировщиков нагрузки, которые направляют трафик в эту целевую группу. | при наличии состояния | list | [] |
| matcher | HTTP-коды, используемые для проверки успешного ответа от целевого сервера. | при наличии состояния | dict | {'http_code': '200'} |
| port | Порт, на котором слушают целевые серверы. | при наличии состояния | int | 80 |
| protocol | Протокол для маршрутизации трафика к целевым серверам. | при наличии состояния | string | HTTP |
| stickiness_enabled | Указывает, включены ли липкие сессии. | при наличии состояния | bool | True |
| stickiness_lb_cookie_duration_seconds | Период времени (в секундах), в течение которого запросы от клиента должны маршрутизироваться к одному и тому же целевому серверу. | при наличии состояния | int | 86400 |
| stickiness_type | Тип липких сессий. | при наличии состояния | string | lb_cookie |
| tags | Теги, прикрепленные к целевой группе. | при наличии состояния | dict | { 'Tag': 'Пример' } |
| target_group_arn | Amazon Resource Name (ARN) целевой группы. | при наличии состояния | string | arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211 |
| target_group_name | Название целевой группы. | при наличии состояния | string | mytargetgroup |
| unhealthy_threshold_count | Количество последовательных сбоев проверки работоспособности, необходимых для перевода целевого сервера в состояние «неработоспособный». | при наличии состояния | int | 2 |
| vpc_id | Идентификатор VPC для целевых серверов. | при наличии состояния | string | vpc-0123456 |
Примечания
Примечание
- После создания целевой группы можно изменить только её проверку работоспособности с помощью последующих вызовов
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость.
Для получения помощи в разработке модулей, если вы заинтересованы, прочитайте Справочная информация по сообществу и вклад, Тестирование 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/elb_target_group_module.html