gcp_cloudfunctions_cloud_function_info – Сбор информации о GCP CloudFunction

Новая версия 2.9.

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

Обзор

Сбор информации о GCP CloudFunction

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
location строка / обязательно		Расположение этой функции облака.
project строка		Проект Google Cloud Platform для использования.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка		Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбрано serviceaccount.

Примечания

Примечание

для аутентификации можно установить 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.
значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
варианты service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a cloud function
  gcp_cloudfunctions_cloud_function_info:
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ			Возвращаемое значение	Описание
resources complex			всегда	Список ресурсов
	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.
	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.
	versionId string		успех	Идентификатор версии функции Cloud. Каждая попытка развертывания приводит к созданию новой версии функции.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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_cloudfunctions_cloud_function_info_module.html