google.cloud.gcp_filestore_instance – Создаёт экземпляр GCP Filestore

Примечание

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

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

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

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

Обзор

Экземпляр Google Cloud Filestore.

Требования

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

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно		Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
description строка			Описание экземпляра.
env_type строка			Указывает, в какой среде Ansible выполняется данный модуль. Не следует устанавливать, если вы не знаете, что делаете. Изменяет только строку User Agent для всех запросов к API.
file_shares список / элементы=словарь / обязательно			Файловые системы на экземпляре. Для этой версии поддерживается только одна файловая система.
	capacity_gb целое число / обязательно		Ёмкость файловой системы в Гигабайтах. Должно быть не менее 1024 ГБ для стандартного уровня или 2560 ГБ для премиум-уровня.
	name строка / обязательно		Название файловой системы (не более 16 символов).
labels словарь			Метки ресурса для представления пользовательских метаданных.
name строка / обязательно			Имя ресурса экземпляра.
networks список / элементы=словарь / обязательно			Сети VPC, к которым подключен экземпляр. Для этой версии поддерживается только одна сеть.
	modes список / элементы=строка / обязательно		Версии IP, для которых экземпляру назначены IP-адреса.
	network строка / обязательно		Имя сети GCE VPC, к которой подключен экземпляр.
	reserved_ip_range строка		Блок CIDR /29, определяющий диапазон IP-адресов, зарезервированных для этого экземпляра.
project строка			Проект Google Cloud Platform, который следует использовать.
scopes список / элементы=строка			Массив используемых областей.
service_account_contents jsonarg			Содержимое файла Service Account в формате JSON, либо в виде словаря, либо в виде JSON-строки, его представляющей.
service_account_email строка			Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь			Путь к файлу учетной записи сервиса в формате JSON, если в качестве типа выбран serviceaccount.
state строка		Варианты: present ← absent	Нужно ли создать данный объект в GCP
tier строка / обязательно			Уровень сервиса экземпляра. Некоторые допустимые варианты: "TIER_UNSPECIFIED", "STANDARD", "PREMIUM", "BASIC_HDD", "BASIC_SSD", "HIGH_SCALE_SSD"
zone строка / обязательно			Имя зоны Filestore экземпляра.

Примечания

Примечание

Ссылка на API: https://cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.instances/create
Официальная документация: https://cloud.google.com/filestore/docs/creating-instances
Использование с Kubernetes: https://cloud.google.com/filestore/docs/accessing-fileshares
Копирование данных В/Из: https://cloud.google.com/filestore/docs/copying-data
для аутентификации можно установить 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.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a instance
  google.cloud.gcp_filestore_instance:
    name: test_object
    zone: us-central1-b
    tier: PREMIUM
    file_shares:
    - capacity_gb: 2660
      name: share1
    networks:
    - network: default
      modes:
      - MODE_IPV4
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ		Возвращаемое значение	Описание
createTime строка		успех	Дата и время создания в формате RFC3339.
description строка		успех	Описание экземпляра.
etag строка		успех	Установленный сервером ETag для ресурса экземпляра, чтобы предотвратить одновременные обновления, перезаписывающие друг друга.
fileShares сложный тип		успех	Файловые системы на экземпляре. Для этой версии поддерживается только одна файловая система.
	capacityGb целое число	успех	Ёмкость файловой системы в Гигабайтах. Должно быть не менее 1024 ГБ для стандартного уровня или 2560 ГБ для премиум-уровня.
	name строка	успех	Название файловой системы (не более 16 символов).
labels словарь		успех	Метки ресурса для представления пользовательских метаданных.
name строка		успех	Имя ресурса экземпляра.
networks сложный тип		успех	Сети VPC, к которым подключен экземпляр. Для этой версии поддерживается только одна сеть.
	ipAddresses список / элементы=строка	успех	Список IPv4 или IPv6 адресов.
	modes список / элементы=строка	успех	Версии IP, для которых экземпляру назначены IP-адреса.
	network строка	успех	Имя сети GCE VPC, к которой подключен экземпляр.
	reservedIpRange строка	успех	Блок CIDR /29, определяющий диапазон IP-адресов, зарезервированных для этого экземпляра.
tier строка		успех	Уровень сервиса экземпляра.
zone строка		успех	Имя зоны Filestore экземпляра.

Авторы

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.10/collections/google/cloud/gcp_filestore_instance_module.html