Модуль google.cloud.gcp_filestore_instance — создание экземпляра GCP

Примечание

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если используется тип учетных данных accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description string	Описание экземпляра.
env_type string	Указывает среду Ansible, в которой выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это влияет только на строку User Agent для API-запросов.
file_shares list / elements=dictionary / обязательный	Общие файловые ресурсы экземпляра. В этой версии поддерживается только один общий файловый ресурс.
capacity_gb integer / обязательный	Емкость общего файлового ресурса в ГиБ. Для уровня standard она должна составлять не менее 1024 ГиБ, а для уровня premium — не менее 2560 ГиБ.
name string / обязательный	Имя общего файлового ресурса (не более 16 символов).
labels dictionary	Метки ресурса для представления метаданных, предоставленных пользователем.
name string / обязательный	Имя ресурса экземпляра.
networks list / elements=dictionary / обязательный	Сети VPC, к которым подключен экземпляр. В этой версии поддерживается только одна сеть.
modes list / elements=string / обязательный	Версии IP, для которых экземпляру назначены IP-адреса.
network string / обязательный	Имя сети GCE VPC, к которой подключен экземпляр.
reserved_ip_range string	Блок CIDR /29, определяющий диапазон IP-адресов, зарезервированных для этого экземпляра.
project string	Проект Google Cloud Platform, который следует использовать.
scopes list / elements=string	Массив используемых областей доступа
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей это содержимое.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
tier string / обязательный	Уровень обслуживания экземпляра. Допустимые варианты: «TIER_UNSPECIFIED», «STANDARD», «PREMIUM», «BASIC_HDD», «BASIC_SSD», «HIGH_SCALE_SSD»
zone string / обязательный	Имя зоны 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/csi-driver
Копирование данных: 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.
Для аутентификации можно задать access_token с помощью переменной среды GCP_ACCESS_TOKEN.
Для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
Параметры 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 string	Временная метка создания в текстовом формате RFC3339. Возвращается: при успехе
description string	Описание экземпляра. Возвращается: при успехе
etag string	Заданный сервером ETag ресурса экземпляра, предотвращающий перезапись одновременных обновлений друг другом. Возвращается: при успехе
fileShares complex	Общие файловые ресурсы экземпляра. В этой версии поддерживается только один общий файловый ресурс. Возвращается: при успехе
capacityGb integer	Емкость общего файлового ресурса в ГиБ. Для уровня standard она должна составлять не менее 1024 ГиБ, а для уровня premium — не менее 2560 ГиБ. Возвращается: при успехе
name string	Имя общего файлового ресурса (не более 16 символов). Возвращается: при успехе
labels dictionary	Метки ресурса для представления метаданных, предоставленных пользователем. Возвращается: при успехе
name string	Имя ресурса экземпляра. Возвращается: при успехе
networks complex	Сети VPC, к которым подключен экземпляр. В этой версии поддерживается только одна сеть. Возвращается: при успехе
ipAddresses list / elements=string	Список адресов IPv4 или IPv6. Возвращается: при успехе
modes list / elements=string	Версии IP, для которых экземпляру назначены IP-адреса. Возвращается: при успехе
network string	Имя сети GCE VPC, к которой подключен экземпляр. Возвращается: при успехе
reservedIpRange string	Блок CIDR /29, определяющий диапазон IP-адресов, зарезервированных для этого экземпляра. Возвращается: при успехе
tier string	Уровень обслуживания экземпляра. Возвращается: при успехе
zone string	Имя зоны Filestore экземпляра. Возвращается: при успехе

Авторы

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_filestore_instance_module.html