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

Примечание

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

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

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

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

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

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

Изолированный набор ресурсов Cloud Spanner, на котором можно размещать базы данных.

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
config string / обязательный	Название конфигурации экземпляра (похожа на регион, но не совсем то же самое), определяющей географическое размещение и репликацию баз данных в этом экземпляре. Она определяет, где хранятся ваши данные. Обычно значения имеют вид `regional-europe-west1`, `us-central` и т. д. Чтобы получить допустимый список, обратитесь к [разделу Configuration документации](https://cloud.google.com/spanner/docs/instances).
display_name string / обязательный	Понятное имя экземпляра, отображаемое в пользовательских интерфейсах. Должно быть уникальным в пределах проекта и содержать от 4 до 30 символов.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он влияет только на строку User Agent в запросах к API.
labels dictionary	Объект со списком пар «ключ»: значение. Пример: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
name string / обязательный	Уникальный идентификатор экземпляра, который нельзя изменить после его создания. Имя должно содержать от 6 до 30 символов.
node_count integer	Количество узлов, выделенных этому экземпляру. В Terraform можно указать не более одного из параметров node_count и processing_units. .
processing_units integer	Количество вычислительных единиц, выделенных этому экземпляру. В Terraform можно указать не более одного из параметров processing_units и node_count. .
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"`

Примечания

Примечание

Справочник API: https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instances
Официальная документация: https://cloud.google.com/spanner/
для аутентификации можно задать 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_spanner_instance:
    name: testinstance
    display_name: My Spanner Instance
    node_count: 2
    labels:
      cost_center: ti-1700004
    config: regional-us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Описание
config string	Название конфигурации экземпляра (похожа на регион, но не совсем то же самое), определяющей географическое размещение и репликацию баз данных в этом экземпляре. Она определяет, где хранятся ваши данные. Обычно значения имеют вид `regional-europe-west1`, `us-central` и т. д. Чтобы получить допустимый список, обратитесь к [разделу Configuration документации](https://cloud.google.com/spanner/docs/instances). Возвращается: при успешном выполнении
displayName string	Понятное имя экземпляра, отображаемое в пользовательских интерфейсах. Должно быть уникальным в пределах проекта и содержать от 4 до 30 символов. Возвращается: при успешном выполнении
labels dictionary	Объект со списком пар «ключ»: значение. Пример: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }. Возвращается: при успешном выполнении
name string	Уникальный идентификатор экземпляра, который нельзя изменить после его создания. Имя должно содержать от 6 до 30 символов. Возвращается: при успешном выполнении
nodeCount integer	Количество узлов, выделенных этому экземпляру. В Terraform можно указать не более одного из параметров node_count и processing_units. . Возвращается: при успешном выполнении
processingUnits integer	Количество вычислительных единиц, выделенных этому экземпляру. В Terraform можно указать не более одного из параметров processing_units и node_count. . Возвращается: при успешном выполнении

Авторы

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