gcp_compute_backend_service_info – Сбор информации о GCP BackendService
Новое в версии 2.7.
Описание
- Сбор информации о GCP BackendService
- Этот модуль назывался
gcp_compute_backend_service_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: gcp_compute_backend_service_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API. | |
| filters список | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2) . | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список | Массив используемых областей. | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, представленное либо в виде словаря, либо как строка JSON, которая его представляет. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран в качестве типа. |
Примечания
Примечание
- для аутентификации можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on a backend service
gcp_compute_backend_service_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| resources complex | всегда | Список ресурсов | |||
| affinityCookieTtlSec целое число | успех | Срок жизни cookie в секундах, если session_affinity — GENERATED_COOKIE. Если установлено значение 0, cookie не сохраняется и действует только до закрытия сеанса браузера (или эквивалента). Максимально допустимое значение TTL — один день. При использовании схемы балансировки INTERNAL это поле не используется. | |||
| backends complex | успех | Набор бэкендов, обслуживающих этот 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 строка | успех | Полный URL ресурса группы экземпляров (Instance Group) или группы сетевых конечных точек (Network Endpoint Group). В случае группы экземпляров это определяет список экземпляров, которые обслуживают трафик. Виртуальные машины-члены каждой группы экземпляров должны находиться в той же зоне, что и сама группа экземпляров. Два бэкенда в службе бэкендов не могут использовать один и тот же ресурс группы экземпляров. Для групп сетевых конечных точек это определяет список конечных точек. Все конечные точки группы сетевых конечных точек должны быть размещены на экземплярах, расположенных в той же зоне, что и сама группа сетевых конечных точек. Служба бэкендов не может содержать смесь бэкендов групп экземпляров и групп сетевых конечных точек. Обратите внимание, что вы должны указать ресурс группы экземпляров или группы сетевых конечных точек с помощью полного URL-адреса, а не частичного. | |||
| maxConnections целое число | успех | Максимальное количество одновременных подключений для группы. Может использоваться с режимами балансировки CONNECTION или UTILIZATION. Для режима CONNECTION необходимо установить либо maxConnections, либо maxConnectionsPerInstance или maxConnectionsPerEndpoint, в зависимости от типа группы. | |||
| maxConnectionsPerEndpoint целое число | успех | Максимальное количество одновременных подключений, которые может обрабатывать одна сетевая конечная точка бэкенда. Используется для расчета емкости группы. Может использоваться в режимах балансировки CONNECTION или UTILIZATION. Для режима CONNECTION необходимо установить либо maxConnections, либо maxConnectionsPerEndpoint. | |||
| maxConnectionsPerInstance целое число | успех | Максимальное количество одновременных подключений, которые может обработать один экземпляр бэкенда. Используется для расчета емкости группы. Может использоваться в режимах балансировки CONNECTION или UTILIZATION. Для режима CONNECTION необходимо установить либо maxConnections, либо maxConnectionsPerInstance. | |||
| maxRate целое число | успех | Максимальное количество запросов в секунду (RPS) для группы. Может использоваться с режимами балансировки RATE или UTILIZATION, но требуется в режиме RATE. Для режима RATE необходимо установить либо maxRate, либо maxRatePerInstance или maxRatePerEndpoint, в зависимости от типа группы. | |||
| maxRatePerEndpoint строка | успех | Максимальное количество запросов в секунду (RPS), которое может обработать одна сетевая конечная точка бэкенда. Используется для расчета емкости группы. Может использоваться в любом режиме балансировки. Для режима RATE необходимо установить либо maxRate, либо maxRatePerEndpoint. | |||
| maxRatePerInstance строка | успех | Максимальное количество запросов в секунду (RPS), которое может обработать один экземпляр бэкенда. Используется для расчета емкости группы. Может использоваться в любом режиме балансировки. Для режима RATE необходимо установить либо maxRate, либо maxRatePerInstance. | |||
| maxUtilization строка | успех | Используется при balancingMode — UTILIZATION. Это соотношение определяет целевую загрузку ЦП для группы. По умолчанию — 0,8. Допустимый диапазон — [0,0, 1,0]. | |||
| cdnPolicy complex | успех | Настройка Cloud CDN для этого BackendService. | |||
| cacheKeyPolicy complex | успех | 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 целое число | успех | Максимальное количество секунд, в течение которого ответ на запрос с подписью URL-адреса будет считаться свежим, по умолчанию 1 час (3600 с). По истечении этого периода ответ будет перепроверен перед отображением. При предоставлении ответов на запросы с подписью URL-адреса Cloud CDN будет внутренне вести себя так, как будто все ответы с этого бэкенда имеют заголовок "Cache-Control: public, max-age=[TTL]", независимо от любого существующего заголовка Cache-Control. Фактические заголовки, подаваемые в ответах, не будут изменены. | |||
| connectionDraining complex | успех | Настройки для отключения соединения. | |||
| drainingTimeoutSec целое число | успех | Время, в течение которого экземпляр будет отключаться (не будет принимать новые подключения, но будет продолжать работу для завершения начатых). | |||
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. | |||
| описание строка | успех | Необязательное описание этого ресурса. | |||
| enableCDN булево | успех | Если true, включить Cloud CDN для этого BackendService. | |||
| fingerprint строка | успех | Отпечаток этого ресурса. Хэш содержимого, хранящегося в этом объекте. Это поле используется для оптимистической блокировки. | |||
| healthChecks список | успех | Набор URL-адресов ресурсов HttpHealthCheck или HttpsHealthCheck для проверки работоспособности этого BackendService. В настоящее время можно указать не более одного ресурса проверки работоспособности, и ресурс проверки работоспособности обязателен. Для внутренней балансировки нагрузки необходимо указать URL-адрес ресурса HealthCheck. | |||
| iap сложный | успех | Настройки для включения Cloud Identity Aware Proxy. | |||
| enabled булево | успех | Включает IAP. | |||
| oauth2ClientId строка | успех | Идентификатор клиента OAuth2 для IAP. | |||
| oauth2ClientSecret строка | успех | Секретный ключ клиента OAuth2 для IAP. | |||
| oauth2ClientSecretSha256 строка | успех | Секретный ключ клиента OAuth2 SHA-256 для IAP. | |||
| id целое число | успех | Уникальный идентификатор ресурса. | |||
| loadBalancingScheme строка | успех | Указывает, будет ли обратная служба использоваться с внутренней или внешней балансировкой нагрузки. Обратная служба, созданная для одного типа балансировки нагрузки, не может использоваться с другим. Должно быть `EXTERNAL` или `INTERNAL_SELF_MANAGED` для глобальной обратной службы. По умолчанию `EXTERNAL`. | |||
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |||
| portName строка | успех | Имя порта обратной службы. То же имя должно быть указано в группах экземпляров, на которые ссылается эта служба. Требуется, когда схема балансировки нагрузки — EXTERNAL. | |||
| protocol строка | успех | Протокол, используемый этим BackendService для взаимодействия с обратными серверами. Возможные значения — HTTP, HTTPS, HTTP2, TCP и SSL. По умолчанию HTTP. **ПРИМЕЧАНИЕ**: HTTP2 допустим только для бета-типов балансировщиков HTTP/2 и может привести к ошибкам при использовании с API GA. | |||
| securityPolicy строка | успех | Политика безопасности, связанная с этой обратной службой. | |||
| sessionAffinity строка | успех | Тип сродства сессий для использования. По умолчанию NONE. Когда схема балансировки нагрузки — EXTERNAL, может быть NONE, CLIENT_IP или GENERATED_COOKIE. Когда протокол — UDP, это поле не используется. | |||
| timeoutSec целое число | успех | Сколько секунд ждать обратного сервера, прежде чем считать запрос неудачным. По умолчанию 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.9/modules/gcp_compute_backend_service_info_module.html
