rougail-user-data-yaml/src/rougail/user_data_yaml/config.py

64 lines
1.6 KiB
Python

"""
Config yaml for Rougail-user-data
Silique (https://www.silique.fr)
Copyright (C) 2024-2025
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=True,
) -> dict:
options = f"""
yaml:
description: {_("Configuration rougail-user-data-yaml")}
disabled:
type: jinja
jinja: |
{{% if step.user_data is propertyerror or 'yaml' not in step.user_data %}}
disabled
{{% endif %}}
filename:
description: {_("File or directory name where user datas are stored")}
alternative_name: ff
type: unix_filename
multi: true
params:
allow_relative: True
test_existence: True
file_with_secrets:
description: {_("File that may contain secrets")}
default: all
choices:
- all
- first
- last
- none
"""
return {
"name": "yaml",
"process": "user data",
"options": options,
"level": 50,
}
__all__ = "get_rougail_config"