TracNav
This is a draft document''
Proposal
Existing commands that use a variety of prefixes should be replaced with a suite of commands with a common prefix (e.g. quattor-...). This will clearly indicate to users that the commands are part of Quattor and provide basic command-name completion.
In some cases it may be preferable to merge or split existing commands, e.g. ncm-ncd with --configure and --unconfigure options to quattor-configure and quattor-unconfigure.
Further work could include developing a full Bash-completion configuration (or equivalent for other shells) and a quattor wrapper command (e.g. quattor -v fetch).
Client commands
Current name | Proposed name | Comments |
aii-installfe | quattor-[auto]-installer-remote | Automated Install Infrastructure remote management tool (is "auto" needed?) |
aii-shellfe | quattor-[auto]-installer | Automated Install Infrastructure local management tool (is "auto" needed?) |
ccm-fetch | quattor-fetch | Fetch latest profile to local configuration cache. |
ncm-ncd | quattor-configure, quattor-unconfigure, quattor-list | "Node Configuration Dispatcher": used to configure, unconfigure or list components |
ncm-query | quattor-query | Run queries against node or component configuration |
spma | quattor-software-manager | Software Package Manager Agent (perhaps package-manager would be better). |
spma_wrapper.sh | ? | |
spma_ncm_wrapper.sh | ? |
Server commands
Current name | Proposed name | Comments |
cdp-listend | quattor-listend | notification-handling daemon |
ncm-cdispd | quattor-dispatchd | configuration dispatch daemon |
Unified Command
In addition to renaming/wrapping existing commands it may be useful to provide a "unified" quattor command, similar to svn, git, xm or aq.
For example:
$ quattor help Quattor - http://quattor.org/ quattor configure Configure components quattor fetch Fetch new configuration quattor installer (Server) Install/configure new machine quattor installer-remote (Server) Install/configure new machine remotely quattor list List active components quattor query Query machine configuration quattor software-manager Manage software packages quattor unconfigure Unconfigure components quattor help Help on quattor (From implementation mentioned below).
Implementation
A template for linking/wrapping to provide the suggested commands is available from tools/quattor_commands.tpl.
An initial implementation of a "unified" quattor command has been developed (tools/quattor.sh) along with a Bash completion script (tools/quattor_bash_completion.sh).
A template to include the unified command and bash completion is available from tools/quattor_unified.tpl.