gcp_compute_backend_service_facts – Сбор фактов для GCP BackendService
Новая версия с 2.7.
Обзор
- Сбор фактов для GCP BackendService
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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, который нужно использовать. |
| 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 backend service facts
gcp_compute_backend_service_facts:
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключи | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| items сложное | всегда | Список элементов | |||
| affinity_cookie_ttl_sec целое число | успех | Срок жизни cookie в секундах, если session_affinity — GENERATED_COOKIE. Если значение равно 0, cookie не сохраняется и действует только до конца сессии браузера (или эквивалента). Максимальное допустимое значение для TTL — один день. Если схема балансировки — ВНУТРЕННЯЯ, это поле не используется. | |||
| backends сложное | успех | Список бэкендов, обслуживающих этот BackendService. | |||
| balancing_mode строка | успех | Указывает режим балансировки для этого бэкенда. Для глобальной HTTP(S) или TCP/SSL балансировки по умолчанию используется UTILIZATION. Допустимые значения: UTILIZATION, RATE (для HTTP(S)) и CONNECTION (для TCP/SSL). Не может быть использовано для внутренней балансировки. | |||
| capacity_scaler строка | успех | Множитель, применяемый к максимальной емкости группы (основанный на UTILIZATION, RATE или CONNECTION). Значение по умолчанию — 1, что означает, что группа будет обслуживать до 100% своей конфигурированной емкости (в зависимости от balancingMode). Значение 0 означает, что группа полностью выключена, предлагая 0% своей доступной емкости. Допустимый диапазон значений — [0.0, 1.0]. Не может быть использовано для внутренней балансировки. | |||
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |||
| group словарь | успех | Эта группа экземпляров определяет список экземпляров, которые обслуживают трафик. Виртуальные машины-члены каждой группы экземпляров должны находиться в той же зоне, что и сама группа экземпляров. Два бэкенда в службе бэкенда не могут использовать один и тот же ресурс группы экземпляров. Когда BackendService имеет схему балансировки ВНУТРЕННЯЯ, группа экземпляров должна находиться в зоне в том же регионе, что и BackendService. | |||
| max_connections целое число | успех | Максимальное количество одновременных подключений для группы. Может использоваться с режимами балансировки CONNECTION или UTILIZATION. Для режима CONNECTION необходимо установить либо maxConnections, либо maxConnectionsPerInstance. Не может быть использовано для внутренней балансировки. | |||
| max_connections_per_instance целое число | успех | Максимальное количество одновременных подключений, которые может обработать один бэкенд-экземпляр. Используется для расчета емкости группы. Может использоваться в режимах балансировки CONNECTION или UTILIZATION. Для режима CONNECTION необходимо установить либо maxConnections, либо maxConnectionsPerInstance. Не может быть использовано для внутренней балансировки. | |||
| max_rate целое число | успех | Максимальное количество запросов в секунду (RPS) группы. Может использоваться с режимами балансировки RATE или UTILIZATION, но обязательно для режима RATE. Для режима RATE необходимо установить либо maxRate, либо maxRatePerInstance. Не может быть использовано для внутренней балансировки. | |||
| max_rate_per_instance строка | успех | Максимальное количество запросов в секунду (RPS), которые может обработать один бэкенд-экземпляр. Используется для расчета емкости группы. Может использоваться в любом режиме балансировки. Для режима RATE необходимо установить либо maxRate, либо maxRatePerInstance. Не может быть использовано для внутренней балансировки. | |||
| max_utilization строка | успех | Используется, когда balancingMode — UTILIZATION. Это отношение определяет целевое значение использования ЦП для группы. По умолчанию — 0,8. Допустимый диапазон значений — [0.0, 1.0]. Не может быть использовано для внутренней балансировки. | |||
| cdn_policy сложное | успех | Настройка Cloud CDN для этого BackendService. | |||
| cache_key_policy сложное | успех | CacheKeyPolicy для этого CdnPolicy. | |||
| include_host логическое значение | успех | Если true, запросы к различным хостам будут кэшироваться отдельно. | |||
| include_protocol логическое значение | успех | Если true, запросы http и https будут кэшироваться отдельно. | |||
| include_query_string логическое значение | успех | Если true, параметры строки запроса включаются в ключ кэша в соответствии с query_string_whitelist и query_string_blacklist. Если ни один из них не установлен, вся строка запроса будет включена. Если false, строка запроса будет полностью исключена из ключа кэша. | |||
| query_string_blacklist список | успех | Имена параметров строки запроса, которые нужно исключить из ключей кэша. Все остальные параметры будут включены. Укажите либо query_string_whitelist, либо query_string_blacklist, но не оба. '&' и '=' будут закодированы в процентах и не будут обрабатываться как разделители. | |||
| query_string_whitelist список | успех | Имена параметров строки запроса, которые нужно включить в ключи кэша. Все остальные параметры будут исключены. Укажите либо query_string_whitelist, либо query_string_blacklist, но не оба. '&' и '=' будут закодированы в процентах и не будут обрабатываться как разделители. | |||
| connection_draining сложное | успех | Настройки для вывода соединений. | |||
| draining_timeout_sec целое число | успех | Время, в течение которого экземпляр будет выводиться (не принимает новые подключения, но все равно работает для завершения начатых). | |||
| creation_timestamp строка | успех | Маркер времени создания в формате RFC3339. | |||
| description строка | успех | Необязательное описание этого ресурса. | |||
| enable_cdn логическое значение | успех | Если true, включить Cloud CDN для этого BackendService. Если схема балансировки — ВНУТРЕННЯЯ, это поле не используется. | |||
| health_checks список | успех | Список URL-адресов ресурса HttpHealthCheck или HttpsHealthCheck для проверки работоспособности этого BackendService. В настоящее время можно указать не более одного проверочного ресурса, и проверочный ресурс необходим. Для внутренней балансировки должен быть указан URL-адрес ресурса HealthCheck. | |||
| id целое число | успех | Уникальный идентификатор ресурса. | |||
| name строка | успех | Имя ресурса. Указывается клиентом при создании ресурса. Длина имени должна быть 1-63 символа и соответствовать RFC1035. То есть, длина имени должна быть 1-63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |||
| port_name строка | успех | Имя порта бэкенда. Это же имя должно присутствовать в группах экземпляров, на которые ссылается эта служба. Необходимо, когда схема балансировки — ВНЕШНЯЯ. Если схема балансировки — ВНУТРЕННЯЯ, это поле не используется. | |||
| протокол строка | успех | Протокол, используемый этим BackendService для связи с бэкендами. Возможные значения — HTTP, HTTPS, TCP и SSL. По умолчанию используется HTTP. Для внутренней балансировки нагрузки возможные значения — TCP и UDP, по умолчанию используется TCP. | |||
| регион строка | успех | Регион, в котором находится региональная служба бэкенда. Это поле неприменимо к глобальным службам бэкенда. | |||
| session_affinity строка | успех | Тип используемого сродства сессий. По умолчанию — NONE. При схеме балансировки нагрузки EXTERNAL может быть NONE, CLIENT_IP или GENERATED_COOKIE. При схеме балансировки нагрузки INTERNAL может быть NONE, CLIENT_IP, CLIENT_IP_PROTO или CLIENT_IP_PORT_PROTO. При протоколе UDP это поле не используется. | |||
| timeout_sec целое число | успех | Количество секунд ожидания бэкенда перед признанием запроса неудачным. По умолчанию — 30 секунд. Допустимый диапазон — [1, 86400]. | |||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_backend_service_facts_module.html
