google.cloud.gcp_compute_target_pool – Создаёт GCP TargetPool
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: 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: name-of-resource` к задаче gcp_compute_target_pool, а затем установить это поле backup_pool в "{{ name-of-resource }}" | |
| description строка | Необязательное описание этого ресурса. | |
| env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. | |
| 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 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_target_pool_module.html
