google.cloud.gcp_cloudfunctions_cloud_function модуль – Создаёт GCP CloudFunction

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля потребуются дополнительные требования, см. Требования для подробностей.

Чтобы использовать его в playbook, укажите: google.cloud.gcp_cloudfunctions_cloud_function.

Описание
Требования
Параметры
Примеры
Возвращаемые значения

Описание

Функция Cloud Function, которая содержит пользовательские вычисления, выполняемые в ответ на событие.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
available_memory_mb целое число	Объем памяти в МБ, доступный для функции.
description строка	Описание функции, предоставленное пользователем.
entry_point строка	Имя функции (как определено в исходном коде), которая будет выполнена. По умолчанию совпадает с суффиксом имени ресурса, если не указано иное. Для обратной совместимости, если функция с данным именем не найдена, система попытается использовать функцию с именем «function». Для Node.js это имя функции, экспортированной модулем, указанным в source_location.
env_type строка	Указывает, в какой среде Ansible вы запустили этот модуль. Это поле не должно устанавливаться, если вам это не нужно. Это поле изменяет только строку User Agent для любых запросов к API.
environment_variables словарь	Переменные среды, которые должны быть доступны во время выполнения функции.
event_trigger словарь	Источник типа HTTPS-точка входа, который можно запустить через URL.
event_type строка / обязательно	Тип события для наблюдения. Например: `providers/cloud.storage/eventTypes/object.change` и `providers/cloud.pubsub/eventTypes/topic.publish`.
resource строка / обязательно	Ресурс(ы) для наблюдения событий, например, `projects/_/buckets/myBucket.` .
service строка	Имя хоста сервиса, за которым должно вестись наблюдение.
https_trigger словарь	Источник типа HTTPS-точка входа, который можно запустить через URL.
labels словарь	Набор пар ключ/значение меток, связанных с этой функцией Cloud Function.
location строка / обязательно	Расположение этой функции облачной функции.
name строка / обязательно	Определяемое пользователем имя функции. Имена функций должны быть уникальными по всему проекту и соответствовать шаблону `projects//locations//functions/*`.
project строка	Проект Google Cloud Platform, который нужно использовать.
runtime строка	Средства выполнения функции. Требуется при развертывании новой функции, необязательно при обновлении существующей.
scopes список / элементы=строка	Массив используемых областей
service_account_contents jsonarg	Содержимое файла JSON учетной записи сервиса, либо в словаре, либо как JSON-строка, которая его представляет.
service_account_email строка	Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи сервиса, если тип учетной записи serviceaccount.
source_archive_url строка	URL Google Cloud Storage, начинающийся с gs://, указывающий на zip-архив, содержащий функцию.
source_repository словарь	Репозиторий исходного кода, где размещена функция.

END_OF_DOCUMENT_MARKER

url строка / обязательно	URL, указывающий на размещённый репозиторий, где определена функция.
source_upload_url строка	Подписанный URL Google Cloud Storage, используемый для загрузки исходного кода.
state строка	Определяет, должен ли заданный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout строка	Время ожидания выполнения функции. Выполнение считается завершённым с ошибкой и может быть прервано, если функция не завершена к концу периода ожидания. По умолчанию 60 секунд.
trigger_http логический	Использовать HTTP для запуска этой функции. Варианты: `false` `true`

Примеры

- name: create a cloud function
  google.cloud.gcp_cloudfunctions_cloud_function:
    name: test_object
    location: us-central1
    entry_point: helloGET
    source_archive_url: gs://ansible-cloudfunctions-bucket/function.zip
    trigger_http: 'true'
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
availableMemoryMb целое число	Объём памяти в МБ, доступной для функции. Возвращается: success
description строка	Описание функции, предоставленное пользователем. Возвращается: success
entryPoint строка	Имя функции (как определено в исходном коде), которая будет выполнена. По умолчанию используется суффикс имени ресурса, если не указано иное. Для обратной совместимости, если функция с заданным именем не найдена, система попытается использовать функцию с именем «function». Для Node.js это имя функции, экспортируемой модулем, указанным в source_location. Возвращается: success
environmentVariables словарь	Переменные среды, которые должны быть доступны во время выполнения функции. Возвращается: success
eventTrigger сложное	Тип источника типа HTTPS-точки входа, который может быть вызван через URL. Возвращается: success
eventType строка	Тип события для наблюдения. Например: `providers/cloud.storage/eventTypes/object.change` и `providers/cloud.pubsub/eventTypes/topic.publish`. Возвращается: success
resource строка	Ресурс(ы) для наблюдения за событиями, например, `projects/_/buckets/myBucket.`. Возвращается: success
service строка	Имя хоста службы, за которой следует наблюдать. Возвращается: success
httpsTrigger сложное	Тип источника типа HTTPS-точки входа, который может быть вызван через URL. Возвращается: success
url строка	Развёрнутый URL функции. Возвращается: success
labels словарь	Набор пар ключ-значение меток, связанных с этой функцией Cloud Function. Возвращается: success
location строка	Расположение этой функции Cloud Function. Возвращается: success
name строка	Пользовательское имя функции. Имена функций должны быть уникальными по всему проекту и соответствовать шаблону `projects//locations//functions/`. Возвращается:* success
runtime строка	Средства выполнения, в которых будет выполняться функция. Если пусто, по умолчанию используется Node.js 6. Возвращается: success
serviceAccountEmail строка	Электронная почта учётной записи службы для этой функции. Возвращается: success
sourceArchiveUrl строка	URL Google Cloud Storage, начинающийся с gs://, указывающий на zip-архив, содержащий функцию. Возвращается: success
sourceRepository сложное	Репозиторий исходного кода, в котором размещена функция. Возвращается: success
deployedUrl строка	URL, указывающий на размещённый репозиторий, в котором была определена функция на момент развертывания. Возвращается: success
url строка	URL, указывающий на размещённый репозиторий, в котором определена функция. Возвращается: success
sourceUploadUrl строка	Подписанный URL Google Cloud Storage, используемый для загрузки исходного кода. Возвращается: success

статус строка	Статус развертывания функции. Возвращаемое значение: success
таймаут строка	Таймаут выполнения функции. Выполнение считается неудачным и может быть прервано, если функция не завершена к концу периода таймаута. По умолчанию составляет 60 секунд. Возвращаемое значение: success
trigger_http логическое значение	Использовать HTTP для запуска этой функции. Возвращаемое значение: success
updateTime строка	Последняя метка времени обновления функции Cloud Function. Возвращаемое значение: success
versionId строка	Идентификатор версии Cloud Function. Каждая попытка развертывания приводит к созданию новой версии функции. Возвращаемое значение: success

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_cloudfunctions_cloud_function_module.html