gcspanner - Создание и удаление экземпляров/баз данных в Spanner.
Новая версия 2.3.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Создание и удаление экземпляров/баз данных в Spanner. См. https://cloud.google.com/spanner/docs для обзора.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- google-auth >= 0.5.0
- google-cloud-spanner >= 0.23.0
Параметры
| параметр | обязательный | значение по умолчанию | варианты | примечания |
|---|---|---|---|---|
| конфигурация | да | Конфигурация экземпляра, которую нужно использовать. Примеры: us-central1, asia-east1 и europe-west1. | ||
| имя_базы_данных | нет | Имя базы данных, содержащейся в экземпляре. | ||
| force_instance_delete | нет | Для удаления экземпляра этот аргумент должен существовать и быть истинным (наряду с тем, что состояние равно отсутствующему). | ||
| отображаемое_имя_экземпляра | нет | Имя отображаемого экземпляра. Если не указано, используется instance_id. | ||
| имя_экземпляра | да | Имя экземпляра GCP spanner. | ||
| количество_узлов | нет | Количество узлов в экземпляре. Если не указано при создании экземпляра, количество узлов будет установлено в 1. | ||
| состояние | нет | присутствует | Состояние экземпляра или базы данных (absent, present). Применяется к наиболее мелкому ресурсу. Если указано имя базы данных, оно удаляется. Если указано только имя экземпляра, оно удаляется. |
Примеры
# Create instance.
gcspanner:
instance_id: "{{ instance_id }}"
configuration: "{{ configuration }}"
state: present
node_count: 1
# Create database.
gcspanner:
instance_id: "{{ instance_id }}"
configuration: "{{ configuration }}"
database_name: "{{ database_name }}"
state: present
# Delete instance (and all databases)
gcspanner:
instance_id: "{{ instance_id }}"
configuration: "{{ configuration }}"
state: absent
force_instance_delete: yes
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие являются полями, уникальными для этого модуля:
| имя | описание | возвращаемое | тип | пример |
|---|---|---|---|---|
| имя_базы_данных | Имя базы данных. | При указании имени базы данных | str | mydatabase |
| имя_экземпляра | Имя экземпляра. | Всегда | str | myinstance |
| previous_values | Список словарей, содержащих предыдущие значения до обновления. | При обновлении экземпляра и изменении поля. | dict | 'previous_values': { 'экземпляр': { 'отображаемое_имя_экземпляра': 'my-instance', 'количество_узлов': 1 } } |
| состояние | Состояние экземпляра или базы данных. Значение будет либо 'absent', либо 'present'. | Всегда | str | present |
| обновлено | Поле булевого типа для обозначения того, произошло ли обновление. | При обновлении. | bool | True |
Примечания
Примечание
- Изменение конфигурации существующего экземпляра не поддерживается.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вам это интересно, пожалуйста, прочтите Информацию о сообществе и содействие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/gcspanner_module.html
