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 символов.
labels -		Объект, содержащий список пар «ключ»: значение. Пример: { "name": "гаечный ключ", "масса": "1.3кг", "количество": "3" }.
name - / обязательно		Уникальный идентификатор экземпляра, который нельзя изменить после создания экземпляра. Длина имени должна быть от 6 до 30 символов.
node_count -	Значение по умолчанию: "1"	Количество узлов, выделенных для этого экземпляра.
project строка		Проект Google Cloud Platform, который будет использоваться.
scopes список		Массив используемых областей.
service_account_contents строка		Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка, содержащая точное содержимое файла 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 с помощью переменной окружения GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно установить service_account_email с помощью переменной окружения GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить service_account_contents с помощью переменной окружения GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно установить 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 строка	success	Имя конфигурации экземпляра (похожее, но не совсем то же самое, что регион), определяющее географическое расположение и репликацию баз данных в этом экземпляре. Определяет, где хранятся ваши данные. Значения обычно имеют вид `regional-europe-west1`, `us-central` и т. д. Для получения списка допустимых значений, пожалуйста, обратитесь к разделу [Конфигурация в документации](https://cloud.google.com/spanner/docs/instances.)
displayName строка	success	Дескриптивное имя этого экземпляра, которое отображается в пользовательских интерфейсах. Должно быть уникальным для проекта и иметь длину от 4 до 30 символов.
labels словарь	success	Объект, содержащий список пар "ключ": значение. Пример: { "name": "ключ", "mass": "1.3кг", "count": "3" }.
name строка	success	Уникальный идентификатор экземпляра, который нельзя изменить после создания экземпляра. Длина имени должна быть от 6 до 30 символов.
nodeCount целое число	success	Количество узлов, выделенных для данного экземпляра.

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.8/modules/gcp_spanner_instance_module.html