gcp_storage_object – Создаёт объект GCP
Новая версия с 2.8.
Обзор
- Загрузка или скачивание файла из ведра GCS.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action - |
| Загрузка или скачивание из ведра. |
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| bucket - | Имя ведра. | |
| dest - | Место назначения файла (может быть локальным компьютером или облаком в зависимости от действия). | |
| overwrite булево |
| 'Перезаписать файл в ведре/на локальном компьютере. Если overwrite ложно и существует разница между GCS и локальной машиной, модуль завершится с ошибкой' . |
| project строка | Используемый проект Google Cloud Platform. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи сервиса. Не следует передавать это как словарь, а как строку с точным содержимым файла service account json (корректный JSON). | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи сервиса, если тип выбран как serviceaccount. | |
| src - | Местоположение источника файла (может быть локальным компьютером или облаком в зависимости от действия). | |
| state - |
| Существует ли данный объект в GCP |
Примечания
Примечание
- Для аутентификации можно установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a object
gcp_storage_object:
name: ansible-storage-module
action: download
bucket: ansible-bucket
src: modules.zip
dest: "~/modules.zip"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| action строка | success | Загрузка или скачивание из ведра. |
| bucket строка | success | Имя ведра. |
| dest строка | success | Место назначения файла (может быть локальным компьютером или облаком в зависимости от действия). |
| overwrite булево | success | 'Перезаписать файл в ведре/на локальном компьютере. Если overwrite ложно и существует разница между GCS и локальной машиной, модуль завершится с ошибкой' . |
| src строка | success | Местоположение источника файла (может быть локальным компьютером или облаком в зависимости от действия). |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_storage_object_module.html