community.sops.sops – Чтение содержимого зашифрованных файлов sops

Примечание

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

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

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

Новое в версии 0.1.0: of community.sops

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот поиск возвращает содержимое файла из файловой системы контроллера Ansible.
Для работы этого поиска необходимо, чтобы исполняемый файл sops был доступен в переменной среды PATH контроллера.

Параметры

Параметр	Варианты/Значения по умолчанию	Настройка	Комментарии
_terms строка / обязательный			Путь(и) к файлам для чтения.
aws_access_key_id строка добавлено в версии 1.0.0 community.sops		var: sops_aws_access_key_id	Идентификатор ключа доступа AWS для запросов к AWS. Устанавливает переменную среды `AWS_ACCESS_KEY_ID` для вызова sops.
aws_profile строка добавлено в версии 1.0.0 community.sops		var: sops_aws_profile	Профиль AWS для запросов к AWS. Соответствует параметру sops `--aws-profile`.
aws_secret_access_key строка добавлено в версии 1.0.0 community.sops		var: sops_aws_secret_access_key	Секретный ключ доступа AWS для запросов к AWS. Устанавливает переменную среды `AWS_SECRET_ACCESS_KEY` для вызова sops.
aws_session_token строка добавлено в версии 1.0.0 community.sops		var: sops_session_token	Токен сессии AWS для запросов к AWS. Устанавливает переменную среды `AWS_SESSION_TOKEN` для вызова sops.
base64 логическое	Варианты: нет ← да		Кодирует результат в Base64. Используйте, если вы хотите хранить двоичные данные в переменных Ansible.
config_path путь добавлено в версии 1.0.0 community.sops		var: sops_config_path	Путь к файлу конфигурации sops. Если не задано, sops будет рекурсивно искать файл конфигурации, начиная с зашифрованного или расшифрованного файла. Соответствует параметру sops `--config`.
empty_on_not_exist логическое	Варианты: нет ← да		Если установлено в `true`, не будет генерировать ошибку при отсутствии файла, а вместо этого вернёт пустую строку.
enable_local_keyservice логическое добавлено в версии 1.0.0 community.sops	Варианты: нет ← да	var: sops_enable_local_keyservice	Указывает sops использовать локальную службу ключей. Соответствует параметру sops `--enable-local-keyservice`.
input_type строка	Варианты: двоичный json yaml dotenv		Указывает sops как интерпретировать зашифрованный файл. По умолчанию sops выбирает тип ввода по расширению файла. Если обнаружен неверный тип, это может привести к сбою расшифровки.
keyservice список / элементы=строка добавлено в версии 1.0.0 community.sops		var: sops_keyservice	Указывает службы ключей, которые нужно использовать в дополнение к локальной. Служба ключей должна быть указана в формате `protocol://address`, например `tcp://myserver.com:5000`. Соответствует параметру sops `--keyservice`.
output_type строка	Варианты: двоичный json yaml dotenv		Указывает sops как интерпретировать расшифрованный файл. По умолчанию sops выбирает тип вывода по расширению файла. Если обнаружен неверный тип, это может привести к сбою расшифровки.
rstrip логическое	Варианты: нет да ←		Указывает, нужно ли удалять хвостовые символы перевода строки и пробелы.
sops_binary путь добавлено в версии 1.0.0 community.sops		var: sops_binary	Путь к исполняемому файлу sops. По умолчанию используется `sops`.

Примечания

Примечание

Этот поиск не понимает «шаблоны» — используйте поиск fileglob вместо него.

Примеры

tasks:
  - name: Output secrets to screen (BAD IDEA!)
    ansible.builtin.debug:
        msg: "Content: {{ lookup('community.sops.sops', item) }}"
    loop:
        - sops-encrypted-file.enc.yaml

  - name: Add SSH private key
    ansible.builtin.copy:
        content: "{{ lookup('community.sops.sops', user + '-id_rsa') }}"
        dest: /home/{{ user }}/.ssh/id_rsa
        owner: "{{ user }}"
        group: "{{ user }}"
        mode: 0600
    no_log: true  # avoid content to be written to log

  - name: The file file.json is a YAML file, which contains the encryption of binary data
    ansible.builtin.debug:
        msg: "Content: {{ lookup('community.sops.sops', 'file.json', input_type='yaml', output_type='binary') }}"

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

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

Ключ	Возвращаемое значение	Описание
_raw список / элементы=строка	успех	Содержимое расшифрованного файла.

Авторы

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_lookup.html