google.cloud.gcp_spanner_database – Создаёт базу данных GCP
Примечание
Этот плагин является частью коллекции google.cloud (версия 1.0.1).
Для его установки используйте: 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
строка / обязательно
|
|
Тип используемых учетных данных.
|
|
env_type
строка
|
Указывает, в какой среде Ansible выполняется этот модуль.
Не устанавливайте это значение, если вы не знаете, что делаете.
Это изменяет только строку User Agent для любых запросов к API.
|
|
|
extra_statements
список / элементы=строка
|
Необязательный список DDL-команд для выполнения внутри вновь созданной базы данных. Команды могут создавать таблицы, индексы и т. д. Эти команды выполняются атомарно при создании базы данных: если произойдет ошибка в любой команде, база данных не будет создана.
|
|
|
instance
словарь / обязательно
|
Экземпляр, на котором нужно создать базу данных.
Это поле представляет ссылку на ресурс 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
строка
|
|
Нужно ли создать указанный объект в 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_spanner_database_module.html
