google.cloud.gcp_spanner_database – Создаёт базу данных GCP

Примечание

Этот плагин является частью коллекции google.cloud (версия 1.0.2).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_spanner_database.

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

Описание

База данных 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: имя-ресурса` в задачу gcp_spanner_instance и затем установить это поле instance в "{{ имя-ресурса }}"
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 с помощью переменной среды gcp_service_account_file.
для аутентификации можно установить service_account_contents с помощью переменной среды 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
  google.cloud.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
  google.cloud.gcp_spanner_database:
    name: webstore
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

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

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_spanner_database_module.html