Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_target_pool – Создает GCP TargetPool

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Чтобы использовать его в playbook, укажите: google.cloud.gcp_compute_target_pool.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Представляет ресурс TargetPool, используемый для балансировки нагрузки.

Требования

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

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

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

Содержимое файла Service Account JSON, либо в словаре, либо в виде JSON-строки, которая его представляет.

service_account_email

string

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

service_account_file

path

Путь к файлу Service Account 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"

Примечания

Примечание

  • API Reference: 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.
  • Для аутентификации вы можете установить access_token используя переменную окружения GCP_ACCESS_TOKEN.
  • Для аутентификации вы можете установить auth_kind используя переменную окружения GCP_AUTH_KIND.
  • Для аутентификации вы можете установить scopes используя переменную окружения GCP_SCOPES.
  • Значения переменных окружения будут использоваться только в том случае, если значения в playbook не установлены.
  • Параметры 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_target_pool_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API