diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/client/index.txt | 15 | ||||
| -rw-r--r-- | doc/client/tools/index.txt | 2 | ||||
| -rw-r--r-- | doc/client/tools/yumng.txt | 2 | ||||
| -rw-r--r-- | doc/contents.txt | 2 | ||||
| -rw-r--r-- | doc/index.txt | 26 | ||||
| -rw-r--r-- | doc/unsorted/index.txt | 2 |
6 files changed, 45 insertions, 4 deletions
diff --git a/doc/client/index.txt b/doc/client/index.txt index 7762b677c..0e67a7014 100644 --- a/doc/client/index.txt +++ b/doc/client/index.txt @@ -1,10 +1,23 @@ -.. client-index: +.. -*- mode: rst -*- + +.. _client-index: The Bcfg2 Client ================ +The Bcfg2 client is responsible for determining what reconfiguration +operations must be undertaken on the client, but does not perform any +processing of the target configuration description. We chose this +architecture, as opposed to one with a smarter client, for a few reasons: + +* Client failure forces administrators to perform an O(n) reconfiguration operation. Simpler code is easier to debug and maintain. +* Minimize the bootstrap size; a complicated client can require more aspects of the system to function in order for reconfiguration to work. +* Isolate configuration generation functionality on the server, where it can be readily observed. This is the most complicated task that Bcfg2 performs. +* The results of the configuration process fit a fairly simple model. We wanted to validate it. The result is that Bcfg2 has a programmable deployment engine that can be driven by anything that writes a compatible configuration description. + .. toctree:: :maxdepth: 2 :glob: + * tools/* diff --git a/doc/client/tools/index.txt b/doc/client/tools/index.txt index 5a8f80c2e..2cc83898e 100644 --- a/doc/client/tools/index.txt +++ b/doc/client/tools/index.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + .. _client-tools-index: Client Tool Drivers diff --git a/doc/client/tools/yumng.txt b/doc/client/tools/yumng.txt index 82360f1d5..8f8575d18 100644 --- a/doc/client/tools/yumng.txt +++ b/doc/client/tools/yumng.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + .. _client-tools-yumng: ================================ diff --git a/doc/contents.txt b/doc/contents.txt index f20919cbd..ece41a60b 100644 --- a/doc/contents.txt +++ b/doc/contents.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + .. _contents: ================================= diff --git a/doc/index.txt b/doc/index.txt index 2256b5555..3ed4ea093 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -1,7 +1,9 @@ +.. -*- mode: rst -*- + .. _index: ===================== -Bcfg2 Manual (v1.0.1) +Bcfg2 Manual (v1.1.0) ===================== What is Bcfg2? @@ -35,6 +37,28 @@ systems are constantly changing; if required in your environment, Bcfg2 can enable the construction of complex change management and deployment strategies. +Architecture +------------ + +Bcfg2 provides a declarative interface to system configuration. It was +designed and implemented in-house at Argonne National Laboratory, but has matured to the +point that external sites have begun using it. Its configuration +specifications describe a literal configuration goal state for +clients. In this architecture, the Bcfg2 client tool is responsible +for determining what, if any, configuration operations must occur and +then performing those operations. The client also uploads statistics and client +configuration state information. The design and implementation of the reporting system is described in a separate [wiki:Reports page]. + +Server +^^^^^^ + +The role of the bcfg2 server is rendering a client-specific target configuration description from a global specification. The specification consists of a directory structure containing data for a variety of server plugins. The bcfg2 server has a plugin interface that can be used to interpret parts configuration specification. + +Client +^^^^^^ + +Read on for more information about :ref:`client-index`. + What Operating Systems Does Bcfg2 Support? ========================================== diff --git a/doc/unsorted/index.txt b/doc/unsorted/index.txt index 52c5becb1..4984ebdbd 100644 --- a/doc/unsorted/index.txt +++ b/doc/unsorted/index.txt @@ -14,9 +14,7 @@ list below. .. _TitleIndex: https://trac.mcs.anl.gov/projects/bcfg2/wiki/TitleIndex -* `Agent with ssh` * `Annotated Examples` -* `Architecture` * `Audio/Video` * `Bcfg2Doc` * `Bcfg2 Subversion How To` |