If we are rewriting and moving things to vyos-1x already, perhaps it's time to rethink the directory structure until it's too late.
Originally we left it as is because the effect of the changes on existing code is quite unpredictable, but for new code it's not an issue.
The original directory structure of Vyatta doesn't make much sense. Why keep things in /opt if nothing there is installable or removable without breaking the system? Things inside /opt are not pretty either.
We have /opt/vyatta/sbin that is used mostly but not exclusively for config scripts. However, the binaries of the CLI (my_set etc.) are also there. But not all of them, cli-shell-api is in /bin
We have /opt/vyatta/bin which is mostly used for op mode scripts, but some of op mode if in fact in sbin/ (such as installation scripts). There's also sudo-users dir inside bin/, but it doesn't mean none of the files in bin/ requires root priviliges.
Of course the transition will be gradual, and having two parallel directory structures can be aesthetically annoying, but I believe in the long run we'll have to it anyway. Let's make it more logical and FHS-compliant. Now that we have only a few scripts in vyos-1x, it's still easy to start doing it for the new code.
Here's my proposal:
- /usr/libexec/vyos/conf-mode — config scripts
- /usr/libexec/vyos/op-mode — op mode scripts
- /usr/libexec/vyos/validators — value validators
- /usr/libexec/vyos/ — miscelanneous helper programs
Since none of the old scripts use ${vyos_libexecdir} for obvious reasons, it's safe to point it to /usr/libexec/vyos
We may also want to remove vyos- and words such as "config", "update" etc. from file names since their origin and purpose will be obvious from their location.
The original */share hierarchies are too risky to touch until the last bits of the old code are gone I suppose, but if we introduce new data files, I think it's a good idea to place them in /usr/share/vyos