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 | Ссылка на ресурс TargetPool. | |
| description | Необязательное описание этого ресурса. | |
| failover_ratio | Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило переадресации в качестве основного пула (т. е. не в качестве резервного пула для другого целевого пула). Значение поля должно быть в диапазоне [0, 1]. Если установлено, backupPool также должно быть установлено. Вместе они определяют поведение резервного копирования основного целевого пула: если отношение здоровых экземпляров в основном пуле равно или меньше этого числа, трафик, поступающий на IP-адрес сбалансированной нагрузки, будет направлен в резервный пул. В случае, если failoverRatio не установлено или все экземпляры в резервном пуле неисправны, трафик будет направлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с наилучшими усилиями или ко всем экземплярам, если экземпляров нет. | |
| health_check | Ссылка на ресурс HttpHealthCheck. | |
| instances | Список виртуальных машин, обслуживающих этот пул. Они должны находиться в зонах, содержащихся в том же регионе, что и этот пул. | |
| name обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| project | Проект Google Cloud Platform, который нужно использовать. | |
| region обязательно | Ссылка на ресурс Region. | |
| scopes обязательно | Массив используемых областей. | |
| service_account_email | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file | Путь к файлу JSON учетной записи службы, если в качестве типа выбрана serviceaccount. | |
| session_affinity |
| Вариант аффинити сессий. Должно быть одно из следующих значений: - NONE: Подключения с одного и того же IP-адреса клиента могут идти к любому экземпляру в пуле. - CLIENT_IP: Подключения с одного и того же IP-адреса клиента будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается исправным. - CLIENT_IP_PROTO: Подключения с одного и того же IP-адреса клиента с тем же IP-протоколом будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается исправным. |
| state обязательно |
| Необходимо ли наличие данного объекта в GCP |
Примечания
Примечание
- Для проверки подлинности можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для проверки подлинности можно установить 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
gcp_compute_target_pool:
name: testObject
region: 'us-west1'
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/compute
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| backup_pool dict | success | Ссылка на ресурс TargetPool. |
| creation_timestamp str | success | Дата и время создания в формате RFC3339. |
| description str | success | Необязательное описание этого ресурса. |
| failover_ratio str | success | Это поле применимо только в том случае, если содержащий целевой пул обслуживает правило переадресации в качестве основного пула (т. е. не в качестве резервного пула для другого целевого пула). Значение поля должно быть в диапазоне [0, 1]. Если установлено, backupPool также должно быть установлено. Вместе они определяют поведение резервного копирования основного целевого пула: если отношение здоровых экземпляров в основном пуле равно или меньше этого числа, трафик, поступающий на IP-адрес сбалансированной нагрузки, будет направлен в резервный пул. В случае, если failoverRatio не установлено или все экземпляры в резервном пуле неисправны, трафик будет направлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с наилучшими усилиями или ко всем экземплярам, если экземпляров нет. |
| health_check dict | success | Ссылка на ресурс HttpHealthCheck. |
| id int | success | Уникальный идентификатор ресурса. |
| instances list | success | Список виртуальных машин, обслуживающих этот пул. Они должны находиться в зонах, содержащихся в том же регионе, что и этот пул. |
| name str | success | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. |
| region str | success | Ссылка на ресурс Region. |
| session_affinity str | success | Вариант аффинити сессий. Должно быть одно из следующих значений: - NONE: Подключения с одного и того же IP-адреса клиента могут идти к любому экземпляру в пуле. - CLIENT_IP: Подключения с одного и того же IP-адреса клиента будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается исправным. - CLIENT_IP_PROTO: Подключения с одного и того же IP-адреса клиента с тем же IP-протоколом будут идти к одному и тому же экземпляру в пуле, пока этот экземпляр остается исправным. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/gcp_compute_target_pool_module.html
