gcspanner – Создание и удаление экземпляров/баз данных в Spanner
УСТАРЕЛО
| Удалино в Ansible: | |
|---|---|
| версия: 2.12 | |
| Почему: | Обновленные модули выпущены с повышенной функциональностью |
| Альтернатива: | Используйте gcp_spanner_database и/или gcp_spanner_instance вместо этого. |
Описание
- Создание и удаление экземпляров/баз данных в 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 boolean |
| Для удаления экземпляра этот аргумент должен существовать и быть истинным (наряду с состоянием, равным отсутствующему). |
| 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 строка | При указании имени базы данных | Имя базы данных. Пример: mydatabase |
| instance_id строка | Всегда | Имя экземпляра. Пример: myinstance |
| previous_values словарь | При обновлении экземпляра и изменении поля. | Список словарей, содержащих предыдущие значения до обновления. Пример: 'previous_values': { 'instance': { 'instance_display_name': 'мой-экземпляр', 'node_count': 1 } } |
| state строка | Всегда | Состояние экземпляра или базы данных. Значение будет либо 'отсутствует', либо 'присутствует'. Пример: присутствует |
| updated boolean | При обновлении. | Поле boolean, указывающее, произошло ли обновление. Пример: True |
Статус
- Этот модуль будет удален в версии 2.12. [устарело]
- Дополнительная информация приведена в разделе УСТАРЕЛО.
Авторы
- 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.9/modules/gcspanner_module.html
