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
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| configuration обязательно | Конфигурация экземпляра. Примеры: us-central1, asia-east1 и europe-west1. | |
| database_name | Имя базы данных, содержащейся в экземпляре. | |
| force_instance_delete |
| Для удаления экземпляра этот аргумент должен существовать и быть истинным (наряду с тем, что состояние равно отсутствующему). |
| instance_display_name | Имя отображаемого экземпляра. Если не указано, вместо него будет использоваться instance_id. | |
| instance_id обязательно | Имя экземпляра GCP spanner. | |
| node_count | Значение по умолчанию: 1 | Количество узлов в экземпляре. |
| state |
| Состояние экземпляра или базы данных. Применяется к самому мелкому ресурсу. Если указан database_name, мы его удалим.Если указан только instance_id, именно он будет удален. |
Примечания
Примечание
- Изменение конфигурации существующего экземпляра не поддерживается.
Примеры
- name: Create instance
gcspanner:
instance_id: '{{ instance_id }}'
configuration: '{{ configuration }}'
state: present
node_count: 1
- name: Create database
gcspanner:
instance_id: '{{ instance_id }}'
configuration: '{{ configuration }}'
database_name: '{{ database_name }}'
state: present
- name: Delete instance (and all databases)
- gcspanner:
instance_id: '{{ instance_id }}'
configuration: '{{ configuration }}'
state: absent
force_instance_delete: yes
Значения возврата
Общие значения возврата документированы здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| database_name str | При указании имени базы данных | Имя базы данных. Пример: mydatabase |
| instance_id str | Всегда | Имя экземпляра. Пример: myinstance |
| previous_values dict | При обновлении экземпляра и изменении поля. | Список словарей, содержащих предыдущие значения до обновления. Пример: 'previous_values': { 'instance': { 'instance_display_name': 'my-instance', 'node_count': 1 } } |
| state str | Всегда | Состояние экземпляра или базы данных. Значение будет либо 'absent', либо 'present'. Пример: present |
| updated bool | При возникновении обновления. | Логическое поле, указывающее на то, что произошло обновление. Пример: True |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.
Автор
- Tom Melendez (@supertom) <tom@supertom.com>
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/gcspanner_module.html
