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 | Срок действия (в секундах) URL-адреса, сгенерированного и возвращенного GCA при выполнении операции mode=put или mode=get_url. Этот URL доступен только при acl объекта типа public-read. | |
| force bool |
| Принудительно перезаписывает локальный файл или удаленный объект/ключ. Используется с операциями PUT и GET. псевдонимы: overwrite |
| gs_access_key обязательно | Ключ доступа GS. Если не задан, используется значение переменной среды GS_ACCESS_KEY_ID. | |
| gs_secret_key обязательно | Секретный ключ GS. Если не задан, используется значение переменной среды GS_SECRET_ACCESS_KEY. | |
| headers (добавлен в 2.0) | По умолчанию: {} | Заголовки, которые нужно добавить к объекту. |
| mode обязательно |
| Переключает поведение модуля между загрузкой, скачиванием, получением 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 bool (добавлен в 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. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом 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.6/modules/gc_storage_module.html