Spec-Zone.ru › Ansible

community.sops.sops vars – Загрузка файлов vars, зашифрованных с помощью SOPS

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.sops. Для использования этого плагина vars необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в плейбуке укажите: community.sops.sops.

Новое в community.sops 0.1.0

  • Описание
  • Требования
  • Параметры
  • См. также

Описание

  • Загружает зашифрованные файлы YAML в соответствующие группы/хосты в каталогах group_vars/ и host_vars/.
  • Файлы шифруются перед чтением, что делает этот плагин эффективным дополнением к плагину ansible.builtin.host_group_vars.
  • Файлы ограничены расширениями .sops.yaml, .sops.yml, .sops.json, если не настроено иное с помощью valid_extensions.
  • Скрытые файлы игнорируются.

Требования

Ниже перечислены требования к локальному контроллеру, на котором выполняется этот плагин vars.

  • Исполняемый файл sops (https://github.com/getsops/sops) должен существовать либо в PATH либо быть настроен как sops_binary.

Параметры

Параметр

Комментарии

age_key

строка

добавлено в community.sops 1.4.0

Один или несколько закрытых ключей age, которые можно использовать для расшифровки зашифрованных файлов.

Будет установлено как переменная среды SOPS_AGE_KEY при вызове SOPS.

Требуется SOPS 3.7.1+.

Конфигурация:

  • Переменная окружения: ANSIBLE_SOPS_AGE_KEY

age_keyfile

путь

добавлено в community.sops 1.4.0

Файл, содержащий закрытые ключи age, которые SOPS может использовать для расшифровки зашифрованных файлов.

Будет установлено как переменная среды SOPS_AGE_KEY_FILE при вызове SOPS.

По умолчанию SOPS ищет sops/age/keys.txt в вашем пользовательском каталоге конфигурации.

Требуется SOPS 3.7.0+.

Конфигурация:

  • Запись в INI:

    [community.sops]
    age_keyfile = VALUE
    
  • Переменная окружения: ANSIBLE_SOPS_AGE_KEYFILE

aws_access_key_id

строка

добавлено в community.sops 1.0.0

Идентификатор ключа доступа AWS, который следует использовать для запросов к AWS.

Устанавливает переменную среды AWS_ACCESS_KEY_ID для вызова SOPS.

Конфигурация:

  • Запись в INI:

    [community.sops]
    aws_access_key_id = VALUE
    

    добавлено в community.sops 1.2.0

  • Переменная окружения: ANSIBLE_SOPS_AWS_ACCESS_KEY_ID

    добавлено в community.sops 1.2.0

... ...

enable_local_keyservice

boolean

added in community.sops 1.0.0

Указать SOPS использовать локальную службу ключей.

Это соответствует параметру SOPS --enable-local-keyservice.

Варианты:

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

Настройка:

  • Запись INI:

    [community.sops]
    enable_local_keyservice = false
    

    added in community.sops 1.2.0

  • Переменная окружения: ANSIBLE_SOPS_ENABLE_LOCAL_KEYSERVICE

    added in community.sops 1.2.0

handle_unencrypted_files

string

added in community.sops 1.8.0

Как обрабатывать файлы, соответствующие расширениям в valid_extensions, которые не зашифрованы с помощью SOPS.

Значение по умолчанию error приведет к ошибке.

Значение skip просто пропустит эти файлы. Это требует SOPS 3.9.0 или более поздней версии.

Значение warn пропустит эти файлы и выведет предупреждение. Это требует SOPS 3.9.0 или более поздней версии.

Примечание, что это не поможет, если хранилище SOPS не может обработать файл, например, потому что он не является допустимым файлом JSON/YAML/…, несмотря на его расширение файла. Для расширений, отличных от стандартных, SOPS использует двоичное хранилище, которое пытается обработать файл как JSON.

Варианты:

  • "skip"
  • "warn"
  • "error" ← (по умолчанию)

Настройка:

  • Запись INI:

    [community.sops]
    handle_unencrypted_files = error
    
  • Переменная окружения: ANSIBLE_VARS_SOPS_PLUGIN_HANDLE_UNENCRYPTED_FILES

keyservice

list / elements=string

added in community.sops 1.0.0

Указать службы ключей для использования наряду с локальной.

Служба ключей должна быть указана в формате protocol://address, например tcp://myserver.com:5000.

Это соответствует параметру SOPS --keyservice.

Настройка:

  • Запись INI:

    [community.sops]
    keyservice = VALUE
    

    added in community.sops 1.2.0

  • Переменная окружения: ANSIBLE_SOPS_KEYSERVICE

    added in community.sops 1.2.0

sops_binary

path

added in community.sops 1.0.0

Путь к бинарному файлу SOPS.

По умолчанию используется sops.

Настройка:

  • Запись INI:

    [community.sops]
    binary = VALUE
    

    added in community.sops 1.2.0

  • Переменная окружения: ANSIBLE_SOPS_BINARY

    added in community.sops 1.2.0

stage

string

added in community.sops 0.2.0

Управление временем выполнения этого плагина переменных.

Установка этого параметра в all запустит плагин переменных после импорта инвентаризации и при необходимости задачей.

Установка этого параметра в task запустит плагин переменных только при необходимости задачей.

Установка этого параметра в inventory запустит плагин переменных только после обработки инвентаризации.

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

Варианты:

  • "all"
  • "task"
  • "inventory"

Настройка:

  • Запись INI:

    [community.sops]
    vars_stage = VALUE
    
  • Переменная окружения: ANSIBLE_VARS_SOPS_PLUGIN_STAGE

valid_extensions

list / elements=string

Проверять все эти расширения при поиске файлов ‘переменных’.

Эти файлы должны быть зашифрованными с помощью SOPS YAML или JSON-файлами.

По умолчанию плагин будет выводить ошибки при обнаружении файлов с этими расширениями, которые не зашифрованы с помощью SOPS. Это поведение можно контролировать с помощью параметра handle_unencrypted_files.

По умолчанию: [".sops.yml", ".sops.yaml", ".sops.json"]

Настройка:

  • Запись INI:

    [community.sops]
    valid_extensions = .sops.yml, .sops.yaml, .sops.json
    

    added in community.sops 1.7.0

  • Переменная окружения: ANSIBLE_VARS_SOPS_PLUGIN_VALID_EXTENSIONS

    added in community.sops 1.7.0

См. также

См. также

community.sops.sops плагин поиска

Плагин поиска sops может использоваться для расшифровки файлов, зашифрованных с помощью SOPS.

community.sops.decrypt плагин фильтра

Плагин фильтра decrypt может использоваться для расшифровки данных в памяти, зашифрованных с помощью SOPS.

community.sops.load_vars

Загрузка переменных, зашифрованных с помощью SOPS, из файлов динамически в задаче.

Авторы

  • Edoardo Tenani (@endorama)

Подсказка

Записи конфигурации для каждого типа имеют порядок приоритетов от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

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

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Задать вопрос (SOPS)
  • Отправить отчет об ошибке
  • Запросить функцию
  • Связь

© 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/sops/sops_vars.html

Spec-Zone.ru

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