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 bool |
| Для удаления экземпляра этот аргумент должен существовать и быть истинным (наряду с тем, что состояние равно отсутствующему). |
| 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 | Всегда | Состояние экземпляра или базы данных. Значение будет либо 'отсутствует', либо 'наличие'. Пример: наличие |
| updated bool | При наступлении обновления. | Поле булевого типа, указывающее, что произошло обновление. Пример: True |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. в здесь.
Автор
- 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.6/modules/gcspanner_module.html
