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

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.2).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_cloudfunctions_cloud_function_info.

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

Обзор

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

Авторы

Google Inc. (@googlecloudplatform)

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