gcp_spanner_database – Создание базы данных GCP

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

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

Описание

База данных Cloud Spanner, размещенная на экземпляре Spanner.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется данный модуль. Не следует устанавливать, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API.
extra_statements список		Необязательный список DDL-команд для выполнения внутри вновь созданной базы данных. Команды могут создавать таблицы, индексы и т. д. Эти команды выполняются атомарно с созданием базы данных: если в какой-либо команде произойдет ошибка, база данных не создается.
instance словарь / обязательно		Экземпляр, на котором создается база данных. Это поле представляет ссылку на ресурс экземпляра в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'name' и значением имени вашего ресурса. Во-вторых, вы можете добавить `register: name-of-resource` к задаче gcp_spanner_instance и затем установить это поле instance в "{{ name-of-resource }}"
name строка / обязательно		Уникальный идентификатор базы данных, который нельзя изменить после создания экземпляра. Значения имеют вид [a-z][-a-z0-9]*[a-z0-9].
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.databases
Официальная документация: 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.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a instance
  gcp_spanner_instance:
    name: instance-database
    display_name: My Spanner Instance
    node_count: 2
    labels:
      cost_center: ti-1700004
    config: regional-us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instance

- name: create a database
  gcp_spanner_database:
    name: webstore
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Возвращаемое значение	Описание
extraStatements список	успех	Необязательный список DDL-команд для выполнения внутри вновь созданной базы данных. Команды могут создавать таблицы, индексы и т. д. Эти команды выполняются атомарно с созданием базы данных: если в какой-либо команде произойдет ошибка, база данных не создается.
instance словарь	успех	Экземпляр, на котором создается база данных.
name строка	успех	Уникальный идентификатор базы данных, который нельзя изменить после создания экземпляра. Значения имеют вид [a-z][-a-z0-9]*[a-z0-9].

Статус

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

Авторы

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