community.general.gcp_backend_service – Создание или удаление службы обратного канала.
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.gcp_backend_service.
УСТЕРЕШЕНО
- Удалино в
-
версии 2.0.0
- Почему
-
Выпущены обновлённые модули с расширенными возможностями
- Альтернатива
-
Используйте google.cloud.gcp_compute_backend_service вместо этого.
Синопсис
- Создание или удаление службы обратного канала. См. 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 логический тип |
| Если истинно, включите Cloud CDN для этой службы обратного канала. |
| healthchecks список / элементы=строка / обязательно | Список проверок работоспособности. Поддерживается только одна проверка работоспособности. | |
| pem_file строка | Путь к PEM-файлу, связанному с адресом электронной почты учетной записи службы. | |
| port_name строка | Имя порта в управляемой группе экземпляров (MIG), на который службы обратного канала могут пересылать данные. Требуется для балансировки нагрузки внешнего типа. | |
| project_id строка | Идентификатор проекта GCE. | |
| protocol строка |
| Протокол, используемый этой службой обратного канала для связи с обратными каналами. Возможные значения: HTTP, HTTPS, TCP и SSL. По умолчанию используется TCP. |
| service_account_email строка | Адрес электронной почты учетной записи службы. | |
| service_account_permissions список / элементы=строка | Разрешения учетной записи службы. | |
| state строка |
| Желаемое состояние ресурса |
| timeout целое число | Сколько секунд ждать обратный канал, прежде чем считать запрос неудачным. По умолчанию 30 секунд. Допустимый диапазон: 1-86400. |
Примечания
Примечание
- Обновление в настоящее время не поддерживается.
- В настоящее время поддерживаются только глобальные службы обратного канала. Региональные обратные каналы в настоящее время не поддерживаются.
- Внутренняя балансировка нагрузки в настоящее время не поддерживается.
Примеры
- name: Create Minimum Backend Service
community.general.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:
- healthcheck_name_for_backend_service
port_name: myhttpport
state: present
- name: Create BES with extended backend parameters
community.general.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:
- healthcheck_name_for_backend_service
port_name: myhttpport
state: present
timeout: 60
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| backend_service_created логический тип | При создании службы обратного канала. | Индикатор создания службы обратного канала. Пример: True |
| backend_service_deleted логический тип | При удалении службы обратного канала. | Индикатор удаления службы обратного канала. Пример: True |
| backend_service_name строка | Всегда. | Имя службы обратного канала. Пример: my-backend-service |
| backends список / элементы=строка | При существовании службы обратного канала. | Список обратных каналов (состоящих из instance_group), составляющих службу обратного канала. Пример: [ { 'instance_group': 'mig_one', 'zone': 'us-central1-b'} ] |
| enable_cdn логический тип | При существовании службы обратного канала. | Если Cloud CDN включен. null, если не задано. Пример: True |
| healthchecks список / элементы=строка | При существовании службы обратного канала. | Список проверок работоспособности, применённых к службе обратного канала. Пример: [ 'my-healthcheck' ] |
| port_name строка | При существовании службы обратного канала. | Имя порта обратного канала. Пример: myhttpport |
| protocol строка | При существовании службы обратного канала. | Протокол, используемый для связи с обратными каналами. Пример: HTTP |
| timeout целое число | Если указано. | В секундах, сколько времени ждать запрос к обратному каналу, прежде чем считать его неудачным. Пример: myhttpport |
Статус
- Этот модуль будет удалён в версии 2.0.0. [устаревший]
- Дополнительную информацию см. в УСТЕРЕШЕНО.
Авторы
- Tom Melendez (@supertom) <tom@supertom.com>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/gcp_backend_service_module.html