Модуль google.cloud.gcp_compute_target_pool — создание TargetPool в GCP

access_token

string

Токен доступа OAuth2, если тип учётных данных — accesstoken.

auth_kind

string / обязательный

Тип используемых учётных данных.

Допустимые значения:

• "application"
• "machineaccount"
• "serviceaccount"
• "accesstoken"

backup_pool

dictionary

Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило пересылки как основной пул, а его поле 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

string

Необязательное описание этого ресурса.

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Это влияет только на строку User Agent в запросах к API.

failover_ratio

string

Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило пересылки как основной пул (то есть не как резервный пул для другого целевого пула). Значение поля должно находиться в диапазоне [0, 1].

Если это поле задано, необходимо также задать backupPool. Вместе они определяют поведение основного целевого пула при переключении: если доля работоспособных экземпляров в основном пуле меньше или равна этому значению, трафик, поступающий на IP-адрес с балансировкой нагрузки, будет направлен в резервный пул.

Если failoverRatio не задан или все экземпляры в резервном пуле неработоспособны, трафик будет направлен обратно в основной пул в режиме «force». В этом режиме трафик по возможности распределяется между работоспособными экземплярами, а если нет ни одного работоспособного экземпляра — между всеми экземплярами.

health_check

dictionary

Ссылка на ресурс HttpHealthCheck.

Экземпляр, входящий в этот пул, считается работоспособным тогда и только тогда, когда проверки работоспособности завершаются успешно. Если значение не указано, все экземпляры пула всегда считаются работоспособными.

Это поле представляет ссылку на ресурс HttpHealthCheck в GCP. Его можно указать двумя способами. Во-первых, можно задать словарь с ключом ‘selfLink’ и значением selfLink ресурса. В качестве альтернативы можно добавить `register: name-of-resource` в задачу gcp_compute_http_health_check, а затем присвоить этому полю health_check значение “{{ name-of-resource }}”

instances

list / elements=dictionary

Список экземпляров виртуальных машин, обслуживающих этот пул.

Они должны находиться в зонах того же региона, что и этот пул.

name

string / обязательный

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой; последний символ не может быть дефисом.

project

string

Проект Google Cloud Platform, который будет использоваться.

region

string / обязательный

Регион, в котором находится целевой пул.

scopes

list / elements=string

Массив используемых областей действия

service_account_contents

jsonarg

Содержимое JSON-файла сервисного аккаунта в виде словаря или JSON-строки, представляющей его.

service_account_email

string

Необязательный адрес электронной почты сервисного аккаунта, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.

service_account_file

path

Путь к JSON-файлу сервисного аккаунта, если в качестве типа выбран serviceaccount.

session_affinity

string

Параметр привязки сеанса. Должен иметь одно из следующих значений: * NONE: подключения с одного и того же IP-адреса клиента могут направляться к любому экземпляру в пуле.

* CLIENT_IP: подключения с одного и того же IP-адреса клиента будут направляться к одному и тому же экземпляру в пуле, пока этот экземпляр остаётся работоспособным.

* CLIENT_IP_PROTO: подключения с одного и того же IP-адреса клиента и с одинаковым IP-протоколом будут направляться к одному и тому же экземпляру в пуле, пока этот экземпляр остаётся работоспособным.

Допустимые значения: “NONE”, “CLIENT_IP”, “CLIENT_IP_PROTO”

state

string

Должен ли указанный объект существовать в GCP

Допустимые значения:

• "present" ← (по умолчанию)
• "absent"

backupPool

dictionary

Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило пересылки как основной пул, а его поле failoverRatio правильно настроено на значение в диапазоне [0, 1].

Поля backupPool и failoverRatio совместно определяют поведение основного целевого пула при переключении: если доля работоспособных экземпляров в основном пуле меньше или равна failoverRatio, трафик, поступающий на IP-адрес с балансировкой нагрузки, будет направлен в резервный пул.

Если failoverRatio и backupPool не заданы или все экземпляры в резервном пуле неработоспособны, трафик будет направлен обратно в основной пул в режиме «force». В этом режиме трафик по возможности распределяется между работоспособными экземплярами, а если нет ни одного работоспособного экземпляра — между всеми экземплярами.

Возвращается: при успешном выполнении

creationTimestamp

string

Время создания в текстовом формате RFC3339.

Возвращается: при успешном выполнении

description

string

Необязательное описание этого ресурса.

Возвращается: при успешном выполнении

failoverRatio

string

Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило пересылки как основной пул (то есть не как резервный пул для другого целевого пула). Значение поля должно находиться в диапазоне [0, 1].

Если это поле задано, необходимо также задать backupPool. Вместе они определяют поведение основного целевого пула при переключении: если доля работоспособных экземпляров в основном пуле меньше или равна этому значению, трафик, поступающий на IP-адрес с балансировкой нагрузки, будет направлен в резервный пул.

Если failoverRatio не задан или все экземпляры в резервном пуле неработоспособны, трафик будет направлен обратно в основной пул в режиме «force». В этом режиме трафик по возможности распределяется между работоспособными экземплярами, а если нет ни одного работоспособного экземпляра — между всеми экземплярами.

Возвращается: при успешном выполнении

healthCheck

dictionary

Ссылка на ресурс HttpHealthCheck.

Экземпляр, входящий в этот пул, считается работоспособным тогда и только тогда, когда проверки работоспособности завершаются успешно. Если значение не указано, все экземпляры пула всегда считаются работоспособными.

Возвращается: при успешном выполнении

id

integer

Уникальный идентификатор ресурса.

Возвращается: при успешном выполнении

instances

list / elements=string

Список экземпляров виртуальных машин, обслуживающих этот пул.

Они должны находиться в зонах того же региона, что и этот пул.

Возвращается: при успешном выполнении

name

string

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой; последний символ не может быть дефисом.

Возвращается: при успешном выполнении

region

string

Регион, в котором находится целевой пул.

Возвращается: при успешном выполнении

sessionAffinity

string

Параметр привязки сеанса. Должен иметь одно из следующих значений: * NONE: подключения с одного и того же IP-адреса клиента могут направляться к любому экземпляру в пуле.

* CLIENT_IP: подключения с одного и того же IP-адреса клиента будут направляться к одному и тому же экземпляру в пуле, пока этот экземпляр остаётся работоспособным.

* CLIENT_IP_PROTO: подключения с одного и того же IP-адреса клиента и с одинаковым IP-протоколом будут направляться к одному и тому же экземпляру в пуле, пока этот экземпляр остаётся работоспособным.

Возвращается: при успешном выполнении