Univention Bugzilla – Bug 39281
Provide a UCR glossary
Last modified: 2020-06-26 11:25:35 CEST
We should have a glossary for all existing UCR variables. It should contain at least the following information:
* default value
* possible values
* which templates / scripts / modules does it affect?
* to which package does it belong?
Vendors of third-party apps should be commited to provide a similar documentation of the UCR variables they use/create.
UCRV are not static, but changes all the time. It would be better to have a tool for that and/or extend the UMC module to display that information.
(In reply to Michael Grandjean from comment #0)
> We should have a glossary for all existing UCR variables. It should contain
> at least the following information:
> * name
> * category
In UMC you can only search for it, but it is not displayed
> * description
Tooltip on mouse-over and displayed in the UMC edit dialog
> * default value
Currently we have many defaults:
- set via `debian/$pkg.postinst`
- also depends on version first installed as defaults change over time
- coded into individual templates
Bug #38938 tries to unify that into a new default layer.
> * possible values
UCR performs no syntax validation and possible values are only described in human readable text. For UCR everything is a "string", the "Type" annotations in UCR info files is nowhere evaluated.
> * which templates / scripts / modules does it affect?
Bug #16418 asked for `ucr commit --dry-run`, but got closed as WONT-FIX.
python -c 'import re
from univention.config_registry.handler import ConfigHandlers
ucrv = sys.argv
all_handlers = ConfigHandlers()
the_handlers = set()
for reg_var, handlers in all_handlers._handlers.items():
the_handlers |= handlers
for handler in the_handlers:
for attr, txt in dict(to_file="File", script="Script", module="Module").items():
print("%s: %s" % (txt, getattr(handler, attr)))
print("Unknown handler: %s" % (handler,))
> * to which package does it belong?
UCRV do not belong to _one_ package only: Normally there is one package which provides the UCRV info file, but in may cases that is univention-base-files.
> Vendors of third-party apps should be commited to provide a similar
> documentation of the UCR variables they use/create.
The most sensible location for that would be the UCR info files as they already contain the description, Type (and in the future Default) information.
A tool to parse that and to generate a document from that looks more promising.
Bonus points for including that into the UMC module.