gcp_spanner_database – Создаёт базу данных GCP
Новая в версии 2.7.
Обзор
- База данных Cloud Spanner, размещённая на экземпляре Spanner.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| 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 строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка с точным содержимым файла 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_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: 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.8/modules/gcp_spanner_database_module.html