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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 строка	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
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	Содержимое JSON-файла учетной записи службы, представленное либо в виде словаря, либо в виде JSON-строки.
service_account_email строка	Необязательный адрес электронной почты учетной записи службы, если выбран параметр machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON-учетной записи службы, если тип выбран как serviceaccount.
state строка	Определяет, должен ли заданный объект существовать в GCP. Варианты: `"present"` ← (по умолчанию) `"absent"`
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/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 строка	Маркер создания в формате RFC3339. Возвращаемое значение: успех
description строка	Описание экземпляра. Возвращаемое значение: успех
etag строка	Указанный сервером ETag для ресурса экземпляра, чтобы предотвратить одновременные обновления, перезаписывающие друг друга. Возвращаемое значение: успех
fileShares сложный тип	Обмен файлами на экземпляре. Для этой версии поддерживается только один файловый обмен. Возвращаемое значение: успех
capacityGb целое число	Емкость файлового обмена в GiB. Она должна быть не менее 1024 GiB для стандартного уровня или 2560 GiB для премиум-уровня. Возвращаемое значение: успех
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_filestore_instance_module.html