gcp_backend_service — Создание или уничтожение службы обратного канала.
Новая в версии 2.4.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Обзор
- Создание или уничтожение службы обратного канала. См. https://cloud.google.com/compute/docs/load-balancing/http/backend-service для обзора. Полные инструкции по установке и настройке модулей Google Cloud можно найти в комментариях в файле ansible/test/gce_tests.py.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- apache-libcloud >= 1.3.0
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| backend_service_name | да | Имя службы обратного канала. | ||
| backends | да | Список обратных каналов, составляющих службу обратного канала. Обратный канал состоит из группы экземпляров и, необязательно, нескольких других параметров. Подробности см. в https://cloud.google.com/compute/docs/reference/latest/backendServices. | ||
| credentials_file | нет | Путь к JSON-файлу, связанному с электронным адресом учетной записи службы. | ||
| enable_cdn | нет | Если True, включить Cloud CDN для этой службы обратного канала. | ||
| healthchecks | да | Список проверок работоспособности. Поддерживается только одна проверка работоспособности. | ||
| port_name | нет | Имя порта в управляемой группе экземпляров (MIG), на который службы обратного канала могут пересылать данные. Требуется для внешнего балансирования нагрузки. | ||
| project_id | нет | Идентификатор проекта GCE. | ||
| protocol | нет | Протокол, используемый этой службой обратного канала для связи с обратными каналами. Возможные значения: HTTP, HTTPS, TCP и SSL. По умолчанию — HTTP. | ||
| service_account_email | нет | Электронный адрес учетной записи службы. | ||
| state | нет | present |
| Желаемое состояние ресурса. |
| timeout | нет | Время ожидания обратного канала в секундах, прежде чем запрос будет считаться неудачным. По умолчанию — 30 секунд. Допустимый диапазон — 1-86400. |
Примеры
- name: Create Minimum Backend Service
gcp_backend_service:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
backend_service_name: "{{ bes }}"
backends:
- instance_group: managed_instance_group_1
healthchecks:
- name: healthcheck_name_for_backend_service
port_name: myhttpport
state: present
- name: Create BES with extended backend parameters
gcp_backend_service:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
backend_service_name: "{{ bes }}"
backends:
- instance_group: managed_instance_group_1
max_utilization: 0.6
max_rate: 10
- instance_group: managed_instance_group_2
max_utilization: 0.5
max_rate: 4
healthchecks:
- name: healthcheck_name_for_backend_service
port_name: myhttpport
state: present
timeout: 60
Значения возврата
Общие значения возврата описаны здесь Значения возврата, а следующие поля уникальны для этого модуля:
| имя | описание | возвращаемое | тип | пример |
|---|---|---|---|---|
| backend_service_created | Указатель на создание службы обратного канала. | При создании службы обратного канала. | boolean | True |
| backend_service_deleted | Указатель на удаление службы обратного канала. | При удалении службы обратного канала. | boolean | True |
| backend_service_name | Имя службы обратного канала. | Всегда. | строка | my-backend-service |
| backends | Список обратных каналов (состоящих из instance_group), составляющих службу обратного канала. | При существовании службы обратного канала. | список | [ { 'instance_group': 'mig_one', 'zone': 'us-central1-b'} ] |
| enable_cdn | Если Cloud CDN включен. null, если не задано. | При существовании службы обратного канала. | boolean | True |
| healthchecks | Список проверок работоспособности, примененных к службе обратного канала. | При существовании службы обратного канала. | список | [ 'my-healthcheck' ] |
| port_name | Имя порта обратного канала. | При существовании службы обратного канала. | строка | myhttpport |
| protocol | Протокол, используемый для связи с обратными каналами. | При существовании службы обратного канала. | строка | HTTP |
| timeout | Время в секундах, в течение которого запрос, отправленный обратному каналу, считается неудачным. | Если указано. | целое число | myhttpport |
Примечания
Примечание
- Обновление в настоящее время не поддерживается.
- В настоящее время поддерживаются только глобальные службы обратного канала. Региональные обратные каналы в настоящее время не поддерживаются.
- Внутреннее балансирование нагрузки в настоящее время не поддерживается.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вас это интересует, пожалуйста, ознакомьтесь со статьей Информация о сообществе и сотрудничество, Тестирование 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/gcp_backend_service_module.html