community.general.gcspanner – Создание и удаление экземпляров/баз данных в Spanner

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.gcspanner.

УСТАРЕВШЕ
Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕВШЕ

Удалено в: версии 2.0.0
Почему: Выпущены обновленные модули с расширенными возможностями
Альтернатива: Используйте google.cloud.gcp_spanner_database и/или google.cloud.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.
credentials_file строка		Путь к JSON-файлу, связанному с адресом электронной почты учетной записи службы.
database_name строка		Имя базы данных, содержащейся в экземпляре.
force_instance_delete логическое	Варианты: нет ← да	Для удаления экземпляра этот аргумент должен существовать и быть истинным (наряду с состоянием, равным отсутствию).
instance_display_name строка		Имя отображаемого экземпляра. Если не указано, используется instance_id.
instance_id строка / обязательный		Имя экземпляра GCP spanner.
node_count целое число	По умолчанию: 1	Количество узлов в экземпляре.
project_id строка		Ваш идентификатор проекта GCE.
service_account_email строка		Адрес электронной почты учетной записи службы.
state строка	Варианты: отсутствует присутствует ←	Состояние экземпляра или базы данных. Применяется к наиболее мелкому ресурсу. Если указан `database_name`, он удаляется. Если указан только `instance_id`, удаляется именно он.

Примечания

Примечание

Изменение конфигурации существующего экземпляра не поддерживается.

Примеры

- name: Create instance
  community.general.gcspanner:
    instance_id: '{{ instance_id }}'
    configuration: '{{ configuration }}'
    state: present
    node_count: 1

- name: Create database
  community.general.gcspanner:
    instance_id: '{{ instance_id }}'
    configuration: '{{ configuration }}'
    database_name: '{{ database_name }}'
    state: present

- name: Delete instance (and all databases)
- community.general.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': 'my-instance', 'node_count': 1 } }
state строка	Всегда	Состояние экземпляра или базы данных. Значение будет либо 'отсутствует', либо 'присутствует'. Пример: присутствует
updated логическое	При обновлении.	Логическое поле, обозначающее, что произошло обновление. Пример: True

Статус

Этот модуль будет удален в версии 2.0.0. [устарел]
Для получения дополнительной информации см. УСТАРЕВШЕ.

Авторы

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.10/collections/community/general/gcspanner_module.html