Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_backend_bucket — Создаёт GCP BackendBucket

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_compute_backend_bucket.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Описание

  • Баки заднего плана позволяют использовать хранилища Google Cloud Storage с балансировкой нагрузки HTTP(S).
  • Балансировщик HTTP(S) нагрузки может направлять трафик по указанным URL-адресам в бак заднего плана вместо службы заднего плана. Он может отправлять запросы на статический контент в хранилище Cloud Storage, а запросы на динамический контент — в виртуальную машину.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

строка / обязательно

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

bucket_name

строка / обязательно

Имя хранилища Cloud Storage.

cdn_policy

словарь

Настройка Cloud CDN для этого Backend Bucket.

cache_mode

строка

Указывает настройку кэша для всех ответов из этого бэкенда.

Возможные значения: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL и CACHE_ALL_STATIC.

Некоторые допустимые значения: “USE_ORIGIN_HEADERS”, “FORCE_CACHE_ALL”, “CACHE_ALL_STATIC”

client_ttl

целое число

Указывает максимальное разрешенное значение TTL для кэшированного содержимого, предоставляемого этим источником.

default_ttl

целое число

Указывает значение по умолчанию TTL для кэшированного содержимого, предоставляемого этим источником, для ответов, у которых нет действительного TTL (max-age или s-max-age).

max_ttl

целое число

Указывает максимальное разрешенное значение TTL для кэшированного содержимого, предоставляемого этим источником.

negative_caching

логическое значение

Отрицательный кэш позволяет задать TTL для каждого кода состояния, чтобы применить тонкую настройку кэширования для распространённых ошибок или перенаправлений.

Варианты:

  • false
  • true

negative_caching_policy

список / элементы=словарь

Устанавливает TTL кэша для указанного кода HTTP состояния. Для настройки отрицательного кэширования необходимо включить negativeCaching.

Пропуск политики и включение negativeCaching приведет к использованию стандартных TTL-значений Cloud CDN.

code

целое число

Код состояния HTTP для определения TTL. Можно указывать только коды 300, 301, 308, 404, 405, 410, 421, 451 и 501, и каждый код можно указать только один раз.

ttl

целое число

TTL (в секундах) для кэширования ответов с соответствующим кодом состояния. Максимальное значение составляет 1800 с (30 минут), при этом следует учитывать, что объекты, к которым редко обращаются, могут быть удалены из кэша до указанного TTL.

serve_while_stale

целое число

Предоставлять существующее содержимое из кэша (если доступно) при перепроверке содержимого с источником или при возникновении ошибки при обновлении кэша.

signed_url_cache_max_age_sec

целое число

Максимальное количество секунд, в течение которого ответ на запрос с подписью URL будет считаться свежим. По истечении этого периода ответ будет проверен повторно перед предоставлением.

При предоставлении ответов на запросы с подписью URL Cloud CDN будет внутренне вести себя так, как будто все ответы из этого бэкенда содержат заголовок «Cache-Control: public, max-age=[TTL]», независимо от наличия существующего заголовка Cache-Control. Фактические заголовки, предоставляемые в ответах, не будут изменены.

custom_response_headers

список / элементы=строка

Заголовки, которые балансировщик HTTP/S должен добавить к проксированным ответам.

description

строка

Необязательное текстовое описание ресурса; предоставляется клиентом при создании ресурса.

enable_cdn

логическое значение

Если true, включить Cloud CDN для этого BackendBucket.

Варианты:

  • false
  • true

env_type

строка

Указывает, в какой среде Ansible выполняется данный модуль.

Не устанавливать, если вы не знаете, что делаете.

Это только изменяет строку User Agent для любых запросов к API.

name

строка / обязательно

Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчными буквами или цифрами, за исключением последнего символа, который не может быть тире.

project

строка

Проект Google Cloud Platform, который следует использовать.

scopes

список / элементы=строка

Массив областей, которые будут использоваться

service_account_contents

jsonarg

Содержание файла JSON учетной записи сервиса, либо в виде словаря, либо в виде JSON-строки, представляющей этот словарь.

service_account_email

строка

Необязательный адрес электронной почты учетной записи сервиса, если выбран параметр machineaccount и пользователь не хочет использовать адрес по умолчанию.

service_account_file

путь

Путь к файлу JSON учетной записи сервиса, если тип выбран как serviceaccount.

state

строка

Указывает, должен ли заданный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

