gcp_spanner_instance – Создаёт экземпляр GCP

Новая версия с 2.7.

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

Обзор

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
config строка / обязательно		Имя конфигурации экземпляра (похоже, но не совсем то же, что регион), определяющее географическое расположение и репликацию баз данных в данном экземпляре. Определяет место хранения данных. Значения обычно имеют вид `regional-europe-west1` , `us-central` и т. д. Для получения корректного списка обратитесь к [разделу Конфигурация документации](https://cloud.google.com/spanner/docs/instances).
display_name строка / обязательно		Описание названия экземпляра, отображаемого в пользовательских интерфейсах. Должно быть уникальным для проекта и иметь длину от 4 до 30 символов.
env_type строка		Указывает, в какой среде Ansible вы выполняете этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
labels словарь		Объект, содержащий список пар «ключ»: «значение». Пример: { "name": "гаечный ключ", "масса": "1,3кг", "количество": "3" }.
name строка / обязательно		Уникальный идентификатор экземпляра, который нельзя изменить после создания экземпляра. Длина имени должна составлять от 6 до 30 символов.
node_count целое число	Значение по умолчанию: "1"	Количество узлов, выделенных для этого экземпляра.
project строка		Проект Google Cloud Platform для использования.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, его представляющая.
service_account_email строка		Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state строка	Варианты: present ← absent	Необходимо ли наличие данного объекта в GCP.

Примечания

Примечание

Ссылка на API: https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instances
Официальная документация: https://cloud.google.com/spanner/
для аутентификации можно задать service_account_file с помощью переменной среды c(gcp_service_account_file).
для аутентификации можно задать service_account_contents с помощью переменной среды c(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: create a instance
  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 строка	успех	Имя конфигурации экземпляра (похоже, но не совсем то же, что регион), определяющее географическое расположение и репликацию баз данных в данном экземпляре. Определяет место хранения данных. Значения обычно имеют вид `regional-europe-west1` , `us-central` и т. д. Для получения корректного списка обратитесь к [разделу Конфигурация документации](https://cloud.google.com/spanner/docs/instances).
displayName строка	успех	Описание названия экземпляра, отображаемого в пользовательских интерфейсах. Должно быть уникальным для проекта и иметь длину от 4 до 30 символов.
labels словарь	успех	Объект, содержащий список пар «ключ»: «значение». Пример: { "name": "гаечный ключ", "масса": "1,3кг", "количество": "3" }.
name строка	успех	Уникальный идентификатор экземпляра, который нельзя изменить после создания экземпляра. Длина имени должна составлять от 6 до 30 символов.
nodeCount целое число	успех	Количество узлов, выделенных для этого экземпляра.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/gcp_spanner_instance_module.html