gcp_compute_target_pool – Создаёт GCP TargetPool
Новая версия с 2.6.
Обзор
- Представляет ресурс TargetPool, используемый для балансировки нагрузки.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| backup_pool - | Это поле применимо только тогда, когда содержащийся целевой пул обслуживает правило переадресации в качестве основного пула, и его поле failoverRatio установлено должным образом в значение от [0, 1]. backupPool и failoverRatio вместе определяют поведение резервного копирования основного целевого пула: если отношение здоровых экземпляров в основном пуле равно или ниже failoverRatio, трафик, поступающий на IP-адрес с балансировкой нагрузки, будет направлен в резервный пул. В случае, если failoverRatio и backupPool не установлены или все экземпляры в резервном пуле неисправны, трафик будет направлен обратно в основной пул в режиме "force", где трафик будет распределяться по здоровым экземплярам с наилучшими усилиями или ко всем экземплярам, если экземпляры не здоровые. | |
| description - | Необязательное описание этого ресурса. | |
| failover_ratio - | Это поле применимо только тогда, когда содержащийся целевой пул обслуживает правило переадресации в качестве основного пула (то есть не как резервный пул для другого целевого пула). Значение поля должно быть в [0, 1]. Если установлено, backupPool также должно быть установлено. Они вместе определяют поведение резервного копирования основного целевого пула: если отношение здоровых экземпляров в основном пуле равно или ниже этого числа, трафик, поступающий на IP-адрес с балансировкой нагрузки, будет направлен в резервный пул. В случае, если failoverRatio не установлено или все экземпляры в резервном пуле неисправны, трафик будет направлен обратно в основной пул в режиме "force", где трафик будет распределяться по здоровым экземплярам с наилучшими усилиями или ко всем экземплярам, если экземпляры не здоровые. | |
| health_check - | Ссылка на ресурс HttpHealthCheck. Экземпляр члена в этом пуле считается здоровым только в том случае, если проверки состояния пройдены. Если не указано, все экземпляры членов считаются здоровыми всегда. | |
| instances - | Список виртуальных машин, обслуживающих этот пул. Они должны располагаться в зонах, содержащихся в той же области, что и этот пул. | |
| name - / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |
| project - | По умолчанию: null | Проект Google Cloud Platform, который нужно использовать. |
| region - / обязательно | Регион, в котором находится целевой пул. | |
| scopes - | Массив используемых областей. | |
| service_account_email - | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file - | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | |
| session_affinity - |
| Вариант сеансовой аффинизации. Должно быть одно из этих значений: - NONE: подключения от одного и того же IP-адреса клиента могут идти к любому экземпляру в пуле. - CLIENT_IP: подключения от одного и того же IP-адреса клиента будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается здоровым. - CLIENT_IP_PROTO: подключения от одного и того же IP-адреса клиента с тем же протоколом IP будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается здоровым. |
| state - |
| Указывает, должен ли заданный объект существовать в GCP |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/targetPools
- Официальная документация: https://cloud.google.com/compute/docs/load-balancing/network/target-pools
- Для аутентификации можно установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a target pool
gcp_compute_target_pool:
name: "test_object"
region: us-west1
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_pool словарь | успех | Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило переадресации в качестве основного пула, а его поле failoverRatio правильно установлено в значение от [0, 1]. backupPool и failoverRatio вместе определяют поведение резервного копирования основного целевого пула: если отношение здоровых экземпляров в основном пуле находится на уровне или ниже failoverRatio, трафик, поступающий на IP-адрес с балансировкой нагрузки, будет перенаправлен в резервный пул. В случае, если failoverRatio и backupPool не установлены или все экземпляры в резервном пуле неисправны, трафик будет перенаправлен обратно в основной пул в режиме "force", где трафик будет распределен по здоровым экземплярам с наилучшими усилиями или ко всем экземплярам, если ни один экземпляр не здоров. |
| creation_timestamp строка | успех | Маркер времени создания в формате RFC3339. |
| description строка | успех | Необязательное описание этого ресурса. |
| failover_ratio строка | успех | Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило переадресации в качестве основного пула (т. е. не как резервный пул для другого целевого пула). Значение поля должно находиться в интервале [0, 1]. Если задано, backupPool также должно быть задано. Они вместе определяют поведение резервного копирования основного целевого пула: если отношение здоровых экземпляров в основном пуле находится на уровне или ниже этого числа, трафик, поступающий на IP-адрес с балансировкой нагрузки, будет перенаправлен в резервный пул. В случае, если failoverRatio не задано или все экземпляры в резервном пуле неисправны, трафик будет перенаправлен обратно в основной пул в режиме "force", где трафик будет распределен по здоровым экземплярам с наилучшими усилиями или ко всем экземплярам, если ни один экземпляр не здоров. |
| health_check словарь | успех | Ссылка на ресурс HttpHealthCheck. Экземпляр члена в этом пуле считается здоровым только в том случае, если проверки работоспособности пройдены. Если не указано, все экземпляры членов будут считаться здоровыми во все моменты времени. |
| id целое число | успех | Уникальный идентификатор ресурса. |
| instances список | успех | Список виртуальных машин, обслуживающих этот пул. Они должны находиться в зонах, содержащихся в том же регионе, что и этот пул. |
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. |
| region строка | успех | Регион, в котором находится целевой пул. |
| session_affinity строка | успех | Параметр аффинити сеанса. Должно быть одно из этих значений: - NONE: Подключения от одного и того же IP-адреса клиента могут идти к любому экземпляру в пуле. - CLIENT_IP: Подключения от одного и того же IP-адреса клиента будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается здоровым. - CLIENT_IP_PROTO: Подключения от одного и того же IP-адреса клиента с тем же протоколом IP будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается здоровым. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/gcp_compute_target_pool_module.html
