Spec-Zone.ru › Ansible

community.digitalocean.digital_ocean_database модуль — Создание и удаление базы данных DigitalOcean

Примечание

Этот модуль входит в коллекцию community.digitalocean (версия 1.27.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.digitalocean.

Чтобы использовать её в плейбуке, укажите: community.digitalocean.digital_ocean_database.

Новое в community.digitalocean 1.3.0

  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения

Описание

  • Создает и удаляет базу данных в DigitalOcean и, по желанию, ожидает её подключения.
  • Управляемая служба баз данных DigitalOcean упрощает создание и управление высокодоступными кластерами баз данных.
  • В настоящее время поддерживает PostgreSQL, Redis, MySQL и MongoDB.

Параметры

Параметр

Комментарии

baseurl

string

Базовый URL API DigitalOcean.

По умолчанию: "https://api.digitalocean.com/v2"

engine

string / required

Символьное обозначение используемого для кластера механизма базы данных.

Возможные значения: pg для PostgreSQL, mysql для MySQL, redis для Redis и mongodb для MongoDB.

Варианты:

  • "pg"
  • "mysql"
  • "redis"
  • "mongodb"

id

aliases: database_id

integer

Уникальный ID, который можно использовать для идентификации и ссылки на кластер базы данных.

name

string / required

Уникальное, понятное имя для кластера базы данных.

num_nodes

integer

Количество узлов в кластере базы данных.

Допустимые значения: 1, 2 или 3.

Варианты:

  • 1 ← (по умолчанию)
  • 2
  • 3

oauth_token

aliases: api_token

string

Токен OAuth DigitalOcean.

Существует несколько других переменных среды, которые можно использовать для предоставления этого значения.

Например, - DO_API_TOKEN, DO_API_KEY, DO_OAUTH_TOKEN и OAUTH_TOKEN.

private_network_uuid

string

Строка, указывающая UUID VPC, которому назначен кластер базы данных.

project_name

aliases: project

string

Проект, которому нужно назначить ресурс (имя проекта, а не UUID).

По умолчанию используется проект по умолчанию учетной записи (пустая строка).

В настоящее время поддерживается только при создании баз данных.

По умолчанию: ""

region

aliases: region_id

string / required

Символьный идентификатор региона, где расположен кластер базы данных.

size

aliases: size_id

string / required

Символьный идентификатор, представляющий размер узлов в кластере базы данных.

См. https://docs.digitalocean.com/reference/api/api-reference/#operation/create_database_cluster для поддерживаемых размеров.

state

string

Указывает желаемое состояние цели.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

list / elements=string

Массив тегов, которые были применены к кластеру базы данных.

timeout

integer

Время ожидания в секундах, используемое для опроса API DigitalOcean.

По умолчанию: 30

validate_certs

boolean

Если установлено значение no, сертификаты SSL проверяться не будут.

Это значение должно устанавливаться в no только на лично контролируемых сайтах, использующих самозаверяющие сертификаты.

Варианты:

  • false
  • true ← (по умолчанию)

version

string

Строка, представляющая версию используемого для кластера механизма базы данных.

Для pg, версии — 10, 11 и 12.

Для mysql, версия — 8.

Для redis, версия — 5.

Для mongodb, версия — 4.

wait

boolean

Ожидать, пока база данных не станет доступна, прежде чем возвращать результат.

Варианты:

  • false
  • true ← (по умолчанию)

wait_timeout

integer

Сколько времени ожидать, прежде чем ожидание завершится (в секундах), при создании базы данных.

По умолчанию: 600

Примеры

- name: Create a Redis database
  community.digitalocean.digital_ocean_database:
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_KEY') }}"
    state: present
    name: testdatabase1
    engine: redis
    size: db-s-1vcpu-1gb
    region: nyc1
    num_nodes: 1
  register: my_database

- name: Create a Redis database (and assign to Project "test")
  community.digitalocean.digital_ocean_database:
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_KEY') }}"
    state: present
    name: testdatabase1
    engine: redis
    size: db-s-1vcpu-1gb
    region: nyc1
    num_nodes: 1
    project_name: test
  register: my_database

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ

Описание

assign_status

строка

Статус назначения (ok, not_found, assigned, already_assigned, service_down)

Возвращено: changed

Пример: "assigned"

data

словарь

База данных DigitalOcean

Возвращено: success

Пример: {"database": {"connection": {"database": "", "host": "testdatabase1-do-user-3097135-0.b.db.ondigitalocean.com", "password": "REDACTED", "port": 25061, "protocol": "rediss", "ssl": true, "uri": "rediss://default:REDACTED@testdatabase1-do-user-3097135-0.b.db.ondigitalocean.com:25061", "user": "default"}, "created_at": "2021-04-21T15:41:14Z", "db_names": null, "engine": "redis", "id": "37de10e4-808b-4f4b-b25f-7b5b3fd194ac", "maintenance_window": {"day": "monday", "hour": 41627, "pending": false}, "name": "testdatabase1", "num_nodes": 1, "private_connection": {"database": "", "host": "private-testdatabase1-do-user-3097135-0.b.db.ondigitalocean.com", "password": "REDIS", "port": 25061, "protocol": "rediss", "ssl": true, "uri": "rediss://default:REDACTED@private-testdatabase1-do-user-3097135-0.b.db.ondigitalocean.com:25061", "user": "default"}, "private_network_uuid": "0db3519b-9efc-414a-8868-8f2e6934688c,", "region": "nyc1", "size": "db-s-1vcpu-1gb", "status": "online", "tags": null, "users": null, "version": 6}}

msg

строка

Сообщение об ошибке или информационное сообщение, возникшее во время выполнения

Возвращено: changed

Пример: "No project named test2 found"

resources

словарь

Ресурсы, участвующие в назначении проекта

Возвращено: changed

Пример: {"assigned_at": "2021-10-25T17:39:38Z", "links": {"self": "https://api.digitalocean.com/v2/databases/126355fa-b147-40a6-850a-c44f5d2ad418"}, "status": "assigned", "urn": "do:dbaas:126355fa-b147-40a6-850a-c44f5d2ad418"}

Авторы

  • Mark Mercado (@mamercad)

Ссылки на сборку

  • Система отслеживания задач
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/digitalocean/digital_ocean_database_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API