| | 1 | [[TracNav]] |
| | 2 | |
| | 3 | {{draft}} |
| | 4 | |
| | 5 | == Proposal == |
| | 6 | |
| | 7 | 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. |
| | 8 | |
| | 9 | 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''. |
| | 10 | |
| | 11 | 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''). |
| | 12 | |
| | 13 | == Client commands == |
| | 14 | || '''Current name''' || '''Proposed name''' || '''Comments''' || |
| | 15 | || aii-installfe || ''quattor-[auto]-installer-remote'' || Automated Install Infrastructure remote management tool (is "auto" needed?) |
| | 16 | || aii-shellfe || ''quattor-[auto]-installer'' || Automated Install Infrastructure local management tool (is "auto" needed?) |
| | 17 | || ccm-fetch || ''quattor-fetch'' || Fetch latest profile to local configuration cache. |
| | 18 | || ncm-ncd || ''quattor-configure'', ''quattor-unconfigure'', ''quattor-list'' || "Node Configuration Dispatcher": used to configure, unconfigure or list components |
| | 19 | || ncm-query || ''quattor-query'' || Run queries against node or component configuration |
| | 20 | || spma || ''quattor-software-manager'' || Software Package Manager Agent (perhaps ''package-manager'' would be better). |
| | 21 | || spma_wrapper.sh || ? || |
| | 22 | || spma_ncm_wrapper.sh || ? || |
| | 23 | |
| | 24 | == Server commands == |
| | 25 | || Current name || Proposed name || Comments |
| | 26 | || cdp-listend || ''quattor-listend'' || notification-handling daemon |
| | 27 | || ncm-cdispd || ''quattor-dispatchd''|| configuration dispatch daemon |
| | 28 | |
| | 29 | == Unified Command == |
| | 30 | In addition to renaming/wrapping existing commands it may be useful to provide a "unified" ''quattor'' command, similar to ''svn'', ''git'', ''xm'' or ''aq''. |
| | 31 | |
| | 32 | For example: |
| | 33 | |
| | 34 | {{{ |
| | 35 | $ quattor help |
| | 36 | Quattor - http://quattor.org/ |
| | 37 | |
| | 38 | quattor configure Configure components |
| | 39 | quattor fetch Fetch new configuration |
| | 40 | quattor installer (Server) Install/configure new machine |
| | 41 | quattor installer-remote (Server) Install/configure new machine remotely |
| | 42 | quattor list List active components |
| | 43 | quattor query Query machine configuration |
| | 44 | quattor software-manager Manage software packages |
| | 45 | quattor unconfigure Unconfigure components |
| | 46 | |
| | 47 | quattor help Help on quattor |
| | 48 | |
| | 49 | (From implementation mentioned below). |
| | 50 | }}} |
| | 51 | |
| | 52 | == Implementation == |
| | 53 | |
| | 54 | A template for linking/wrapping to provide the suggested commands is available from [https://svn.lal.in2p3.fr/LCG/QWG/templates/trunk/tools/quattor_commands.tpl tools/quattor_commands.tpl]. |
| | 55 | |
| | 56 | An initial implementation of a "unified" ''quattor'' command has been developed ([https://svn.lal.in2p3.fr/LCG/QWG/templates/trunk/tools/quattor.sh tools/quattor.sh]) along with a Bash completion script ([https://svn.lal.in2p3.fr/LCG/QWG/templates/trunk/tools/quattor_bash_completion.sh tools/quattor_bash_completion.sh]). |
| | 57 | |
| | 58 | A template to include the unified command and bash completion is available from [https://svn.lal.in2p3.fr/LCG/QWG/templates/trunk/tools/quattor_unified.tpl tools/quattor_unified.tpl]. |
