Примечания к выпускам Community.Sops

Краткое описание выпуска

Выпуск с новыми функциями.

Главная новая возможность этого выпуска — поддержка ansible-core 2.21 для community.sops.load_vars. ansible-core 2.21 — первая версия, которая явно позволяет плагинам действий задавать переменные, благодаря чему community.sops.load_vars наконец может задавать переменные так же, как ansible.builtin.include_vars.

Незначительные изменения

• все модули и плагины — добавлена возможность получать закрытые ключи age и закрытые ключи SSH с помощью команд, используя новые параметры age_key_cmd и age_ssh_private_key_cmd (https://github.com/ansible-collections/community.sops/issues/282, https://github.com/ansible-collections/community.sops/pull/286).
• все модули и плагины — добавлена возможность настраивать доступ к GCP с помощью параметров gcp_oauth_access_token и gcp_kms_client_type (https://github.com/ansible-collections/community.sops/issues/282, https://github.com/ansible-collections/community.sops/pull/286).
• load_vars — теперь поддерживает способ фактической загрузки переменных в ansible-core 2.21 вместо возврата ansible_facts. Поведение можно настроить с помощью нового параметра return_method, по умолчанию заданного как auto. В ansible-core 2.21+ auto ведёт себя так же, как vars-only (возвращает корректные переменные), а в более ранних версиях ansible-core — так же, как facts-only (возвращает ansible_facts) (https://github.com/ansible-collections/community.sops/pull/283).
• sops_encrypt — добавлена поддержка передачи идентификаторов ключей HuaweiCloud KMS с помощью параметра huawei_cloud_kms (https://github.com/ansible-collections/community.sops/issues/282, https://github.com/ansible-collections/community.sops/pull/286).

Краткое описание выпуска

Выпуск для сопровождения.

Известные проблемы

• При использовании community.sops.load_vars с ansible-core 2.20 учтите, что устаревание INJECT_FACTS_AS_VARS приводит к появлению предупреждений об устаревании каждый раз при использовании переменной, загруженной с помощью community.sops.load_vars. Это связано с тем, что в ansible-core объявили INJECT_FACTS_AS_VARS устаревшим, не предоставив альтернативы для таких модулей, как community.sops.load_vars. Если вы не хотите видеть эти предупреждения об устаревании, необходимо явно задать INJECT_FACTS_AS_VARS значение true. НЕ меняйте способ использования переменных, зашифрованных SOPS, на ansible_facts. Надеемся, что ситуация улучшится в ansible-core 2.21 благодаря обещанному API, который позволит плагинам действий задавать переменные; community.sops адаптируется для его использования, и предупреждение исчезнет. (Изначально API обещали включить в ansible-core 2.20, но затем его выпуск отложили.)

Краткое описание выпуска

Выпуск с исправлениями ошибок и обновлениями для сопровождения.

Исправления ошибок

• Удалён код плагина, который не выполняется на целевом узле (https://github.com/ansible-collections/community.sops/pull/275).
• Обратите внимание: код с лицензией MIT из plugins/module_utils/_six.py удалён (https://github.com/ansible-collections/community.sops/pull/275).
• плагин переменных sops — обеспечена обработка загруженных переменных также в ansible-core 2.19+ (https://github.com/ansible-collections/community.sops/pull/273).

Краткое описание выпуска

Выпуск для сопровождения.

Исправления ошибок

• действие load_vars — устранена зависимость от ещё одного устаревшего модуля utils из ansible-core (https://github.com/ansible-collections/community.sops/pull/270).
• действие load_vars — устранён устаревший импорт из ansible-core, который будет удалён в ansible-core 2.21 (https://github.com/ansible-collections/community.sops/pull/272).

Краткое описание выпуска

Выпуск для сопровождения.

Исправления ошибок

• Исправлены случайные расширения типов (https://github.com/ansible-collections/community.sops/pull/269).

Краткое описание выпуска

Выпуск для сопровождения.

Незначительные изменения

• Обратите внимание: новый код в plugins/module_utils/_six.py распространяется по лицензии MIT (https://github.com/ansible-collections/community.sops/pull/268).

Исправления ошибок

• Не используется ansible.module_utils.six, чтобы избежать предупреждений об устаревании в ansible-core 2.20 (https://github.com/ansible-collections/community.sops/pull/268).

Краткое описание выпуска

Выпуск с исправлениями ошибок.

Исправления ошибок

• Устранено использование устаревших функций в ansible-core 2.20 (https://github.com/ansible-collections/community.sops/pull/260).
• все модули и плагины — значение по умолчанию для enable_local_keyservice изменено с false на true, а при явной установке значения false теперь передаётся --enable-local-keyservice=false. Значением SOPS по умолчанию всегда было true; до сих пор при установке для этого параметра значения true передавалось --enable-local-keyservice, что эквивалентно --enable-local-keyservice=true и не оказывало эффекта. Это означает, что теперь явная установка enable_local_keyservice в false оказывает эффект. Если ранее enable_local_keyservice не задавался или был установлен в true, ничего не изменится (https://github.com/ansible-collections/community.sops/issues/261, https://github.com/ansible-collections/community.sops/pull/262).

Краткое описание выпуска

Выпуск с исправлениями ошибок.

Исправления ошибок

• роль install — исключено использование устаревшего значения параметра для модуля ansible.builtin.uri (https://github.com/ansible-collections/community.sops/pull/255).

Краткое описание выпуска

Выпуск с новыми функциями.

Незначительные изменения

• load_vars — при использовании ansible-core 2.19 или новее выражения теперь можно вычислять отложенно (https://github.com/ansible-collections/community.sops/pull/229).

Краткое описание выпуска

Выпуск с новыми функциями.

Незначительные изменения

• Добавлена поддержка указания закрытых ключей SSH для age с помощью нового параметра age_ssh_private_keyfile (https://github.com/ansible-collections/community.sops/pull/241).

Краткое описание выпуска

Выпуск для сопровождения с обновлённым набором тестов версий SOPS.

Краткое описание выпуска

Выпуск для сопровождения с поддержкой Data Tagging.

Исправления ошибок

• load_vars — обеспечена совместимость вычисления с Data Tagging в предстоящем выпуске ansible-core (https://github.com/ansible-collections/community.sops/pull/225).

Краткое описание выпуска

Выпуск с исправлениями ошибок.

Исправления ошибок

• роль install — sops_install_on_localhost=false работала некорректно, если роль выполнялась более чем на одном узле, из-за ошибки в ansible-core (https://github.com/ansible-collections/community.sops/issues/223, https://github.com/ansible-collections/community.sops/pull/224).

Краткое описание выпуска

Выпуск с исправлениями ошибок.

Исправления ошибок

• роль install — при использовании Debian на архитектуре ARM название архитектуры теперь корректно преобразуется из aarch64 в arm64 (https://github.com/ansible-collections/community.sops/issues/220, https://github.com/ansible-collections/community.sops/pull/221).

Краткое описание выпуска

Выпуск для сопровождения с обновлённой документацией.

Краткое описание выпуска

Крупный выпуск, прекращающий поддержку версий Ansible/ansible-base/ansible-core с истёкшим сроком поддержки.

Удалённые функции (ранее объявленные устаревшими)

• Коллекция больше не поддерживает Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12, ansible-core 2.13 и ansible-core 2.14. Если вам необходимо продолжить использование версий Ansible/ansible-base/ansible-core с истёкшим сроком поддержки, используйте community.sops 1.x.y (https://github.com/ansible-collections/community.sops/pull/206).

Краткое описание выпуска

Выпуск с исправлениями ошибок.

Исправления ошибок

• sops_encrypt — передаются абсолютные пути в module.atomic_move() (https://github.com/ansible/ansible/issues/83950, https://github.com/ansible-collections/community.sops/pull/208).

Краткое описание выпуска

Выпуск с новыми функциями.

Незначительные изменения

• плагин фильтра decrypt — теперь поддерживает тип входных и выходных данных ini (https://github.com/ansible-collections/community.sops/pull/204).
• плагин поиска sops — новый параметр extract позволяет извлечь отдельный ключ из файла JSON или YAML; это аналог decrypt --extract в sops (https://github.com/ansible-collections/community.sops/pull/200).
• плагин поиска sops — теперь поддерживает тип входных и выходных данных ini (https://github.com/ansible-collections/community.sops/pull/204).

Краткое описание выпуска

Выпуск для сопровождения с обновлённой документацией и журналом изменений.

Устаревшие функции

• Коллекция объявляет устаревшей поддержку всех версий Ansible/ansible-base/ansible-core, срок поддержки которых уже истёк, согласно матрице поддержки ansible-core. Это означает, что следующий крупный выпуск коллекции больше не будет поддерживать Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12, ansible-core 2.13 и ansible-core 2.14.

Краткое описание выпуска

Выпуск с исправлениями ошибок.

Исправления ошибок

• В SOPS 3.9.0 config_path передаётся перед подкомандой, а не после неё (https://github.com/ansible-collections/community.sops/issues/195, https://github.com/ansible-collections/community.sops/pull/197).

Краткое описание выпуска

Выпуск с новыми функциями, обеспечивающими поддержку улучшений, появившихся в SOPS 3.9.0.

Незначительные изменения

• Определяется SOPS 3.9.0 и используются новые подкоманды decrypt и encrypt (https://github.com/ansible-collections/community.sops/pull/190).
• плагин переменных sops — новый параметр handle_unencrypted_files позволяет настроить поведение при обнаружении незашифрованных файлов в SOPS 3.9.0+ (https://github.com/ansible-collections/community.sops/pull/190).

Исправления ошибок

• sops_encrypt — обеспечена корректная поддержка path_regex в .sops.yaml при использовании SOPS 3.9.0 или новее (https://github.com/ansible-collections/community.sops/issues/153, https://github.com/ansible-collections/community.sops/pull/190).

Краткое описание выпуска

Выпуск с исправлениями ошибок и новыми функциями для устранения проблем установки SOPS 3.9.0.

Незначительные изменения

• плагин переменных sops — добавлена возможность настраивать допустимые расширения с помощью записи ansible.cfg или переменной среды (https://github.com/ansible-collections/community.sops/pull/185).

Исправления ошибок

• Исправлен URL RPM для выпуска 3.9.0 (https://github.com/ansible-collections/community.sops/pull/188).

Краткое описание выпуска

Выпуск с исправлениями ошибок.

Исправления ошибок

• sops_encrypt — обеспечена установка для типа вывода значения yaml при использовании расширения файла .yml. Теперь файлы .yaml и .yml используют форматирование --output-type=yaml SOPS (https://github.com/ansible-collections/community.sops/issues/164).

Сводка выпуска

Обеспечена полная совместимость с sops 3.8.0 и проведено тестирование с этой версией.

Исправления ошибок

• Исправлен URL-адрес RPM для выпуска 3.8.0 (https://github.com/ansible-collections/community.sops/pull/161).

Сводка выпуска

Обеспечена совместимость с sops 3.8.0-rc.1 и проведено тестирование с этой версией.

Исправления ошибок

• При выборе последней версии с помощью метода GitHub API исключены предварительные выпуски (https://github.com/ansible-collections/community.sops/pull/159).
• Исправлены изменившиеся URL-адреса DEB и RPM для версии 3.8.0 и её предварительных выпусков (https://github.com/ansible-collections/community.sops/pull/159).

Сводка выпуска

Выпуск с исправлениями и обновлениями для перехода sops в новую организацию getsops на GitHub.

Исправления ошибок

• роль install — исправлен sops_github_latest_detection=latest-release, который перестал работать после перехода sops в другую организацию GitHub (https://github.com/ansible-collections/community.sops/pull/151).

Сводка выпуска

Выпуск с обновлённой документацией.

Начиная с этой версии community.sops использует в документации новую семантическую разметку Ansible. Обратите внимание: если вы просматриваете документацию с помощью CLI-инструмента ansible-doc из ansible-core версии ниже 2.15, разметка отображается некорректно. В большинстве случаев документацию всё равно можно прочитать, но для отображения в задуманном виде требуется ansible-core 2.15 или более поздней версии. Также можно посмотреть сайт документации devel с отформатированной HTML-версией документации последнего выпуска.

Известные проблемы

• В текстовом выводе ansible-doc для ansible-core версии ниже 2.15 разметка Ansible будет отображаться в исходном виде. Если вам трудно разобраться в разметке документации, обновите ansible-core до версии 2.15 (или новее) либо прочитайте HTML-документацию по адресу https://docs.ansible.com/ansible/devel/collections/community/sops/.

Сводка выпуска

Выпуск с обновлениями.

Исправления ошибок

• роль install — обеспечена гарантированная доступность факта pkg_mgr при установке на localhost. В некоторых случаях это позволяет улучшить сообщения об ошибках (https://github.com/ansible-collections/community.sops/issues/145, https://github.com/ansible-collections/community.sops/pull/146).

Сводка выпуска

Выпуск с обновлениями.

Исправления ошибок

• вспомогательный компонент модуля action plugin — исправлена обработка устаревших компонентов в ansible-core 2.14.2 (https://github.com/ansible-collections/community.sops/pull/136).
• различные плагины — удалены ненужные импорты (https://github.com/ansible-collections/community.sops/pull/133).

Сводка выпуска

Функциональный выпуск с улучшениями роли установки.

Незначительные изменения

• роль install — добавлен параметр sops_github_latest_detection, позволяющий настроить метод определения последнего выпуска на GitHub. По умолчанию (auto) сначала выполняется попытка получить список последних выпусков через API, а если это не удаётся из-за ограничения частоты запросов, предпринимается попытка получить последний выпуск GitHub по частично документированному URL-адресу (https://github.com/ansible-collections/community.sops/pull/133).
• роль install — добавлен параметр sops_github_token для передачи токена GitHub. Например, его можно использовать, чтобы избежать ограничения частоты запросов при использовании роли в GitHub Actions (https://github.com/ansible-collections/community.sops/pull/132).
• роль install — реализован альтернативный способ определения последнего выпуска на GitHub, не использующий GitHub API, из-за ограничения частоты запросов к которому установка может завершиться с ошибкой (https://github.com/ansible-collections/community.sops/pull/131).

Сводка выпуска

Функциональный выпуск.

Незначительные изменения

• GNU Privacy Guard (GPG) автоматически устанавливается в средах выполнения. Для установки Mozilla sops необходимо добавить в определение EE отдельный шаг; подробности см. в документации коллекции (https://github.com/ansible-collections/community.sops/pull/98).

Новые сценарии

• community.sops.install — устанавливает sops и GNU Privacy Guard на всех удалённых узлах
• community.sops.install_localhost — устанавливает sops и GNU Privacy Guard на localhost

Новые роли

• community.sops.install — установка Mozilla sops

Сводка выпуска

Выпуск с обновлениями для улучшения совместимости с будущими версиями ansible-core.

Исправления ошибок

• load_vars — обеспечена совместимость с более новыми версиями ansible-core (https://github.com/ansible-collections/community.sops/pull/121).

Сводка выпуска

Функциональный выпуск.

Незначительные изменения

• Добавлена возможность указывать ключи age как age_key или файлы ключей age как age_keyfile (https://github.com/ansible-collections/community.sops/issues/116, https://github.com/ansible-collections/community.sops/pull/117).
• sops_encrypt — добавлена возможность указывать получателей age (https://github.com/ansible-collections/community.sops/issues/116, https://github.com/ansible-collections/community.sops/pull/117).

Сводка выпуска

Функциональный выпуск.

Незначительные изменения

• Все лицензии программного обеспечения теперь находятся в каталоге LICENSES/ в корне коллекции, а репозиторий коллекции соответствует спецификации REUSE, за исключением фрагментов журнала изменений (https://github.com/ansible-collections/community.crypto/sops/108, https://github.com/ansible-collections/community.sops/pull/113).
• плагин переменных sops — добавлен параметр конфигурации для временного отключения плагина переменных (https://github.com/ansible-collections/community.sops/pull/114).

Сводка выпуска

Исправлена ошибка форматирования в документации. Изменений кода нет.

Сводка выпуска

Выпуск с обновлениями.

Исправления ошибок

• Добавлен файл лицензии simplified_bsd.txt для утилит модуля sops.

Сводка выпуска

Выпуск с обновлённой документацией.

Сводка выпуска

Выпуск коллекции для включения в Ansible 4.9.0 и 5.1.0.

В этот выпуск вошло изменение, позволяющее настраивать общие параметры плагинов с помощью ключей ansible.cfg и переменных среды.

Незначительные изменения

• модули поиска и переменных sops — добавлена возможность настраивать почти все общие параметры с помощью записей ansible.cfg и переменных среды (https://github.com/ansible-collections/community.sops/pull/81).

Исправления ошибок

• Исправлена обработка ошибок при вызовах двоичного файла sops в случаях, когда возвращаются отрицательные ошибки (https://github.com/ansible-collections/community.sops/issues/82, https://github.com/ansible-collections/community.sops/pull/83).

Сводка выпуска

Незначительный выпуск для включения в Ansible 4.2.0.

Незначительные изменения

• Вместо внутренних module_utils ansible-core используются эквивалентные публичные API, доступные как минимум с Ansible 2.9 (https://github.com/ansible-collections/community.sops/pull/73).

Новые плагины

Сводка выпуска

Этот выпуск обеспечивает совместимость коллекции с последней бета-версией ansible-core 2.11.

Исправления ошибок

• вспомогательный компонент плагина action_module — обеспечена совместимость с последними изменениями в ansible-core 2.11.0b3 (https://github.com/ansible-collections/community.sops/pull/58).
• community.sops.load_vars — обеспечена совместимость с последними изменениями в ansible-core 2.11.0b3 (https://github.com/ansible-collections/community.sops/pull/58).

Сводка выпуска

В этом выпуске исправлена ошибка, из-за которой при завершении вывода на .yaml не создавался корректный файл YAML.

Исправления ошибок

• community.sops.sops_encrypt — используется тип вывода yaml, если путь заканчивается на .yaml (https://github.com/ansible-collections/community.sops/pull/56).

Сводка выпуска

Это выпуск с исправлением уязвимости, устраняющий потенциальную утечку информации в модуле community.sops.sops_encrypt.

Исправления безопасности

• community.sops.sops_encrypt — параметры aws_secret_access_key и aws_session_token помечены как no_log, чтобы предотвратить утечку секретов (https://github.com/ansible-collections/community.sops/pull/54).

Сводка выпуска

В этот выпуск вошли некоторые исправления документации Ansible и изменения, необходимые для включения в Ansible.

Исправления ошибок

• модули поиска community.sops.sops — исправлен неверный формат переменных Ansible, из-за которого они фактически не использовались (https://github.com/ansible-collections/community.sops/pull/51).
• плагины переменных community.sops.sops — удалены неработающие переменные Ansible (https://github.com/ansible-collections/community.sops/pull/51).

Сводка выпуска

Исправление выпуска 1.0.1, в котором отсутствовала запись в журнале изменений.

Сводка выпуска

Повторный выпуск версии 1.0.0 для устранения ошибки, возникшей при выпуске.

Сводка выпуска

Первый стабильный выпуск. Предполагается, что этот выпуск будет включён в Ansible 3.0.0.

Незначительные изменения

• Все плагины и модули: добавлена возможность передавать общие параметры sops с помощью новых параметров config_path, enable_local_keyservice, keyservice. Также добавлена возможность передавать параметры AWS с помощью параметров aws_profile, aws_access_key_id, aws_secret_access_key и aws_session_token (https://github.com/ansible-collections/community.sops/pull/47).
• community.sops.sops_encrypt — добавлена возможность передавать в sops параметры, специфичные для шифрования: kms, gcp_kms, azure_kv, hc_vault_transit, pgp, unencrypted_suffix, encrypted_suffix, unencrypted_regex, encrypted_regex, encryption_context и shamir_secret_sharing_threshold (https://github.com/ansible-collections/community.sops/pull/47).

Сводка выпуска

В этом выпуске добавлены возможности для плагинов поиска и переменных.

Незначительные изменения

• плагин поиска community.sops.sops — добавлен параметр empty_on_not_exist, позволяющий возвращать пустую строку вместо ошибки, если файл не существует (https://github.com/ansible-collections/community.sops/pull/33).
• плагин переменных community.sops.sops — добавлен параметр управления кэшированием (https://github.com/ansible-collections/community.sops/pull/32).
• плагин переменных community.sops.sops — добавлен параметр, определяющий, когда загружаются переменные (https://github.com/ansible-collections/community.sops/pull/32).

Сводка выпуска

Первый выпуск коллекции community.sops! В этот выпуск входят несколько плагинов: плагин action, плагин lookup и плагин vars.

Новые плагины

Новые модули

• community.sops.load_vars — динамическая загрузка переменных, зашифрованных с помощью sops, из файлов в ходе выполнения задачи
• community.sops.sops_encrypt — шифрование данных с помощью sops