community.hashi_vault.vault_read lookup — выполнение операции чтения в HashiCorp Vault

Примечание

Этот lookup-плагин входит в коллекцию community.hashi_vault (версия 7.1.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.hashi_vault. Для использования этого lookup-плагина необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.hashi_vault.vault_read.

Добавлено в community.hashi_vault 1.4.0

Краткое описание
Требования
Параметры
Параметры-ключевые слова
Примечания
См. также
Примеры
Возвращаемое значение

Краткое описание

Выполняет универсальную операцию чтения по указанному пути в HashiCorp Vault.

Требования

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

hvac (библиотека Python)
Подробные сведения о требованиях см. на странице требований коллекции.

Параметры

Параметр	Комментарии
Параметры строка / обязательный	Путь или пути в Vault для чтения.

Параметры ключевых слов

Здесь описаны параметры ключевых слов для lookup. Это значения key1=value1, key2=value2 и так далее в следующих примерах: lookup('community.hashi_vault.vault_read', key1=value1, key2=value2, ...) и query('community.hashi_vault.vault_read', key1=value1, key2=value2, ...)

Параметр	Комментарии
auth_method string	Используемый метод аутентификации. Метод аутентификации `none` добавлен в коллекции версии `1.2.0`. Метод аутентификации `cert` добавлен в коллекции версии `1.4.0`. `aws_iam_login` переименован в `aws_iam` в коллекции версии `2.1.0` и удалён в `3.0.0`. Метод аутентификации `azure` добавлен в коллекции версии `3.2.0`. Метод аутентификации `gcp` добавлен в коллекции версии `7.1.0`. Варианты: `"token"` ← (по умолчанию) `"userpass"` `"ldap"` `"approle"` `"aws_iam"` `"azure"` `"jwt"` `"cert"` `"gcp"` `"none"` Конфигурация: Запись INI: [hashi_vault_collection] auth_method = token добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_AUTH_METHOD` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_auth_method добавлено в community.hashi_vault 1.2.0
aws_access_key псевдонимы: aws_access_key_id string	Ключ доступа AWS. Конфигурация: Переменная окружения: `EC2_ACCESS_KEY` Переменная окружения: `AWS_ACCESS_KEY` Переменная окружения: `AWS_ACCESS_KEY_ID`
aws_iam_server_id string добавлено в community.hashi_vault 0.2.0	Если задано, устанавливает значение, которое будет использоваться для заголовка `X-Vault-AWS-IAM-Server-ID` в запросе `GetCallerIdentity`. Конфигурация: Запись INI: [hashi_vault_collection] aws_iam_server_id = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_AWS_IAM_SERVER_ID`
aws_profile псевдонимы: boto_profile string	Профиль AWS Конфигурация: Переменная окружения: `AWS_DEFAULT_PROFILE` Переменная окружения: `AWS_PROFILE`
aws_secret_key псевдонимы: aws_secret_access_key string	Секретный ключ AWS, соответствующий ключу доступа. Конфигурация: Переменная окружения: `EC2_SECRET_KEY` Переменная окружения: `AWS_SECRET_KEY` Переменная окружения: `AWS_SECRET_ACCESS_KEY`
aws_security_token string	Токен безопасности AWS при использовании временных ключей доступа и секретных ключей. Конфигурация: Переменная окружения: `EC2_SECURITY_TOKEN` Переменная окружения: `AWS_SESSION_TOKEN` Переменная окружения: `AWS_SECURITY_TOKEN`
azure_client_id string добавлено в community.hashi_vault 3.2.0	Идентификатор клиента (также известный как идентификатор приложения) субъекта-службы Azure AD или управляемого удостоверения. Должен быть UUID. Если не задано, будет использоваться назначенное системой управляемое удостоверение. Конфигурация: Запись INI: [hashi_vault_collection] azure_client_id = VALUE Переменная окружения: `ANSIBLE_HASHI_VAULT_AZURE_CLIENT_ID` Переменная: ansible_hashi_vault_azure_client_id
azure_client_secret string добавлено в community.hashi_vault 3.2.0	Секрет клиента субъекта-службы Azure AD. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_AZURE_CLIENT_SECRET` Переменная: ansible_hashi_vault_azure_client_secret
azure_resource string добавлено в community.hashi_vault 3.2.0	URL ресурса для приложения, зарегистрированного в Azure Active Directory. Обычно его не следует менять относительно значения по умолчанию. По умолчанию: `"https://management.azure.com/"` Конфигурация: Запись INI: [hashi_vault_collection] azure_resource = https://management.azure.com/ Переменная окружения: `ANSIBLE_HASHI_VAULT_AZURE_RESOURCE` Переменная: ansible_hashi_vault_azure_resource
azure_tenant_id string добавлено в community.hashi_vault 3.2.0	Идентификатор клиента Azure Active Directory (также известный как идентификатор каталога) субъекта-службы. Должен быть UUID. Обязателен при использовании субъекта-службы для аутентификации в Vault, например, когда заданы оба параметра azure_client_id и azure_client_secret. Необязателен при использовании управляемого удостоверения для аутентификации в Vault. Конфигурация: Запись INI: [hashi_vault_collection] azure_tenant_id = VALUE Переменная окружения: `ANSIBLE_HASHI_VAULT_AZURE_TENANT_ID` Переменная: ansible_hashi_vault_azure_tenant_id
ca_cert псевдонимы: cacert string	Путь к сертификату, используемому для аутентификации. Если значение не задано другим способом, будет использоваться переменная окружения `VAULT_CACERT`. Конфигурация: Запись INI: [hashi_vault_collection] ca_cert = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_CA_CERT` добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_ca_cert добавлено в community.hashi_vault 1.2.0
cert_auth_private_key path добавлено в community.hashi_vault 1.4.0	Для аутентификации `cert` укажите путь к файлу закрытого ключа в формате PEM. Конфигурация: Запись INI: [hashi_vault_collection] cert_auth_private_key = VALUE Переменная окружения: `ANSIBLE_HASHI_VAULT_CERT_AUTH_PRIVATE_KEY` Переменная: ansible_hashi_vault_cert_auth_private_key добавлено в community.hashi_vault 6.2.0
cert_auth_public_key path добавлено в community.hashi_vault 1.4.0	Для аутентификации `cert` укажите путь к файлу сертификата в формате PEM. Конфигурация: Запись INI: [hashi_vault_collection] cert_auth_public_key = VALUE Переменная окружения: `ANSIBLE_HASHI_VAULT_CERT_AUTH_PUBLIC_KEY` Переменная: ansible_hashi_vault_cert_auth_public_key добавлено в community.hashi_vault 6.2.0
jwt string	JSON Web Token (JWT), используемый для аутентификации в Vault с помощью JWT. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_JWT`
mount_point string	Точка монтирования Vault. Если не задана, используется точка монтирования по умолчанию для указанного метода аутентификации. Не применяется для аутентификации по токену. Конфигурация: Запись INI: [hashi_vault_collection] mount_point = VALUE добавлено в community.hashi_vault 1.5.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_MOUNT_POINT` добавлено в community.hashi_vault 1.5.0 Переменная: ansible_hashi_vault_mount_point добавлено в community.hashi_vault 1.5.0
namespace string	Пространство имён Vault, в котором хранятся секреты. Для этого параметра требуется HVAC 0.7.0+ и Vault 0.11+. Кроме того, этого можно добиться, добавив пространство имён перед точкой монтирования аутентификации и/или путём секрета (например, `mynamespace/secret/mysecret`). Если задана переменная окружения `VAULT_NAMESPACE`, её значение будет использовано последним среди всех способов задания namespace. Конфигурация: Запись INI: [hashi_vault_collection] namespace = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_NAMESPACE` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_namespace добавлено в community.hashi_vault 1.2.0
password string	Пароль для аутентификации. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_PASSWORD` добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_password добавлено в community.hashi_vault 1.2.0
proxies any добавлено в community.hashi_vault 1.1.0	URL прокси-серверов, используемых для доступа к службе Vault. Значение может быть строкой или словарём. Если задан словарь, укажите схему (например, `http` или `https`) в качестве ключа, а URL — в качестве значения. Если задана строка, укажите один URL, который будет использоваться как прокси для схем `http` и `https`. Строка, которую можно интерпретировать как словарь, будет преобразована в словарь (см. примеры). Для ресурсов HTTP и HTTPS можно указать разные прокси-серверы. Если параметр не задан, используются переменные окружения библиотеки Requests. Конфигурация: Запись INI: [hashi_vault_collection] proxies = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_PROXIES` Переменная: ansible_hashi_vault_proxies добавлено в community.hashi_vault 1.2.0
region string	Регион AWS, для которого создаётся подключение. Конфигурация: Переменная окружения: `EC2_REGION` Переменная окружения: `AWS_REGION`
retries any добавлено в community.hashi_vault 1.3.0	Позволяет повторять запросы при ошибках на основе класса Retry библиотеки urllib3. В этой коллекции заданы рекомендуемые параметры по умолчанию для повторных подключений к Vault. Этот параметр можно указать в виде положительного числа (целого числа) или словаря. Если параметр не задан или число равно `0`, повторные попытки отключены. Число задаёт общее количество повторных попыток; для остальных параметров используются значения коллекции по умолчанию. Значение-словарь напрямую используется для инициализации класса `Retry`, поэтому его можно применять для полной настройки повторных попыток. Подробные сведения о повторных попытках см. в руководстве пользователя коллекции. Конфигурация: Запись INI: [hashi_vault_collection] retries = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_RETRIES` Переменная: ansible_hashi_vault_retries
retry_action string добавлено в community.hashi_vault 1.3.0	Управляет тем, следует ли показывать сообщения о повторных попытках и каким образом. Не влияет на запросы, которые не повторяются. Варианты: `"ignore"` `"warn"` ← (по умолчанию) Конфигурация: Запись INI: [hashi_vault_collection] retry_action = warn добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_RETRY_ACTION` Переменная: ansible_hashi_vault_retry_action
role_id string	Идентификатор или имя роли Vault. Используется в методах аутентификации `approle`, `aws_iam`, `azure` и `cert`. Для аутентификации `cert`, если role_id не указан, по умолчанию выполняется попытка использовать все роли сертификатов и возвращается любая подходящая роль. Для аутентификации `azure` параметр role_id обязателен. Конфигурация: Запись INI: [hashi_vault_collection] role_id = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_ROLE_ID` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_role_id добавлено в community.hashi_vault 1.2.0
secret_id string	Идентификатор секрета для аутентификации в Vault с помощью AppRole. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_SECRET_ID` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_secret_id добавлено в community.hashi_vault 1.2.0
timeout integer добавлено в community.hashi_vault 1.3.0	Задаёт время ожидания подключения в секундах. Если значение не задано, используется значение по умолчанию библиотеки `hvac`. Конфигурация: Запись INI: [hashi_vault_collection] timeout = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TIMEOUT` Переменная: ansible_hashi_vault_timeout
token string	Токен Vault. Токен можно задать явно, с помощью перечисленных переменных [env], а также с помощью переменной окружения `VAULT_TOKEN`. Если токен не указан явно или через переменные окружения, плагин проверит наличие файла токена, путь к которому определяется параметрами token_path и token_file. Порядок загрузки токена (используется первое найденное значение): `token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file`. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_token добавлено в community.hashi_vault 1.2.0
token_file string	Если токен не задан, будет предпринята попытка прочитать его из этого файла в каталоге token_path. По умолчанию: `".vault-token"` Конфигурация: Запись INI: [hashi_vault_collection] token_file = .vault-token добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN_FILE` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_token_file добавлено в community.hashi_vault 1.2.0

token_path строка	Если токен не указан, будет предпринята попытка прочитать token_file по этому пути. Конфигурация: Запись INI: [hashi_vault_collection] token_path = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN_PATH` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_token_path добавлено в community.hashi_vault 1.2.0
token_validate логическое значение добавлено в community.hashi_vault 0.2.0	При аутентификации по токену перед его использованием будет выполнена операция `lookup-self` для проверки его действительности. Отключите эту проверку, если у вашего токена нет возможности `lookup-self`. Варианты: `false` ← (по умолчанию) `true` Конфигурация: Запись INI: [hashi_vault_collection] token_validate = false добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN_VALIDATE` Переменная: ansible_hashi_vault_token_validate добавлено в community.hashi_vault 1.2.0
url строка	URL-адрес сервиса Vault. Если значение не задано другим способом, будет использоваться значение переменной окружения `VAULT_ADDR`. Если `VAULT_ADDR` также не задана, будет вызвана ошибка. Конфигурация: Запись INI: [hashi_vault_collection] url = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_ADDR` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_url добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_addr добавлено в community.hashi_vault 1.2.0
username строка	Имя пользователя для аутентификации. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_USERNAME` добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_username добавлено в community.hashi_vault 1.2.0
validate_certs логическое значение	Управляет проверкой и валидацией SSL-сертификатов; обычно отключать эту проверку следует только для самоподписанных сертификатов. Если задан параметр `VAULT_SKIP_VERIFY`, а validate_certs явно не указан, для параметра будет установлено противоположное значение. Если не заданы ни validate_certs, ни `VAULT_SKIP_VERIFY`, по умолчанию будет установлено значение `true`. Варианты: `false` `true` Конфигурация: Переменная: ansible_hashi_vault_validate_certs добавлено в community.hashi_vault 1.2.0

Примечание

Перечисленные выше для каждого типа записей параметры конфигурации (переменная Ansible, переменная окружения и т. д.) упорядочены от низкого к высокому приоритету. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись в ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

При совместном использовании позиционных параметров и параметров по ключевым словам позиционные параметры должны указываться перед параметрами по ключевым словам: lookup('community.hashi_vault.vault_read', term1, term2, key1=value1, key2=value2) и query('community.hashi_vault.vault_read', term1, term2, key1=value1, key2=value2)

См. также

community.hashi_vault.vault_read: Выполняет операцию чтения в HashiCorp Vault.
модуль подстановки community.hashi_vault.hashi_vault: Официальная документация по модулю подстановки community.hashi_vault.hashi_vault.

Примеры

- name: Read a kv2 secret
  ansible.builtin.debug:
    msg: "{{ lookup('community.hashi_vault.vault_read', 'secret/data/hello', url='https://vault:8201') }}"

- name: Retrieve an approle role ID
  ansible.builtin.debug:
    msg: "{{ lookup('community.hashi_vault.vault_read', 'auth/approle/role/role-name/role-id', url='https://vault:8201') }}"

- name: Perform multiple reads with a single Vault login
  vars:
    paths:
      - secret/data/hello
      - auth/approle/role/role-one/role-id
      - auth/approle/role/role-two/role-id
  ansible.builtin.debug:
    msg: "{{ lookup('community.hashi_vault.vault_read', *paths, auth_method='userpass', username=user, password=pwd) }}"

- name: Perform multiple reads with a single Vault login in a loop
  vars:
    paths:
      - secret/data/hello
      - auth/approle/role/role-one/role-id
      - auth/approle/role/role-two/role-id
  ansible.builtin.debug:
    msg: '{{ item }}'
  loop: "{{ query('community.hashi_vault.vault_read', *paths, auth_method='userpass', username=user, password=pwd) }}"

- name: Perform multiple reads with a single Vault login in a loop (via with_)
  vars:
    ansible_hashi_vault_auth_method: userpass
    ansible_hashi_vault_username: '{{ user }}'
    ansible_hashi_vault_password: '{{ pwd }}'
  ansible.builtin.debug:
    msg: '{{ item }}'
  with_community.hashi_vault.vault_read:
    - secret/data/hello
    - auth/approle/role/role-one/role-id
    - auth/approle/role/role-two/role-id

Возвращаемое значение

Ключ	Описание
Возвращаемое значение список / элементы=словарь	Необработанный результат чтения по указанному пути. Возвращается: при успешном выполнении

Авторы

Brian Scholer (@briantist)

Ссылки на коллекцию

© 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_read_lookup.html