Spec-Zone.ru › Ansible 2.11

community.google.gc_storage – Этот модуль управляет объектами/ведёрами в Google Cloud Storage.

Примечание

Этот плагин является частью коллекции community.google (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.google.

Для использования в книге задач укажите: community.google.gc_storage.

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

Обзор

  • Этот модуль позволяет пользователям управлять своими объектами/ведёрами в Google Cloud Storage. Он позволяет выполнять операции загрузки и скачивания, а также устанавливать некоторые предопределённые разрешения. Он также позволяет получать URL-адреса объектов для использования в задачах, а также извлекать строковое содержимое объектов. Этот модуль требует предварительной настройки проекта по умолчанию в GCS перед использованием задачи. Смотрите https://developers.google.com/storage/docs/reference/v1/apiversion1 за информацией о настройке проекта по умолчанию.

Требования

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

  • python >= 2.6
  • boto >= 2.9

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
bucket
строка / обязательно
Имя ведра.
dest
путь
Путь к целевому файлу при скачивании объекта/ключа с помощью операции GET.
expiration
целое число
По умолчанию:
600
Срок действия (в секундах) для URL-адреса, сгенерированного и возвращенного GCA при выполнении операции mode=put или mode=get_url. Этот URL доступен только при разрешении public-read для объекта.

псевдонимы: expiry
gs_access_key
строка / обязательно
Ключ доступа GS. Если не задан, используется значение переменной среды GS_ACCESS_KEY_ID.
gs_secret_key
строка / обязательно
Секретный ключ GS. Если не задан, используется значение переменной среды GS_SECRET_ACCESS_KEY.
headers
словарь
По умолчанию:
{}
Заголовки, которые необходимо добавить к объекту.
mode
строка / обязательно
    Варианты:
  • get
  • put
  • get_url
  • get_str
  • delete
  • create
Переключает поведение модуля между загрузкой, скачиванием, получением URL (возврат URL скачивания), скачиванием объекта как строки, созданием (ведра) и удалением (ведра).
object
путь
Имя ключа объекта внутри ведра. Также может использоваться для создания «виртуальных каталогов» (см. примеры).
overwrite
логический тип
    Варианты:
  • нет
  • да ←
Принудительно перезаписывает локально на файловой системе или удаленно объект/ключ. Используется для операций PUT и GET.

псевдонимы: force
permission
строка
    Варианты:
  • private ←
  • public-read
  • authenticated-read
Этот параметр позволяет пользователю устанавливать предопределённые разрешения на создаваемый объект/ведро. Разрешения, которые могут быть установлены, это 'private', 'public-read', 'authenticated-read'.
region
строка
По умолчанию:
"US"
Регион gs для использования. Если не определён, используется значение 'US'. Смотрите https://cloud.google.com/storage/docs/bucket-locations
src
строка
Путь к исходному файлу при выполнении операции PUT.
versioning
логический тип
    Варианты:
  • нет ←
  • да
Указывает, включена или выключена версия (обратите внимание, что после включения версия может быть только приостановлена)

Примеры

- name: Upload some content
  community.google.gc_storage:
    bucket: mybucket
    object: key.txt
    src: /usr/local/myfile.txt
    mode: put
    permission: public-read

- name: Upload some headers
  community.google.gc_storage:
    bucket: mybucket
    object: key.txt
    src: /usr/local/myfile.txt
    headers: '{"Content-Encoding": "gzip"}'

- name: Download some content
  community.google.gc_storage:
    bucket: mybucket
    object: key.txt
    dest: /usr/local/myfile.txt
    mode: get

- name: Download an object as a string to use else where in your playbook
  community.google.gc_storage:
    bucket: mybucket
    object: key.txt
    mode: get_str

- name: Create an empty bucket
  community.google.gc_storage:
    bucket: mybucket
    mode: create

- name: Create a bucket with key as directory
  community.google.gc_storage:
    bucket: mybucket
    object: /my/directory/path
    mode: create

- name: Delete a bucket and all contents
  community.google.gc_storage:
    bucket: mybucket
    mode: delete

- name: Create a bucket with versioning enabled
  community.google.gc_storage:
    bucket: "mybucket"
    versioning: yes
    mode: create

- name: Create a bucket located in the eu
  community.google.gc_storage:
    bucket: "mybucket"
    region: "europe-west3"
    mode: create

Авторы

  • Benno Joy (@bennojoy)
  • Lukas Beumer (@Nitaco)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/google/gc_storage_module.html

Spec-Zone.ru

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