Модуль community.hashi_vault.vault_database_connection_configure — настройка движка базы данных
Примечание
Этот модуль входит в коллекцию community.hashi_vault (версия 7.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.hashi_vault. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.hashi_vault.vault_database_connection_configure.
Добавлено в community.hashi_vault 6.2.0
Краткое описание
- Создаёт новое подключение к базе данных для движка секретов базы данных, которое определяется своим
engine_mount_pointв HashiCorp Vault.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
-
hvac(библиотека Python) - Подробные сведения о требованиях см. на странице требований коллекции.
Параметры
Параметр | Комментарии |
|---|---|
allowed_roles list / elements=string / обязательный | Разрешённые роли |
auth_method string | Используемый метод аутентификации. Метод аутентификации Метод аутентификации
Метод аутентификации Метод аутентификации Варианты:
|
aws_access_key псевдонимы: aws_access_key_id string | Используемый ключ доступа AWS. |
aws_iam_server_id string добавлено в community.hashi_vault 0.2.0 | Если указано, задаёт значение для заголовка |
aws_profile псевдонимы: boto_profile string | Профиль AWS |
aws_secret_key псевдонимы: aws_secret_access_key string | Секретный ключ AWS, соответствующий ключу доступа. |
aws_security_token string | Токен безопасности AWS при использовании временных ключей доступа и секретных ключей. |
azure_client_id string добавлено в community.hashi_vault 3.2.0 | Идентификатор клиента (также известный как идентификатор приложения) субъекта-службы Azure AD или управляемого удостоверения. Должен быть UUID. Если не указано, будет использоваться управляемое удостоверение, назначенное системе. |
azure_client_secret string добавлено в community.hashi_vault 3.2.0 | Секрет клиента субъекта-службы Azure AD. |
azure_resource string добавлено в community.hashi_vault 3.2.0 | URL ресурса для приложения, зарегистрированного в Azure Active Directory. Обычно значение по умолчанию менять не следует. По умолчанию: |
azure_tenant_id string добавлено в community.hashi_vault 3.2.0 | Идентификатор клиента Azure Active Directory (также известный как идентификатор каталога) субъекта-службы. Должен быть UUID. Обязателен при аутентификации в Vault с помощью субъекта-службы, например, когда указаны и azure_client_id, и azure_client_secret. Необязателен при аутентификации в Vault с помощью управляемого удостоверения. |
ca_cert псевдонимы: cacert string | Путь к сертификату, используемому для аутентификации. Если значение не указано иным способом, будет использоваться переменная окружения |
cert_auth_private_key path добавлено в community.hashi_vault 1.4.0 | Для аутентификации |
cert_auth_public_key path добавлено в community.hashi_vault 1.4.0 | Для аутентификации |
connection_name string / обязательный | Имя подключения к базе данных. |
connection_password string / обязательный | Пароль для подключения к базе данных |
connection_url string / обязательный | URL подключения к базе данных |
connection_username string / обязательный | Имя пользователя для подключения к базе данных |
engine_mount_point string | Путь, по которому подключён бэкенд секретов. |
jwt string | JSON Web Token (JWT), используемый для аутентификации в Vault с помощью JWT. |
mount_point string | Точка монтирования Vault. Если не указана, используется точка монтирования по умолчанию для выбранного метода аутентификации. Не применяется при аутентификации с помощью токена. |
namespace string | Пространство имён Vault, в котором хранятся секреты. Для этого параметра требуются HVAC 0.7.0+ и Vault 0.11+. При необходимости этого можно добиться, добавив пространство имён в начало пути точки монтирования аутентификации и/или пути секрета (например, Если задана переменная окружения |
password string | Пароль для аутентификации. |
plugin_name string / обязательный | Имя плагина, используемого для подключения к базе данных |
proxies any добавлено в community.hashi_vault 1.1.0 | URL прокси-серверов, используемых для доступа к службе Vault. Значением может быть строка или словарь. Если указано значение-словарь, используйте схему (например, Если указана строка, задайте один URL, который будет использоваться в качестве прокси для схем Строка, которую можно интерпретировать как словарь, будет преобразована в словарь (см. примеры). Для ресурсов HTTP и HTTPS можно указать разные прокси-серверы. Если значение не указано, используются переменные окружения библиотеки Requests. |
region string | Регион AWS, для которого создаётся подключение. |
retries any добавлено в community.hashi_vault 1.3.0 | Позволяет повторять запросы при ошибках на основе класса Retry библиотеки urllib3. В этой коллекции заданы рекомендуемые значения по умолчанию для повторных подключений к Vault. Для этого параметра можно указать положительное число (целое) или словарь. Если параметр не указан или число равно Число задаёт общее количество повторов; для остальных параметров используются значения коллекции по умолчанию. Значение-словарь напрямую используется для инициализации класса Подробные сведения о повторах см. в руководстве пользователя коллекции. |
retry_action string добавлено в community.hashi_vault 1.3.0 | Определяет, нужно ли отображать сообщения при повторных попытках и каким образом. Не влияет на запросы, которые не повторяются. Варианты:
|
role_id string | Идентификатор или имя роли Vault. Используется в методах аутентификации При аутентификации Для аутентификации |
secret_id string | Идентификатор секрета для аутентификации в Vault с помощью AppRole. |
timeout integer добавлено в community.hashi_vault 1.3.0 | Задаёт время ожидания подключения в секундах. Если значение не задано, используется значение по умолчанию библиотеки |
token string | Токен Vault. Его можно указать явно, через перечисленные переменные окружения [env], а также через переменную окружения Если токен не указан явно или через переменные окружения, плагин проверит наличие файла токена, определяемого параметрами token_path и token_file. Токен загружается в следующем порядке (используется первое найденное значение): |
token_file string | Если токен не указан, будет выполнена попытка прочитать его из этого файла в каталоге token_path. По умолчанию: |
token_path string | Если токен не указан, будет выполнена попытка прочитать файл token_file из этого пути. |
token_validate boolean добавлено в community.hashi_vault 0.2.0 | При аутентификации с помощью токена перед его использованием выполняется операция Отключите параметр, если у вашего токена нет возможности Варианты:
|
url string | URL службы Vault. Если значение не указано иным способом, будет использоваться значение переменной окружения Если |
username string | Имя пользователя для аутентификации. |
validate_certs boolean | Управляет проверкой и подтверждением SSL-сертификатов; обычно отключать проверку следует только для самоподписанных сертификатов. Если задана переменная Если не заданы ни validate_certs, ни Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группа действий: community.hashi_vault.vault | Используйте |
check_mode | Поддержка: частичная В режиме проверки будет возвращён пример ответа, но создание или обновление в Hashicorp Vault выполняться не будет. | Может работать в режиме |
Примечания
Примечание
- Перед настройкой движка секретов базы данных описанным выше способом необходимо создать базу данных и обеспечить возможность подключения к ней.
- Этот модуль всегда сообщает о состоянии
changed, поскольку не может гарантировать идемпотентность. - Используйте
changed_when, чтобы управлять этим поведением в случаях, когда известно, что операция не изменит состояние.
Примеры
- name: Create a new Database Connection with the default mount point
community.hashi_vault.vault_database_connection_configure:
url: https://vault:8201
auth_method: userpass
username: '{{ user }}'
password: '{{ passwd }}'
connection_name: MyName
plugin_name: postgresql-database-plugin
connection_url: postgresql://{{'{{username}}'}}:{{'{{password}}'}}@postgres:5432/postgres?sslmode=disable
connection_username: SomeUser
connection_password: SomePass
register: result
- name: Display the result of the operation
ansible.builtin.debug:
msg: "{{ result }}"
- name: Create a new Database Connection with a custom mount point
community.hashi_vault.vault_database_connection_configure:
url: https://vault:8201
auth_method: userpass
username: '{{ user }}'
password: '{{ passwd }}'
engine_mount_point: db1
connection_name: MyName
plugin_name: postgresql-database-plugin
connection_url: postgresql://{{'{{username}}'}}:{{'{{password}}'}}@postgres:5432/postgres?sslmode=disable
connection_username: SomeUser
connection_password: SomePass
register: result
- name: Display the result of the operation
ansible.builtin.debug:
msg: "{{ result }}"
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/hashi_vault/vault_database_connection_configure_module.html
