community.general.gc_storage – Этот модуль управляет объектами/ведрами в Google Cloud Storage.
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.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 строка / обязательно |
| Переключает поведение модуля между загрузкой, скачиванием, получением URL (возврат URL для скачивания), получением строки (скачивание объекта как строки), созданием (ведра) и удалением (ведра). |
| object путь | Имя ключа объекта внутри ведра. Также может использоваться для создания «виртуальных каталогов» (см. примеры). | |
| overwrite логическое значение |
| Принудительно переписывает файл локально или удалённо с объектом/ключом. Используется с операциями PUT и GET. Псевдонимы: force |
| permission строка |
| Этот параметр позволяет пользователю устанавливать предопределённые разрешения на создаваемый объект/ведро. Разрешения, которые могут быть установлены: '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.general.gc_storage:
bucket: mybucket
object: key.txt
src: /usr/local/myfile.txt
mode: put
permission: public-read
- name: Upload some headers
community.general.gc_storage:
bucket: mybucket
object: key.txt
src: /usr/local/myfile.txt
headers: '{"Content-Encoding": "gzip"}'
- name: Download some content
community.general.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.general.gc_storage:
bucket: mybucket
object: key.txt
mode: get_str
- name: Create an empty bucket
community.general.gc_storage:
bucket: mybucket
mode: create
- name: Create a bucket with key as directory
community.general.gc_storage:
bucket: mybucket
object: /my/directory/path
mode: create
- name: Delete a bucket and all contents
community.general.gc_storage:
bucket: mybucket
mode: delete
- name: Create a bucket with versioning enabled
community.general.gc_storage:
bucket: "mybucket"
versioning: yes
mode: create
- name: Create a bucket located in the eu
community.general.gc_storage:
bucket: "mybucket"
region: "europe-west3"
mode: create
Авторы
- Benno Joy (@bennojoy)
- Lukas Beumer (@Nitaco)
© 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/community/general/gc_storage_module.html