google.cloud.gcp_compute_target_pool – Создаёт GCP TargetPool
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач, укажите: google.cloud.gcp_compute_target_pool.
Описание
- Представляет собой ресурс 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: имя-ресурса` к задаче gcp_compute_target_pool, а затем установить это поле backup_pool в "{{ имя-ресурса }}" | |
| description строка | Необязательное описание этого ресурса. | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это следует установить только в том случае, если вы знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API. | |
| failover_ratio строка | Это поле применимо только тогда, когда содержащийся пул целевых серверов обслуживает правило переадресации в качестве основного пула (т.е. не как резервный пул для другого пула целевых серверов). Значение поля должно быть в [0, 1]. Если задано, backupPool также должно быть задано. Вместе они определяют поведение обратной связи основного пула целевых серверов: если соотношение здоровых экземпляров в основном пуле целевых серверов равно или меньше этого числа, трафик, поступающий на IP-адрес, сбалансированный по нагрузке, будет перенаправлен в резервный пул. В случае, когда failoverRatio не задано или все экземпляры в резервном пуле неисправны, трафик будет перенаправлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с наилучшим усилием или ко всем экземплярам, когда ни один экземпляр не является здоровым. | |
| health_check словарь | Ссылка на ресурс HttpHealthCheck. Экземпляр-член в этом пуле считается здоровым только в том случае, если проверки состояния проходят. Если не указано, это означает, что все экземпляры-члены всегда будут считаться здоровыми. Это поле представляет собой ссылку на ресурс HttpHealthCheck в GCP. Его можно указать двумя способами. Во-первых, можно поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_http_health_check, а затем установить это поле health_check в "{{ имя-ресурса }}" | |
| instances список / элементы=словарь | Список виртуальных машин, обслуживающих этот пул. Они должны находиться в зонах, содержащихся в той же области, что и этот пул. | |
| name строка / обязательно | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. То есть имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| project строка | Проект Google Cloud Platform, который необходимо использовать. | |
| region строка / обязательно | Регион, в котором находится пул целевых серверов. | |
| scopes список / элементы=строка | Массив областей, которые будут использоваться | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи сервиса, либо в словаре, либо в виде JSON-строки, представляющей его. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи сервиса, если выбран тип serviceaccount. | |
| session_affinity строка | Вариант аффинити сессий. Должно быть одно из этих значений: - NONE: Подключения от одного и того же IP-адреса клиента могут быть направлены на любой экземпляр в пуле. - CLIENT_IP: Подключения от одного и того же IP-адреса клиента будут направлены на тот же экземпляр в пуле, пока этот экземпляр остается здоровым. - CLIENT_IP_PROTO: Подключения от одного и того же IP-адреса клиента с тем же протоколом IP будут направлены на тот же экземпляр в пуле, пока этот экземпляр остается здоровым. Некоторые допустимые значения включают: "NONE", "CLIENT_IP", "CLIENT_IP_PROTO" | |
| 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_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно установить 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
google.cloud.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 не установлены или все экземпляры в резервном пуле неисправны, трафик будет перенаправлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с максимальной эффективностью или ко всем экземплярам, если ни один экземпляр не здоров. |
| creationTimestamp строка | успех | Маркер создания в формате RFC3339. |
| description строка | успех | Необязательное описание этого ресурса. |
| failoverRatio строка | успех | Это поле применимо только тогда, когда содержащий его целевой пул обслуживает правило переадресации в качестве основного пула (то есть не как резервный пул для какого-либо другого целевого пула). Значение поля должно быть в диапазоне [0, 1]. Если установлено, backupPool также должно быть установлено. Они вместе определяют поведение резервного копирования основного целевого пула: если коэффициент здоровых экземпляров в основном пуле равен или меньше этого числа, трафик, поступающий на IP-адрес балансировки нагрузки, будет направлен в резервный пул. В случае, если failoverRatio не установлено или все экземпляры в резервном пуле неисправны, трафик будет перенаправлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с максимальной эффективностью или ко всем экземплярам, если ни один экземпляр не здоров. |
| 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 будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается здоровым. |
Авторы
- 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.10/collections/google/cloud/gcp_compute_target_pool_module.html
