gc_storage — Этот модуль управляет объектами/бакетами в Google Cloud Storage.
Новый в версии 1.4.
Обзор
- Этот модуль позволяет пользователям управлять своими объектами/бакетами в Google Cloud Storage. Он позволяет выполнять операции загрузки и скачивания, а также устанавливать некоторые предопределенные разрешения. Он также позволяет получать URL-адреса объектов для использования в плейбуках и извлекать текстовое содержимое объектов. Для использования этого модуля в плейбуках необходимо предварительно установить проект по умолчанию в GCS. См. https://developers.google.com/storage/docs/reference/v1/apiversion1 для получения информации об установке проекта по умолчанию.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- boto >= 2.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| bucket обязательно | Имя бакета. | |
| dest | Путь к целевому файлу при скачивании объекта/ключа с помощью операции GET. | |
| expiration | По умолчанию: None | Срок действия (в секундах) URL-адреса, сгенерированного и возвращенного GCA при выполнении операции mode=put или mode=get_url. Этот URL доступен только при разрешении public-read для объекта. |
| force | По умолчанию: yes | Принудительная перезапись локально на файловой системе или удаленно в объекте/ключе. Используется с операциями PUT и GET. Псевдонимы: overwrite |
| gs_access_key обязательно | По умолчанию: None | Ключ доступа GS. Если не задан, используется значение переменной окружения GS_ACCESS_KEY_ID. |
| gs_secret_key обязательно | По умолчанию: None | Секретный ключ GS. Если не задан, используется значение переменной окружения GS_SECRET_ACCESS_KEY. |
| headers (добавлен в 2.0) | По умолчанию: {} | Заголовки, которые необходимо добавить к объекту. |
| mode обязательно |
None | Переключает поведение модуля между загрузкой, скачиванием, получением URL (возвращение URL для скачивания), получением строки (скачивание объекта как строки), созданием (бакета) и удалением (бакета). |
| object | По умолчанию: None | Имя ключа объекта внутри бакета. Также может использоваться для создания «виртуальных каталогов» (см. примеры). |
| permission | По умолчанию: private | Этот параметр позволяет пользователю установить предопределенные разрешения на создаваемый объект/баккет. Разрешения, которые можно установить: 'private', 'public-read', 'authenticated-read'. |
| region (добавлен в 2.4) | По умолчанию: US | Регион gs для использования. Если не определен, используется значение 'US'. См. https://cloud.google.com/storage/docs/bucket-locations
|
| src | По умолчанию: None | Путь к исходному файлу при выполнении операции PUT. |
| versioning (добавлен в 2.4) |
None | Включена или выключена функция ведения истории версий (обратите внимание, что после включения ведения истории версий ее можно только приостановить) |
Примеры
- name: Upload some content
gc_storage:
bucket: mybucket
object: key.txt
src: /usr/local/myfile.txt
mode: put
permission: public-read
- name: Upload some headers
gc_storage:
bucket: mybucket
object: key.txt
src: /usr/local/myfile.txt
headers: '{"Content-Encoding": "gzip"}'
- name: Download some content
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
gc_storage:
bucket: mybucket
object: key.txt
mode: get_str
- name: Create an empty bucket
gc_storage:
bucket: mybucket
mode: create
- name: Create a bucket with key as directory
gc_storage:
bucket: mybucket
object: /my/directory/path
mode: create
- name: Delete a bucket and all contents
gc_storage:
bucket: mybucket
mode: delete
- name: Create a bucket with versioning enabled
gc_storage:
bucket: "mybucket"
versioning: yes
mode: create
- name: Create a bucket located in the eu
gc_storage:
bucket: "mybucket"
region: "europe-west3"
mode: create
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- 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.5/modules/gc_storage_module.html