rougail-user-data-ansible/src/rougail/user_data_ansible/config.py

"""
Silique (https://www.silique.fr)
Copyright (C) 2024-2026

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""
from .i18n import _


def get_rougail_config(
    *,
    backward_compatibility: bool = True,  # pylint: disable=unused-argument
) -> dict:
    """get rougail config for ansible"""
    # redefine ansible family if already exists (for output)
    # or create a new only only for user data
    options = f"""
ansible:
  description: {_("Load user data from Ansible compatible file")}
  help: {_("Ansible offers a tool (ansible-vault) for encrypting inventory files. With this user data you can open an encrypt inventory file. This is a perfect way to manage a smooth migration from Ansible inventory to Rougail. Or it could be a way to encrypt these secrets in a file with a secure format.")}
  disabled:
    jinja: |
      {{{{ _.step.user_data is propertyerror or 'ansible' not in _.step.user_data }}}}
    return_type: boolean
    description: {_('if ansible is not set in "step.user_data"')}

  filename:
    description: {_("Ansible filename inventory")}
    type: unix_filename
    multi: true
    params:
       allow_relative: True
       test_existence: True
       types:
         - file
    disabled:
      jinja: |
        {{{{ __.step.user_data is propertyerror or 'ansible' not in __.step.user_data }}}}
      return_type: boolean
      description: {_('if ansible is not set in "step.user_data"')}

  secret:
    description: {_("Secret to decrypt file")}
    type: secret
    disabled:
      jinja: |
        {{{{ __.step.user_data is propertyerror or 'ansible' not in __.step.user_data }}}}
      return_type: boolean
      description: {_('if ansible is not set in "step.user_data"')}

  file_with_secrets:
    description: {_("Ansible files that may contain secrets")}
    default: all
    choices:
      - all
      - first
      - last
      - none
    disabled:
      jinja: |
        {{{{ __.step.user_data is propertyerror or 'ansible' not in __.step.user_data }}}}
      return_type: boolean
      description: {_('if ansible is not set in "step.user_data"')}
"""
    return {
        "name": "ansible",
        "process": "user data",
        "options": options,
        "level": 60,
    }


__all__ = ("get_rougail_config",)