Примечания

Примечание

  • Ссылка на API: https://cloud.google.com/compute/docs/reference/v1/backendBuckets
  • Использование ведра Cloud Storage в качестве бэкенда балансировщика нагрузки: https://cloud.google.com/compute/docs/load-balancing/http/backend-bucket
  • для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
  • для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
  • для аутентификации можно установить access_token с помощью переменной среды GCP_ACCESS_TOKEN.
  • для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
  • для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
  • Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
  • Параметры service_account_email и service_account_file являются взаимоисключающими.

Примеры

- name: create a bucket
  google.cloud.gcp_storage_bucket:
    name: bucket-backendbucket
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: bucket

- name: create a backend bucket
  google.cloud.gcp_compute_backend_bucket:
    name: test_object
    bucket_name: "{{ bucket.name }}"
    description: A BackendBucket to connect LNB w/ Storage Bucket
    enable_cdn: 'true'
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ

Описание

bucketName

строка

Имя хранилища Cloud Storage.

Возвращено: успех

cdnPolicy

сложное

Настройка Cloud CDN для данного резервного хранилища.

Возвращено: успех

cacheMode

строка

Указывает настройки кэширования для всех ответов от этого резервного сервера.

Возможные значения: USE_ORIGIN_HEADERS, FORCE_CACHE_ALL и CACHE_ALL_STATIC.

Возвращено: успех

clientTtl

целое число

Указывает максимальное разрешённое время жизни кэшированного содержимого, предоставляемого этим источником.

Возвращено: успех

defaultTtl

целое число

Указывает значение по умолчанию TTL для кэшированного содержимого, предоставляемого этим источником, для ответов, у которых нет существующего действительного TTL (max-age или s-max-age).

Возвращено: успех

maxTtl

целое число

Указывает максимальное разрешённое время жизни кэшированного содержимого, предоставляемого этим источником.

Возвращено: успех

negativeCaching

булево

Отрицательное кэширование позволяет устанавливать TTL для кодов статуса, чтобы применить тонкую настройку кэширования для распространённых ошибок или перенаправлений.

Возвращено: успех

negativeCachingPolicy

сложное

Устанавливает время жизни кэша для указанного кода HTTP-статуса. Для настройки negativeCachingPolicy необходимо включить negativeCaching.

Опуская политику и оставляя negativeCaching включённым, будут использоваться значения по умолчанию Cloud CDN для времени жизни кэша.

Возвращено: успех

code

целое число

Код HTTP-статуса для определения TTL. Можно указывать только HTTP-статусы 300, 301, 308, 404, 405, 410, 421, 451 и 501, и каждый код можно указать только один раз.

Возвращено: успех

ttl

целое число

Время жизни кэша (в секундах) для ответов с соответствующим кодом статуса. Максимальное значение составляет 1800 секунд (30 минут), при этом следует учитывать, что редко используемые объекты могут быть удалены из кэша до истечения заданного TTL.

Возвращено: успех

serveWhileStale

целое число

Выдача существующего содержимого из кэша (если доступно), когда происходит проверка содержимого с источником или возникает ошибка при обновлении кэша.

Возвращено: успех

signedUrlCacheMaxAgeSec

целое число

Максимальное количество секунд, в течение которых ответ на запрос подписанной ссылки будет считаться свежим. По истечении этого периода ответ будет проверен повторно перед его выдачей.

При передаче ответов на запросы подписанных URL-адресов Cloud CDN будет вести себя так, как будто все ответы от этого резервного сервера имеют заголовок «Cache-Control: public, max-age=[TTL]», независимо от наличия существующего заголовка Cache-Control. Фактические заголовки, передаваемые в ответах, не будут изменены.

Возвращено: успех

creationTimestamp

строка

Дата и время создания в формате RFC3339.

Возвращено: успех

customResponseHeaders

список / элементы=строка

Заголовки, которые балансировщик нагрузки HTTP/S должен добавить к проксированным ответам.

Возвращено: успех

description

строка

Необязательное текстовое описание ресурса, предоставленное клиентом при создании ресурса.

Возвращено: успех

enableCdn

булево

Если true, включить Cloud CDN для данного BackendBucket.

Возвращено: успех

id

целое число

Уникальный идентификатор ресурса.

Возвращено: успех

name

строка

Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна составлять 1-63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

Возвращено: успех

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходные файлы)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_backend_bucket_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API