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: имя_ресурса` к задаче 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, используя переменную среды c(gcp_service_account_file).
- для аутентификации вы можете установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- Для аутентификации вы можете установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации вы можете установить 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 не установлены или все экземпляры в резервном пуле неисправны, трафик будет перенаправлен обратно в основной пул в режиме "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 будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается здоровым. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/gcp_compute_target_pool_module.html
