gc_storage – Этот модуль управляет объектами/ведрами в Google Cloud 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 - | Срок действия (в секундах) URL-адреса, сгенерированного и возвращенного GCA при выполнении операции mode=put или mode=get_url. Этот URL-адрес доступен только при acl объекта "public-read". | |
| force логический |
| Принудительная перезапись локально на файловой системе или удаленно с объектом/ключом. Используется при операциях PUT и GET. Псевдонимы: overwrite |
| gs_access_key - / обязательно | Ключ доступа GS. Если не задан, используется значение переменной среды GS_ACCESS_KEY_ID. | |
| gs_secret_key - / обязательно | Секретный ключ GS. Если не задан, используется значение переменной среды GS_SECRET_ACCESS_KEY. | |
| headers - | По умолчанию: {} | Заголовки, которые нужно добавить к объекту. |
| mode - / обязательно |
| Переключает поведение модуля между загрузкой, скачиванием, получением URL-адреса (возвращает URL-адрес для скачивания), получением строки (скачивает объект как строку), созданием (ведра) и удалением (ведра). |
| object - | Имя ключа объекта внутри ведра. Также может использоваться для создания «виртуальных каталогов» (см. примеры). | |
| permission - | По умолчанию: "private" | Этот параметр позволяет пользователю задать стандартные разрешения для создаваемого объекта/ведра. Разрешения, которые могут быть установлены, — 'private', 'public-read', 'authenticated-read'. |
| region - добавлен в 2.4 | По умолчанию: "US" | Регион gs для использования. Если не определен, используется значение 'US'. См. https://cloud.google.com/storage/docs/bucket-locations
|
| src - | Путь к исходному файлу при выполнении операции PUT. | |
| versioning логический добавлен в 2.4 |
| Включена или выключена поддержка версий (обратите внимание, что после включения версионирования ее можно только приостановить) |
Примеры
- 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
Статус
- Интерфейс этого модуля не гарантируется обратной совместимостью. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/gc_storage_module.html