summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/1.0-roadmap53
-rw-r--r--doc/contents.txt1
-rw-r--r--doc/gettinghelp.txt23
-rw-r--r--doc/glossary.txt25
-rw-r--r--doc/index.txt33
5 files changed, 54 insertions, 81 deletions
diff --git a/doc/1.0-roadmap b/doc/1.0-roadmap
deleted file mode 100644
index 45814ba95..000000000
--- a/doc/1.0-roadmap
+++ /dev/null
@@ -1,53 +0,0 @@
-This document details the major work needed before Bcfg2 is ready for
-a 1.0 release. The high-level goal for 1.0 is to fix long-standing
-architecture warts and provide a reasonable internal API for the
-server.
-
-* Major Goals
-** Done
-*** Build a comprehensive server plugin architecture
-*** make out of tree plugins work
-*** properties switch to connector plugin
-*** Version Control Backend
-*** Change to mode attribute for services
-** Left
-*** Fix the POSIX path problem
-*** Clean up client/server statistics data format
-*** Multithreaded server (sync from Cobalt)
-*** Reporting System and Database
-*** add support for pre/post connectors
-**** Schema fixes
-**** Performance
-* Other Goals
-** ticket triage
-** bind failure annotations
-** plugin self-bootstrap (get out of bcfg2-admin init)
-** core plugin filtering (for bcfg2-admin & co)
-*** Document
-
-* Pie in the sky
-** Rework XMLRPC interfaces
-
-* User visible changes
-** Properties
-*** switched over to a connector interface
-*** now supports multiple file of XML
-*** data available as metadata.Properties[filename]
-** Probes
-*** switched over to a connector interface
-*** data available as metadata.Probes
-** Service changes
-*** Add overall client service mode
-**** default (perform all service manipulations)
-**** disabled (perform no service manipulations)
-**** build (attempt to stop all services started) (deprecates/replaces -B)
-*** Add per service mode
-**** mode='manual' (do not start/stop/restart this service)
-**** mode='default' (perform appropriate service ops)
-**** mode='supervised' (default + ensure service is running when verification is performed)
- (deprecates supervised='true')
-**** mode='custom' (set non-default restart target in conjunction with target attr)
-** Version Control backend
-*** Now implemented as plugins (Git, Svn)
-*** Enable either Git or Svn plugin in the plugins line of /etc/bcfg2.conf
-*** the svn option in /etc/bcfg2.conf is no longer respected
diff --git a/doc/contents.txt b/doc/contents.txt
index 4f0c1a1b2..f20919cbd 100644
--- a/doc/contents.txt
+++ b/doc/contents.txt
@@ -13,6 +13,7 @@ Welcome to Bcfg2's documentation!
getting_started/index
plugins/index
client/index
+ gettinghelp
unsorted/index
diff --git a/doc/gettinghelp.txt b/doc/gettinghelp.txt
new file mode 100644
index 000000000..03c146acc
--- /dev/null
+++ b/doc/gettinghelp.txt
@@ -0,0 +1,23 @@
+.. _gettinghelp:
+
+============
+Getting Help
+============
+
+Having trouble? We'd like to help!
+
+* Try the :ref:`FAQ <faq-index>` -- it's got answers to many common questions.
+
+* Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or the :ref:`detailed table of contents <contents>`.
+
+* Search for information in the `Bcfg2 mailing list archives`_.
+
+* 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
+
diff --git a/doc/glossary.txt b/doc/glossary.txt
index ec13364bf..baa523856 100644
--- a/doc/glossary.txt
+++ b/doc/glossary.txt
@@ -4,7 +4,26 @@
Glossary
========
-.. glossary::
+.. glossary:: :sorted:
- IRC Channel
- what now?
+ client
+
+ generator
+ A type of plugin which provides file contents. For example Cfg or TGenshi.
+
+ Genshi
+ A Python-based templating engine. `Genshi Homepage`_.
+
+
+ group
+ A "tag" assigned to a client through a probe or other plugin.
+
+ probe
+ A script that executes on a client machine and sets client metadata such as group membership.
+
+ profile
+ A special type of group that a client is explicitly assigned to.
+
+ structure
+
+.. _Genshi Homepage: http://genshi.edgewall.org/
diff --git a/doc/index.txt b/doc/index.txt
index ca96bfe1f..2256b5555 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -1,31 +1,11 @@
.. _index:
=====================
-Bcfg2's documentation
+Bcfg2 Manual (v1.0.1)
=====================
-Getting help
-============
-
-Having trouble? We'd like to help!
-
-* Try the :ref:`FAQ <faq-index>` -- it's got answers to many common questions.
-
-* Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or the :ref:`detailed table of contents <contents>`.
-
-* Search for information in the `Bcfg2 mailing list archives`_.
-
-* 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
-============
+What is Bcfg2?
+==============
Bcfg2 helps system administrators produce a consistent, reproducible,
and verifiable description of their environment, and offers
@@ -39,9 +19,9 @@ developed in the `Mathematics and Computer Science Division`_ of
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
+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
+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.
@@ -55,6 +35,9 @@ systems are constantly changing; if required in your environment,
Bcfg2 can enable the construction of complex change management and
deployment strategies.
+What Operating Systems Does Bcfg2 Support?
+==========================================
+
Bcfg2 is fairly portable. It has been successfully run on:
* `AIX`_, `FreeBSD`_, `OpenBSD`_, `Mac OS X`_, `OpenSolaris`_,