community.sops.sops – Загрузка файлов sops-зашифрованных переменных
Примечание
Этот плагин входит в сборку community.sops (версия 1.0.4).
Для его установки используйте: ansible-galaxy collection install community.sops.
Для использования в плейбуке укажите: community.sops.sops.
Новое в версии 0.1.0: из community.sops
Обзор
- Загрузка зашифрованных файлов YAML в соответствующие группы/хосты в каталогах group_vars/ и host_vars/.
- Файлы шифруются перед чтением, что делает этот плагин эффективным дополнением к плагину host_group_vars.
- Файлы ограничены расширениями .sops.yaml, .sops.yml, .sops.json.
- Скрытые файлы игнорируются.
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| _valid_extensions список / элементы=строка | Значение по умолчанию: [".sops.yml", ".sops.yaml", ".sops.json"] | Проверка всех этих расширений при поиске файлов 'переменных', которые должны быть YAML или JSON или зашифрованные версии этих форматов. Это влияет на плагины vars_files, include_vars, inventory и vars, среди прочих. | |
| aws_access_key_id строка добавлено в 1.0.0 из community.sops | Идентификатор ключа доступа AWS для запросов к AWS. Устанавливает переменную окружения AWS_ACCESS_KEY_ID для вызова sops. | ||
| aws_profile строка добавлено в 1.0.0 из community.sops | Профиль AWS для запросов к AWS. Соответствует параметру sops --aws-profile. | ||
| aws_secret_access_key строка добавлено в 1.0.0 из community.sops | Секретный ключ доступа AWS для запросов к AWS. Устанавливает переменную окружения AWS_SECRET_ACCESS_KEY для вызова sops. | ||
| aws_session_token строка добавлено в 1.0.0 из community.sops | Токен сессии AWS для запросов к AWS. Устанавливает переменную окружения AWS_SESSION_TOKEN для вызова sops. | ||
| cache логическое добавлено в 0.2.0 из community.sops |
| записи ini: [community.sops] env:ANSIBLE_VARS_SOPS_PLUGIN_CACHE | Выполнять кэширование расшифрованных файлов или нет. Если кэширование отключено, файлы будут расшифровываться практически для каждой задачи. Это очень медленно! Отключайте кэширование только если вы изменяете файлы переменных во время выполнения плейбука и хотите, чтобы обновленные результаты были доступны в следующей задаче. Обратите внимание, что установка stage в inventory имеет тот же эффект, что и установка cache в true: переменные будут загружены только один раз (при загрузке инвентаризации), и плагин vars не будет вызываться для каждой задачи. |
| config_path путь добавлено в 1.0.0 из community.sops | Путь к файлу конфигурации sops. Если не задано, sops будет рекурсивно искать файл конфигурации, начиная с файла, который зашифрован или расшифрован. Соответствует параметру sops --config. | ||
| enable_local_keyservice логическое добавлено в 1.0.0 из community.sops |
| Указать sops использовать локальную службу ключей. Соответствует параметру sops --enable-local-keyservice. | |
| keyservice список / элементы=строка добавлено в 1.0.0 из community.sops | Указать службы ключей для использования помимо локальной. Служба ключей должна быть указана в формате protocol://address, например tcp://myserver.com:5000.Соответствует параметру sops --keyservice. | ||
| sops_binary путь добавлено в 1.0.0 из community.sops | Путь к бинарному файлу sops. По умолчанию используется sops. | ||
| stage строка добавлено в 0.2.0 из community.sops |
| записи ini: [community.sops] env:ANSIBLE_VARS_SOPS_PLUGIN_STAGE | Управление временем выполнения этого плагина переменных. Установка этого параметра в all запустит плагин переменных после импорта инвентаризации и каждый раз, когда это потребовано задачей.Установка этого параметра в task запустит плагин переменных только тогда, когда это потребуется задачей.Установка этого параметра в inventory запустит плагин переменных только после анализа инвентаризации.Если этот параметр опущен, используется глобальная конфигурация RUN_VARS_PLUGINS для определения того, когда выполнить плагин переменных. |
Авторы
- Edoardo Tenani (@endorama) <e.tenani@arduino.cc>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/sops/sops_vars.html