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», где трафик будет распределён между здоровыми экземплярами с наилучшим результатом или ко всем экземплярам, если ни один экземпляр не здоров. Это поле представляет ссылку на ресурс TargetPool в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. В-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_compute_target_pool, а затем установить это поле backup_pool в "{{ name-of-resource }}" | |
| description - | Необязательное описание этого ресурса. | |
| failover_ratio - | Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило переадресации в качестве основного пула (т. е. не как резервный пул для какого-либо другого целевого пула). Значение поля должно быть в [0, 1]. Если задано, backupPool также должно быть задано. Они вместе определяют поведение обратного вызова основного целевого пула: если отношение здоровых экземпляров в основном пуле равно или меньше этого числа, входящий трафик на IP-адрес сбалансированной загрузки будет направлен в резервный пул. В случае, если failoverRatio не задано или все экземпляры в резервном пуле неисправны, трафик будет перенаправлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с максимальной эффективностью или ко всем экземплярам, если ни один экземпляр не здоров. | |
| health_check - | Ссылка на ресурс HttpHealthCheck. Экземпляр члена в этом пуле считается здоровым только в том случае, если проверки состояния пройдены. Если не указано, все экземпляры-члены будут считаться здоровыми в любое время. Это поле представляет ссылку на ресурс HttpHealthCheck в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. В-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_compute_http_health_check и затем установить это поле health_check в "{{ name-of-resource }}" | |
| instances - | Список виртуальных машин, обслуживающих этот пул. Они должны находиться в зонах, расположенных в той же области, что и этот пул. | |
| name - / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| project строка | Проект Google Cloud Platform, который использовать. | |
| region - / обязательно | Регион, в котором находится целевой пул. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться в качестве словаря, а в виде строки, содержащей точное содержимое файла json учетной записи службы (действительный JSON) | |
| 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. - Для проверки подлинности можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для проверки подлинности можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для проверки подлинности можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения playbook не заданы.
- Параметры 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата описаны здесь, ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backupPool словарь | успех | Это поле применимо только тогда, когда содержащий его целевой пул обслуживает правило переадресации в качестве основного пула, а его поле failoverRatio корректно установлено в значение между [0, 1]. backupPool и failoverRatio вместе определяют поведение резервного копирования основного целевого пула: если соотношение активных экземпляров в основном пуле равно или ниже failoverRatio, трафик, поступающий на IP-адрес балансировки нагрузки, будет перенаправлен на резервный пул. В случае, когда failoverRatio и backupPool не установлены или все экземпляры в резервном пуле неактивны, трафик будет перенаправлен обратно в основной пул в режиме «принудительного» перенаправления, где трафик будет распределен среди активных экземпляров с наилучшими усилиями или ко всем экземплярам, если ни один из них не активен. |
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. |
| description строка | успех | Необязательное описание этого ресурса. |
| failoverRatio строка | успех | Это поле применимо только тогда, когда содержащий его целевой пул обслуживает правило переадресации как основной пул (т.е. не как резервный пул для другого целевого пула). Значение поля должно быть в диапазоне [0, 1]. Если установлено, backupPool также должно быть установлено. Вместе они определяют поведение резервного копирования основного целевого пула: если соотношение активных экземпляров в основном пуле равно или меньше этого значения, трафик, поступающий на IP-адрес балансировки нагрузки, будет перенаправлен на резервный пул. В случае, когда failoverRatio не установлено или все экземпляры в резервном пуле неактивны, трафик будет перенаправлен обратно в основной пул в режиме «принудительного» перенаправления, где трафик будет распределен среди активных экземпляров с наилучшими усилиями или ко всем экземплярам, если ни один из них не активен. |
| healthCheck словарь | успех | Ссылка на ресурс HttpHealthCheck. Экземпляр члена в этом пуле считается активным только в том случае, если проверки работоспособности пройдены. Если не указано, все экземпляры-члены будут считаться активными в любое время. |
| id целое число | успех | Уникальный идентификатор ресурса. |
| instances список | успех | Список виртуальных машин, обслуживающих этот пул. Они должны находиться в зонах, расположенных в том же регионе, что и этот пул. |
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. |
| region строка | успех | Регион, в котором находится целевой пул. |
| sessionAffinity строка | успех | Параметр сродства сеанса. Должно быть одно из этих значений: - 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.8/modules/gcp_compute_target_pool_module.html
