gcp_compute_target_pool_facts – Сбор фактов для GCP TargetPool
Новое в версии 2.7.
Описание
- Сбор фактов для GCP TargetPool
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| filters - | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). | |
| project - | Значение по умолчанию: null | Проект Google Cloud Platform для использования. |
| region - / обязательно | Регион, в котором находится целевой пул. | |
| scopes - | Массив используемых областей. | |
| service_account_email - | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file - | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран в качестве типа. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной окружения
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной окружения
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind с помощью переменной окружения
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной окружения
GCP_SCOPES. - Значения переменных окружения будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: a target pool facts
gcp_compute_target_pool_facts:
region: us-west1
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны здесь. Ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| items сложный | всегда | Список элементов | |
| backup_pool словарь | успех | Это поле применимо только тогда, когда содержащий целевой пул обслуживает правила переадресации в качестве основного пула, и его поле failoverRatio правильно установлено в значение от [0, 1]. backupPool и failoverRatio вместе определяют поведение резервирования основного целевого пула: если отношение здоровых экземпляров в основном пуле равно или меньше failoverRatio, трафик, поступающий по IP-адресу с балансировкой нагрузки, будет направлен в резервный пул. В случае, когда failoverRatio и backupPool не заданы или все экземпляры в резервном пуле не работают, трафик будет перенаправлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с наилучшим усилием или ко всем экземплярам, если ни один экземпляр не работает. | |
| creation_timestamp строка | успех | Дата и время создания в формате RFC3339. | |
| description строка | успех | Необязательное описание этого ресурса. | |
| failover_ratio строка | успех | Это поле применимо только тогда, когда содержащий целевой пул обслуживает правило переадресации в качестве основного пула (т.е. не как резервный пул для другого целевого пула). Значение поля должно находиться в [0, 1]. Если установлено, backupPool также должно быть установлено. Вместе они определяют поведение резервирования основного целевого пула: если отношение здоровых экземпляров в основном пуле равно или меньше этого числа, трафик, поступающий по IP-адресу с балансировкой нагрузки, будет направлен в резервный пул. В случае, когда failoverRatio не установлено или все экземпляры в резервном пуле не работают, трафик будет перенаправлен обратно в основной пул в режиме «force», где трафик будет распределен по здоровым экземплярам с наилучшим усилием или ко всем экземплярам, если ни один экземпляр не работает. | |
| health_check словарь | успех | Ссылка на ресурс HttpHealthCheck. Экземпляр-член в этом пуле считается здоровым только в том случае, если проверки состояния пройдены. Если не указано, это означает, что все экземпляры-члены будут считаться здоровыми во все время. | |
| id целое число | успех | Уникальный идентификатор ресурса. | |
| instances список | успех | Список виртуальных машин, обслуживающих этот пул. Они должны находиться в зонах, содержащихся в том же регионе, что и этот пул. | |
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |
| region строка | успех | Регион, в котором находится целевой пул. | |
| session_affinity строка | успех | Параметр сродства сеанса. Должно быть одним из этих значений: - 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.7/modules/gcp_compute_target_pool_facts_module.html
