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 строка | Проект Google Cloud Platform, который необходимо использовать. | |
| 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. - Значения переменных среды будут использоваться только в том случае, если значения в данном плейбуке не заданы.
- Параметры 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Значения возврата
Общие значения возврата описаны здесь, ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| items сложный тип | всегда | Список элементов | |||
| affinityCookieTtlSec целое число | успех | Срок действия cookie в секундах, если session_affinity равен GENERATED_COOKIE. Если установлено значение 0, cookie не сохраняется и действует только до закрытия сеанса браузера (или эквивалентного). Максимально допустимое значение TTL составляет один день. При использовании схемы балансировки INTERNAL это поле не используется. | |||
| backends сложный тип | успех | Список бэкэндов, обслуживающих данный BackendService. | |||
| balancingMode строка | успех | Указывает режим балансировки для данного бэкэнда. Для глобальной HTTP(S) или TCP/SSL балансировки по умолчанию используется UTILIZATION. Допустимые значения: UTILIZATION, RATE (для HTTP(S)) и CONNECTION (для TCP/SSL). Не может быть использовано для внутренней балансировки. | |||
| capacityScaler строка | успех | Множитель, применяемый к максимальной обрабатывающей способности группы (на основе UTILIZATION, RATE или CONNECTION). Значение по умолчанию равно 1, что означает, что группа будет обслуживать до 100% своей конфигурированной мощности (в зависимости от balancingMode). Значение 0 означает полное отключение группы, предоставляющей 0% доступной мощности. Допустимый диапазон [0.0,1.0]. Не может быть использовано для внутренней балансировки. | |||
| description строка | успех | Необязательное описание данного ресурса. Укажите это свойство при создании ресурса. | |||
| group словарь | успех | Группа экземпляров определяет список экземпляров, обслуживающих трафик. Виртуальные машины-члены каждой группы экземпляров должны находиться в той же зоне, что и сама группа экземпляров. Два бэкэнда в BackendService не могут использовать один и тот же ресурс группы экземпляров. Если BackendService имеет схему внутренней балансировки, группа экземпляров должна находиться в зоне в том же регионе, что и BackendService. | |||
| maxConnections целое число | успех | Максимальное количество одновременных подключений для группы. Может использоваться с режимами балансировки CONNECTION или UTILIZATION. Для режима CONNECTION необходимо установить либо maxConnections, либо maxConnectionsPerInstance. Не может быть использовано для внутренней балансировки. | |||
| maxConnectionsPerInstance целое число | успех | Максимальное количество одновременных подключений, которые может обрабатывать один экземпляр бэкэнда. Используется для расчета мощности группы. Может использоваться в режимах балансировки CONNECTION или UTILIZATION. Для режима CONNECTION необходимо установить либо maxConnections, либо maxConnectionsPerInstance. Не может быть использовано для внутренней балансировки. | |||
| maxRate целое число | успех | Максимальное количество запросов в секунду (RPS) для группы. Может использоваться с режимами балансировки RATE или UTILIZATION, но обязательно для режима RATE. Для режима RATE необходимо установить либо maxRate, либо maxRatePerInstance. Не может быть использовано для внутренней балансировки. | |||
| maxRatePerInstance строка | успех | Максимальное количество запросов в секунду (RPS), которые может обработать один экземпляр бэкэнда. Используется для расчета мощности группы. Может использоваться в любом режиме балансировки. Для режима RATE необходимо установить либо maxRate, либо maxRatePerInstance. Не может быть использовано для внутренней балансировки. | |||
| maxUtilization строка | успех | Используется, когда balancingMode равен UTILIZATION. Это соотношение определяет целевое значение использования ЦП для группы. По умолчанию равно 0,8. Допустимый диапазон [0,0, 1,0]. Не может быть использовано для внутренней балансировки. | |||
| cdnPolicy сложный тип | успех | Настройка Cloud CDN для данного BackendService. | |||
| cacheKeyPolicy сложный тип | успех | CacheKeyPolicy для данного CdnPolicy. | |||
| includeHost булево | успех | Если true, запросы к разным хостам будут кэшироваться отдельно. | |||
| includeProtocol булево | успех | Если true, запросы http и https будут кэшироваться отдельно. | |||
| includeQueryString булево | успех | Если true, параметры запроса будут включены в ключ кэша в соответствии с query_string_whitelist и query_string_blacklist. Если ни один из них не задан, будет включена вся строка запроса. Если false, строка запроса будет полностью исключена из ключа кэша. | |||
| queryStringBlacklist список | успех | Имена параметров строки запроса, которые нужно исключить из ключей кэша. Все остальные параметры будут включены. Укажите либо query_string_whitelist, либо query_string_blacklist, но не оба. '&' и '=' будут закодированы в процентах и не будут обрабатываться как разделители. | |||
| queryStringWhitelist список | успех | Имена параметров строки запроса, которые нужно включить в ключи кэша. Все остальные параметры будут исключены. Укажите либо query_string_whitelist, либо query_string_blacklist, но не оба. '&' и '=' будут закодированы в процентах и не будут обрабатываться как разделители. | |||
| signedUrlCacheMaxAgeSec целое число | успех | Максимальное количество секунд, в течение которых ответ на запрос подписанной ссылки будет считаться свежим, по умолчанию 1 час (3600 сек). По истечении этого времени ответ будет перепроверен перед отображением. При предоставлении ответов на запросы подписанных URL-адресов Cloud CDN будет вести себя так, как будто все ответы от этого бэкэнда имели заголовок "Cache-Control: public, max-age=[TTL]", независимо от наличия существующего заголовка Cache-Control. Фактические заголовки, переданные в ответах, не будут изменены. | |||
| connectionDraining сложный тип | успех | Настройки для отключения соединений. | |||
| drainingTimeoutSec целое число | успех | Время, в течение которого экземпляр будет выводиться из работы (не принимает новые подключения, но продолжает работу для завершения начатых). | |||
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. | |||
| description строка | успех | Необязательное описание этого ресурса. | |||
| enableCDN булево | успех | Если true, включите Cloud CDN для этого BackendService. Если схема балансировки INTERNAL, это поле не используется. | |||
| fingerprint строка | успех | Отпечаток данного ресурса. Хеш содержимого, хранящегося в этом объекте. Это поле используется для оптимистической блокировки. | |||
| healthChecks список | успех | Список URL-адресов ресурсов HttpHealthCheck или HttpsHealthCheck для проверки работоспособности этого BackendService. В настоящее время можно указать не более одного средства проверки работоспособности, и средство проверки работоспособности обязательно. Для внутренней балансировки должен быть указан URL-адрес ресурса HealthCheck. | |||
| iap сложный тип | успех | Настройки для включения Cloud Identity Aware Proxy. | |||
| enabled булево | успех | Включает IAP. | |||
| oauth2ClientId строка | success | Идентификатор клиента OAuth2 для IAP. | |||
| oauth2ClientSecret строка | success | Секрет клиента OAuth2 для IAP. | |||
| oauth2ClientSecretSha256 строка | success | Секрет клиента OAuth2 SHA-256 для IAP. | |||
| id целое число | success | Уникальный идентификатор ресурса. | |||
| loadBalancingScheme строка | success | Указывает, будет ли бэкенд-сервис использоваться с внутренней или внешней балансировкой нагрузки. Бэкенд-сервис, созданный для одного типа балансировки нагрузки, не может использоваться с другим. Одно из значений `INTERNAL` или `EXTERNAL`. По умолчанию `EXTERNAL`. | |||
| name строка | success | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |||
| portName строка | success | Имя бэкенд-порта. То же самое имя должно присутствовать в группах экземпляров, на которые ссылается этот сервис. Требуется, когда схема балансировки нагрузки — EXTERNAL. Когда схема балансировки нагрузки — INTERNAL, этот параметр не используется. | |||
| protocol строка | success | Протокол, используемый этим BackendService для связи с бэкендами. Возможные значения: HTTP, HTTPS, TCP и SSL. По умолчанию HTTP. Для внутренней балансировки нагрузки возможные значения: TCP и UDP, по умолчанию TCP. | |||
| securityPolicy строка | success | Политика безопасности, связанная с этим бэкенд-сервисом. | |||
| sessionAffinity строка | success | Тип сродства сессии для использования. По умолчанию NONE. Когда схема балансировки нагрузки — EXTERNAL, может быть NONE, CLIENT_IP или GENERATED_COOKIE. Когда схема балансировки нагрузки — INTERNAL, может быть NONE, CLIENT_IP, CLIENT_IP_PROTO или CLIENT_IP_PORT_PROTO. Если протокол UDP, этот параметр не используется. | |||
| timeoutSec целое число | success | Количество секунд ожидания бэкенда перед оценкой запроса как неудачного. По умолчанию 30 секунд. Допустимый диапазон: [1, 86400]. | |||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_backend_service_facts_module.html
