community.sops.load_vars – Загрузка зашифрованных переменных sops из файлов динамически в рамках задачи

Примечание

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

Для его установки используйте: ansible-galaxy collection install community.sops.

Для использования в книге задач укажите: community.sops.load_vars.

Добавлена в версии 0.1.0: of community.sops

Описание
Параметры
См. также
Примеры
Возвращаемые значения

Описание

Динамически загружает зашифрованные переменные YAML/JSON sops из файла во время выполнения задачи.
Чтобы назначить включенные переменные другому хосту, чем inventory_hostname, используйте delegate_to и задайте delegate_facts=yes.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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.
config_path путь добавлено в 1.0.0 community.sops		Путь к файлу конфигурации sops. Если не задано, sops будет рекурсивно искать файл конфигурации, начиная с файла, который зашифрован или расшифрован. Соответствует параметру sops `--config`.
enable_local_keyservice булево добавлено в 1.0.0 community.sops	Варианты: нет ← да	Указывает sops использовать локальную службу ключей. Соответствует параметру sops `--enable-local-keyservice`.
expressions строка	Варианты: игнорировать ← оценить-при-загрузке	Этот параметр контролирует, как обрабатываются выражения Jinja2 в значениях загружаемого файла. Если задано `ignore`, выражения не будут оцениваться, а будут рассматриваться как обычные строки. Если задано `evaluate-on-load`, выражения будут оцениваться при выполнении этого модуля, другими словами, когда файл загружается. К сожалению, не-ядерные модули не могут обрабатывать выражения "unsafe", другими словами, оценивать их только при использовании. Это может быть достигнуто только с помощью ansible.builtin.include_vars, который, к сожалению, не может обрабатывать зашифрованные файлы sops.
file путь		Имя файла, из которого должны быть загружены переменные. Если путь является относительным, он будет искать файл в `vars/` подкаталоге роли или относительно книги задач.
keyservice список / элементы=строка добавлено в 1.0.0 community.sops		Указывает службы ключей, которые нужно использовать наряду с локальной. Служба ключей должна быть указана в формате `protocol://address`, например, `tcp://myserver.com:5000`. Соответствует параметру sops `--keyservice`.
name строка		Имя переменной, в которую следует назначить включенные переменные. Если опущено (`null`) они будут сделаны переменными верхнего уровня.
sops_binary путь добавлено в 1.0.0 community.sops		Путь к бинарному файлу sops. По умолчанию используется `sops`.

См. также

ansible.builtin.set_fact: Официальная документация модуля ansible.builtin.set_fact.
ansible.builtin.include_vars: Официальная документация модуля ansible.builtin.include_vars.
Управление тем, где выполняются задачи: делегирование и локальные действия: Дополнительная информация о делегировании задач.

Примеры

- name: Include variables of stuff.sops.yaml into the 'stuff' variable
  community.sops.load_vars:
    file: stuff.sops.yaml
    name: stuff
    expressions: evaluate-on-load  # interpret Jinja2 expressions in stuf.sops.yaml on load-time!

- name: Conditionally decide to load in variables into 'plans' when x is 0, otherwise do not
  community.sops.load_vars:
    file: contingency_plan.sops.yaml
    name: plans
    expressions: ignore  # do not interpret possible Jinja2 expressions
  when: x == 0

- name: Load variables into the global namespace
  community.sops.load_vars:
    file: contingency_plan.sops.yaml

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

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

Ключ	Возвращенное значение	Описание
ansible_included_var_files список / элементы=строка	успех	Список файлов, которые были успешно включены Пример: ['/path/to/file.sops.yaml']

Авторы

Felix Fontein (@felixfontein)

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