Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_cloudfunctions_cloud_function — создание Cloud Function в GCP

Примечание

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

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

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

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

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

Краткое описание

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

Требования

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если выбран тип учетных данных accesstoken.

auth_kind

string / обязательный

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

available_memory_mb

integer

Объем памяти в МБ, доступный для функции.

description

string

Описание функции, заданное пользователем.

entry_point

string

Имя функции (как оно определено в исходном коде), которая будет выполнена.

Если параметр не задан, по умолчанию используется суффикс имени ресурса. Для обратной совместимости, если функция с указанным именем не найдена, система попытается использовать функцию с именем “function”. Для Node.js это имя функции, экспортированной модулем, указанным в source_location.

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте этот параметр, если не уверены в его назначении.

Он изменяет только строку User Agent для любых запросов к API.

environment_variables

dictionary

Переменные среды, доступные во время выполнения функции.

event_trigger

dictionary

Источник типа конечной точки HTTPS, запуск которого может выполняться по URL.

event_type

string / обязательный

Тип отслеживаемого события. Например: `providers/cloud.storage/eventTypes/object.change` и `providers/cloud.pubsub/eventTypes/topic.publish`.

resource

string / обязательный

Ресурс или ресурсы, для которых отслеживаются события, например `projects/_/buckets/myBucket.` .

service

string

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

https_trigger

dictionary

Источник типа конечной точки HTTPS, запуск которого может выполняться по URL.

labels

dictionary

Набор пар «ключ/значение» меток, связанных с этой Cloud Function.

location

string / обязательный

Расположение этой облачной функции.

name

string / обязательный

Имя функции, заданное пользователем. Имена функций должны быть уникальными во всем мире и соответствовать шаблону `projects/*/locations/*/functions/*`.

project

string

Проект Google Cloud Platform, который следует использовать.

runtime

string

Среда выполнения, в которой будет выполняться функция. Обязательна при развертывании новой функции и необязательна при обновлении существующей.

scopes

list / элементы=string

Массив областей действия, которые будут использоваться

service_account_contents

jsonarg

Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей этот файл.

service_account_email

string

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

service_account_file

path

Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.

source_archive_url

string

URL Google Cloud Storage, начинающийся с gs:// и указывающий на ZIP-архив, содержащий функцию.

source_repository

dictionary

Исходный репозиторий, в котором размещена функция.

url

string / обязательный

URL размещенного репозитория, в котором определена функция.

source_upload_url

string

Подписанный URL Google Cloud Storage, используемый для загрузки исходного кода.

state

string

Должен ли указанный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

string

Время ожидания выполнения функции. Если по истечении этого времени выполнение функции не завершено, оно считается неудачным и может быть остановлено. По умолчанию — 60 секунд.

trigger_http

boolean

Использовать 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

integer

Объем памяти в МБ, доступный для функции.

Возвращается: при успехе

description

string

Описание функции, заданное пользователем.

Возвращается: при успехе

entryPoint

string

Имя функции (как оно определено в исходном коде), которая будет выполнена.

Если параметр не задан, по умолчанию используется суффикс имени ресурса. Для обратной совместимости, если функция с указанным именем не найдена, система попытается использовать функцию с именем “function”. Для Node.js это имя функции, экспортированной модулем, указанным в source_location.

Возвращается: при успехе

environmentVariables

dictionary

Переменные среды, доступные во время выполнения функции.

Возвращается: при успехе

eventTrigger

complex

Источник типа конечной точки HTTPS, запуск которого может выполняться по URL.

Возвращается: при успехе

eventType

string

Тип отслеживаемого события. Например: `providers/cloud.storage/eventTypes/object.change` и `providers/cloud.pubsub/eventTypes/topic.publish`.

Возвращается: при успехе

resource

string

Ресурс или ресурсы, для которых отслеживаются события, например `projects/_/buckets/myBucket.` .

Возвращается: при успехе

service

string

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

Возвращается: при успехе

httpsTrigger

complex

Источник типа конечной точки HTTPS, запуск которого может выполняться по URL.

Возвращается: при успехе

url

string

URL развернутой функции.

Возвращается: при успехе

labels

dictionary

Набор пар «ключ/значение» меток, связанных с этой Cloud Function.

Возвращается: при успехе

location

string

Расположение этой облачной функции.

Возвращается: при успехе

name

string

Имя функции, заданное пользователем. Имена функций должны быть уникальными во всем мире и соответствовать шаблону `projects/*/locations/*/functions/*`.

Возвращается: при успехе

runtime

string

Среда выполнения, в которой будет работать функция. Если значение не задано, по умолчанию используется Node.js 6.

Возвращается: при успехе

serviceAccountEmail

string

Адрес электронной почты учетной записи службы для этой функции.

Возвращается: при успехе

sourceArchiveUrl

string

URL Google Cloud Storage, начинающийся с gs:// и указывающий на ZIP-архив, содержащий функцию.

Возвращается: при успехе

sourceRepository

complex

Исходный репозиторий, в котором размещена функция.

Возвращается: при успехе

deployedUrl

string

URL размещенного репозитория, в котором была определена функция на момент развертывания.

Возвращается: при успехе

url

string

URL размещенного репозитория, в котором определена функция.

Возвращается: при успехе

sourceUploadUrl

string

Подписанный URL Google Cloud Storage, используемый для загрузки исходного кода.

Возвращается: при успехе

status

string

Состояние развертывания функции.

Возвращается: при успехе

timeout

string

Время ожидания выполнения функции. Если по истечении этого времени выполнение функции не завершено, оно считается неудачным и может быть остановлено. По умолчанию — 60 секунд.

Возвращается: при успехе

trigger_http

boolean

Использовать HTTP для запуска этой функции.

Возвращается: при успехе

updateTime

string

Время последнего обновления Cloud Function.

Возвращается: при успехе

versionId

string

Идентификатор версии Cloud Function. При каждой попытке развертывания создается новая версия функции.

Возвращается: при успехе

Авторы

  • Google Inc. (@googlecloudplatform)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API