gcp_storage_object – Создаёт объект GCP
Новое в версии 2.8.
Описание
- Загрузка или скачивание файла из ведра GCS.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action строка | Загрузка или скачивание из ведра. Некоторые допустимые варианты: "download", "upload" | |
| auth_kind строка / обязательный |
| Тип используемых учетных данных. |
| bucket строка | Название ведра. | |
| dest путь | Место назначения файла (может быть локальным или облачным в зависимости от действия). | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это следует устанавливать только если вы знаете что делаете. Это только изменяет строку User Agent для всех запросов к API. | |
| overwrite булево |
| «Перезаписать файл в ведре/на локальной машине. Если overwrite равен false и есть различие между GCS и локальной машиной, модуль завершится с ошибкой». |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список | Массив используемых областей. | |
| service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы, либо в виде словаря, либо как JSON-строка, представляющая его. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | |
| service_account_file путь | Путь к JSON-файлу учетной записи службы, если в качестве типа выбран serviceaccount. | |
| src путь | Расположение источника файла (может быть локальным или облачным в зависимости от действия). | |
| state строка |
| Существует ли данный объект в GCP. |
Примечания
Примечание
- для аутентификации можно установить service_account_file с использованием переменной среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents с использованием переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- Для аутентификации можно установить service_account_email с использованием переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind с использованием переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с использованием переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключают друг друга.
Примеры
- name: create a object
gcp_storage_object:
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 равен false и есть различие между GCS и локальной машиной, модуль завершится с ошибкой». |
| src строка | success | Расположение источника файла (может быть локальным или облачным в зависимости от действия). |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/gcp_storage_object_module.html
