From e0df4d0993fe524b0d3b7a9b5f203aaa3ab1d7b3 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Mon, 11 Jan 2010 02:05:30 +0000 Subject: doc: Rearrange document structure and add client tools Signed-off-by: Sol Jerome git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5669 ce84e21b-d406-0410-9b95-82705330c041 --- doc/index.txt | 105 +++++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 86 insertions(+), 19 deletions(-) (limited to 'doc/index.txt') diff --git a/doc/index.txt b/doc/index.txt index 05baefd22..ca96bfe1f 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -1,27 +1,94 @@ -.. -*- mode: rst -*- +.. _index: -Welcome to Bcfg2's documentation! -================================= +===================== +Bcfg2's documentation +===================== -.. toctree:: - :maxdepth: 2 +Getting help +============ - intro - quickstart/index - authentication - getting_started/index - plugins/index - testimonials - sites +Having trouble? We'd like to help! - unsorted/index +* Try the :ref:`FAQ ` -- it's got answers to many common questions. - glossary +* Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or the :ref:`detailed table of contents `. -Indices and tables -================== +* Search for information in the `Bcfg2 mailing list archives`_. -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +* Ask a question in the `#bcfg2 IRC channel`_, or search the `IRC logs`_ to see if its been asked before. +* Report bugs with Bcfg2 in our `ticket tracker`_. + +.. _Bcfg2 mailing list archives: http://trac.mcs.anl.gov/projects/bcfg2/wiki/MailingList +.. _#bcfg2 IRC channel: irc://irc.freenode.net/bcfg2 +.. _IRC logs: http://colabti.org/irclogger/irclogger_logs/bcfg2 +.. _ticket tracker: http://trac.mcs.anl.gov/projects/bcfg2/wiki + +Introduction +============ + +Bcfg2 helps system administrators produce a consistent, reproducible, +and verifiable description of their environment, and offers +visualization and reporting tools to aid in day-to-day administrative +tasks. It is the fifth generation of configuration management tools +developed in the `Mathematics and Computer Science Division`_ of +`Argonne National Laboratory`_. + +.. _Mathematics and Computer Science Division: http://www.mcs.anl.gov/ +.. _Argonne National Laboratory: http://www.anl.gov/ + +It is based on an operational model in which the specification can be +used to validate and optionally change the state of clients, but in a +feature unique to bcfg2 the client's response to the specification can +also be used to assess the completeness of the specification. Using +this feature, bcfg2 provides an objective measure of how good a job an +administrator has done in specifying the configuration of client +systems. Bcfg2 is therefore built to help administrators construct an +accurate, comprehensive specification. + +Bcfg2 has been designed from the ground up to support gentle +reconciliation between the specification and current client states. It +is designed to gracefully cope with manual system modifications. + +Finally, due to the rapid pace of updates on modern networks, client +systems are constantly changing; if required in your environment, +Bcfg2 can enable the construction of complex change management and +deployment strategies. + +Bcfg2 is fairly portable. It has been successfully run on: + +* `AIX`_, `FreeBSD`_, `OpenBSD`_, `Mac OS X`_, `OpenSolaris`_, + `Solaris`_. + +.. _AIX: http://www.ibm.com/aix +.. _FreeBSD: http://www.freebsd.org/ +.. _OpenBSD: http://www.openbsd.org/ +.. _Mac OS X: http://www.apple.com/macosx/ +.. _OpenSolaris: http://opensolaris.org/ +.. _Solaris: http://www.sun.com/software/solaris/ + +* Many `GNU/Linux`_ distributions, including `Blag`_, `CentOS`_, + `Debian`_, `Fedora`_, `Gentoo`_, `gNewSense`_, `Mandriva`_, + `OpenSUSE`_, `Redhat/RHEL`_, `SuSE/SLES`_, `Trisquel`_ and + `Ubuntu`_. + +.. _GNU/Linux: http://www.gnu.org/gnu/Linux-and-gnu.html +.. _Blag: http://www.blagblagblag.org/ +.. _CentOS: http://www.centos.org/ +.. _Debian: http://www.debian.org/ +.. _Fedora: http://www.fedoraproject.org/ +.. _Gentoo: http://www.gentoo.org/ +.. _gNewSense: http://www.gnewsense.org/ +.. _Mandriva: http://www.mandriva.com/ +.. _OpenSUSE: http://opensuse.org/ +.. _Redhat/RHEL: http://www.redhat.com/rhel/ +.. _SuSE/SLES: http://www.novell.com/linux/ +.. _Trisquel: http://trisquel.info/ +.. _Ubuntu: http://www.ubuntu.com/ + +Bcfg2 should run on any POSIX compatible operating system, however +direct support for an operating system's package and service formats +are limited by the currently available :ref:`client-tools-index` +(new client tools are pretty easy to add). Check the :ref:`FAQ +` for a more exact list of platforms on which Bcfg2 +works`. -- cgit v1.2.3-1-g7c22