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 строка | Проект Google Cloud Platform для использования. | |
| region - / обязательно | Регион, в котором находится целевой пул. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Этот параметр не должен передаваться в качестве словаря, а в виде строки, содержащей точное содержимое файла JSON учетной записи службы (действительный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file, используя переменную окружения
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email, используя переменную окружения
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить service_account_contents, используя переменную окружения
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| items сложное | всегда | Список элементов | |
| 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 будут направляться одному и тому же экземпляру в пуле, пока этот экземпляр остается здоровым. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [бета]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/gcp_compute_target_pool_facts_module.html
