From ea46e6aeec1186d7e5e374c1c74722e52c1d2c4f Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sat, 26 Feb 2011 11:04:23 +0100 Subject: [PATCH] remove old internal documentation, update READMEs Signed-off-by: Nico Schottelius --- REAL_README | 14 ++++++++++++++ doc/dev/todo/post-1.0 | 9 ++++++--- doc/internal.REMOVE_PRE_1.0/puppet-missing | 20 -------------------- 3 files changed, 20 insertions(+), 23 deletions(-) delete mode 100644 doc/internal.REMOVE_PRE_1.0/puppet-missing diff --git a/REAL_README b/REAL_README index 15ec6507..57d252c8 100644 --- a/REAL_README +++ b/REAL_README @@ -26,6 +26,20 @@ it ticks differently: * User defines configuration in shell scripts (called ***manifests***) * Cdist generates internal configuration (cconfig style) and afterwards applies configuration +### Features + +Stuff that should probably be included in every configuration management, +but is not. Or: The reason why I began to write cdist. + + * Speed + * Elegant code + * Clean design + * Good documentation (man pages) + * Meaningful error messages + * No surprise factor + * Consistency in behaviour, naming and documentation + * Easy integration nacked installations + ## Requirements ### Server diff --git a/doc/dev/todo/post-1.0 b/doc/dev/todo/post-1.0 index dcecc1cd..f6466de3 100644 --- a/doc/dev/todo/post-1.0 +++ b/doc/dev/todo/post-1.0 @@ -3,9 +3,6 @@ Core: - probably name them only_once and use that as the internal id! - extend cdist_tree_wrapper to look for optional/mandority parameters for types - gives "good" database, which contains only valid objects - - use ssh with master socket? - - saves connection delay for new connections: -M - - hint: http://protempore.net/~calvins/howto/ssh-connection-sharing/ - remove remote_base_dir at beginning - otherwise fragments from previous runs may still be existing! @@ -29,3 +26,9 @@ Types to be written: - delete_line_from_file - regexp replace (can probably cover all?) +Documentation: + - Multi master setups + - use ssh with master socket? + - saves connection delay for new connections: -M + - hint: http://protempore.net/~calvins/howto/ssh-connection-sharing/ + - Describe pull architecture and requirements diff --git a/doc/internal.REMOVE_PRE_1.0/puppet-missing b/doc/internal.REMOVE_PRE_1.0/puppet-missing deleted file mode 100644 index 443b414b..00000000 --- a/doc/internal.REMOVE_PRE_1.0/puppet-missing +++ /dev/null @@ -1,20 +0,0 @@ -What do I miss from puppet? - - - speed - - elegance - - clean design - - documentation - - the "no surprise" factor - - easy to use "data memory" (i.e. external ressources) - - easy integration into installation process - - copy identity to master - - multi master setups - - development configurations / tests - - editing of configuration files - - similar to cfengine - - replace bug squasher with bug avoidance - - qmail did not need one either - - push infrastructure - - real / meaningful error messages - -