google.cloud.gcp_compute_backend_bucket – Создаёт GCP BackendBucket
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).
Для его установки используйте: 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
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| bucket_name строка / обязательно | Имя ведра Cloud Storage. | ||
| cdn_policy словарь | Настройка Cloud CDN для данного бака бекенда. | ||
| signed_url_cache_max_age_sec целое число / обязательно | Максимальное количество секунд, в течение которых ответ на запрос с подписью URL-адреса будет считаться свежим. По истечении этого периода ответ будет перепроверен перед предоставлением. При обработке ответов на запросы с подписью URL-адреса Cloud CDN будет внутренне вести себя так, как будто все ответы от этого бекенда имели заголовок "Cache-Control: public, max-age=[TTL]", независимо от существующего заголовка Cache-Control. Фактические заголовки, переданные в ответах, не будут изменены. | ||
| description строка | Необязательное текстовое описание ресурса, предоставленное клиентом при создании ресурса. | ||
| enable_cdn булево |
| Если true, включить Cloud CDN для данного BackendBucket. | |
| 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 | |
Примечания
Примечание
- Справочник по 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. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не установлены.
- Параметры 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 для данного бака бекенда. | |
| signedUrlCacheMaxAgeSec целое число | успех | Максимальное количество секунд, в течение которых ответ на запрос с подписью URL-адреса будет считаться свежим. По истечении этого периода ответ будет перепроверен перед предоставлением. При обработке ответов на запросы с подписью URL-адреса Cloud CDN будет внутренне вести себя так, как будто все ответы от этого бекенда имели заголовок "Cache-Control: public, max-age=[TTL]", независимо от существующего заголовка Cache-Control. Фактические заголовки, переданные в ответах, не будут изменены. | |
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. | |
| 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_compute_backend_bucket_module.html