summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/appendix/guides/fedora.txt19
-rw-r--r--doc/client/index.txt18
-rw-r--r--doc/client/tools.txt (renamed from doc/client/tools/index.txt)0
-rw-r--r--doc/help/faq/client.txt10
-rw-r--r--doc/server/admin/backup.txt17
-rw-r--r--doc/server/admin/bundle.txt30
-rw-r--r--doc/server/admin/client.txt31
-rw-r--r--doc/server/admin/compare.txt17
-rw-r--r--doc/server/admin/index.txt92
-rw-r--r--doc/server/admin/init.txt47
-rw-r--r--doc/server/admin/minestruct.txt14
-rw-r--r--doc/server/admin/perf.txt10
-rw-r--r--doc/server/admin/pull.txt23
-rw-r--r--doc/server/admin/query.txt15
-rw-r--r--doc/server/admin/snapshots.txt8
-rw-r--r--doc/server/admin/tidy.txt8
-rw-r--r--doc/server/admin/viz.txt18
-rw-r--r--doc/server/admin/xcmd.txt27
-rw-r--r--doc/server/bcfg2-info.txt (renamed from doc/appendix/guides/using-bcfg2-info.txt)0
-rw-r--r--doc/server/index.txt13
-rw-r--r--doc/server/plugins/grouping/metadata.txt10
21 files changed, 329 insertions, 98 deletions
diff --git a/doc/appendix/guides/fedora.txt b/doc/appendix/guides/fedora.txt
index d8d3b1b34..91d36cd25 100644
--- a/doc/appendix/guides/fedora.txt
+++ b/doc/appendix/guides/fedora.txt
@@ -15,12 +15,22 @@ This is a complete getting started guide for Fedora. With this
document you should be able to install a Bcfg2 server, a Bcfg2 client,
and change the ``/etc/motd`` file on the client.
+Prerequisites
+=============
+
+To setup a configuration management system based on Bcfg2 only a few
+prerequisites need to be fullfilled.
+
+* A server machine that can host the Bcfg2
+* Internet access for the installation process
+* A working network with DNS
+
+
Install Bcfg2 From RPM
======================
The fastest way to get Bcfg2 onto your system is to use ``yum``
-or PackageKit. ``
-um`` will pull all dependencies of Bcfg2
+or PackageKit. ``yum`` will pull all dependencies of Bcfg2
automatically in. ::
$ su -c 'yum install bcfg2-server bcfg2'
@@ -28,6 +38,7 @@ automatically in. ::
Your system should now have the necessary software to use Bcfg2.
The next step is to set up your Bcfg2 :term:`repository`.
+
Initialize your repository
==========================
@@ -45,7 +56,7 @@ is a tool which allows you to automate this:
What is the server's hostname: [config01.local.net]
Input the server location [https://config01.local.net:6789]:
Input base Operating System for clients:
- 1: Redhat/Fedora/RHEL/RHAS/Centos
+ 1: Red Hat/Fedora/RHEL/RHAS/Centos
2: SUSE/SLES
3: Mandrake
4: Debian
@@ -68,7 +79,7 @@ Change responses as necessary.
Start the server
================
-You are now ready to start your bcfg2 server for the first time::
+You are now ready to start your Bcfg2 server for the first time::
$ su -c '/etc/init.d/bcfg2-server start'
Starting Configuration Management Server: bcfg2-server [ OK ]
diff --git a/doc/client/index.txt b/doc/client/index.txt
index 5e6551387..4da039385 100644
--- a/doc/client/index.txt
+++ b/doc/client/index.txt
@@ -23,22 +23,12 @@ client, for a few reasons:
deployment engine that can be driven by anything that writes a
compatible configuration description.
-Available client tools
-----------------------
-
-.. toctree::
- :maxdepth: 2
- :glob:
-
- tools/*
-
-Other client-related documentation
-----------------------------------
-
.. toctree::
:maxdepth: 2
+ modes
+ tools
+ metadata
agent
debugging
- metadata
- modes
+
diff --git a/doc/client/tools/index.txt b/doc/client/tools.txt
index 9bec46316..9bec46316 100644
--- a/doc/client/tools/index.txt
+++ b/doc/client/tools.txt
diff --git a/doc/help/faq/client.txt b/doc/help/faq/client.txt
index 8eb04e620..746b0201d 100644
--- a/doc/help/faq/client.txt
+++ b/doc/help/faq/client.txt
@@ -14,3 +14,13 @@ on the client. Then add the following on the client.::
[communication]
ca = /etc/bcfg2.ca
+
+**Server failure**
+
+On Fedora 14 and above it can happen that no connection is possible.
+
+ # bcfg2 -vqne
+ Server failure: Protocol Error: 401 Unauthorized
+ Failed to download probes from bcfg2
+ Server Failure
+
diff --git a/doc/server/admin/backup.txt b/doc/server/admin/backup.txt
new file mode 100644
index 000000000..1ed918082
--- /dev/null
+++ b/doc/server/admin/backup.txt
@@ -0,0 +1,17 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-backup-index:
+
+backup
+======
+
+.. _Samples repository: https://github.com/solj/bcfg2-repo
+
+Create an archive of the whole Bcfg2 :term:`repository`. The archive is stored
+directly in your Bcfg2 repository (e.g. ``/var/lib/bcfg2/``) and named with
+the current data and time::
+
+ bcfg2-admin backup
+
+A backup is recommanded before you start using the `Samples repository`_ of
+Bcfg2.
diff --git a/doc/server/admin/bundle.txt b/doc/server/admin/bundle.txt
new file mode 100644
index 000000000..0d3ada923
--- /dev/null
+++ b/doc/server/admin/bundle.txt
@@ -0,0 +1,30 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-bundle-index:
+
+bundle
+======
+
+For a list of all available xml bundles use ``list-xml``. ``list-genshi``
+will list all available genshi bundles.::
+
+ # bcfg2-admin bundle list-xml
+ # bcfg2-admin bundle list-genshi
+
+``show`` provides an interactive dialog to get details about the available
+bundles.::
+
+ # bcfg2-admin bundle show
+ Available bundles (Number of bundles: 4)
+ ----------------------------------------
+ [0] motd.xml
+ [1] snmpd.xml
+ [2] bcfg2.xml
+ [3] ntp.xml
+ Enter the line number of a bundle for details: 3
+ Details for the "ntp" bundle:
+ Package: xntp
+ Path: /etc/sysconfig/xntp
+ Path: /etc/sysconfig/clock
+ Path: /etc/ntp.conf
+ Service: xntpd
diff --git a/doc/server/admin/client.txt b/doc/server/admin/client.txt
new file mode 100644
index 000000000..6790cc4d0
--- /dev/null
+++ b/doc/server/admin/client.txt
@@ -0,0 +1,31 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-client-index:
+
+client
+======
+
+Create, delete, list, or modify client entries. ::
+
+ bcfg2-admin client add <client> attr1=val1 attr2=val2
+
+Allowed attributes are *profile*, *uuid*, *password*, *location*, *secure*,
+and *address*.
+
+A full example is shown below::
+
+ bcfg2-admin client add laptop02.example.com profile="basic"
+
+For more details please refer to the
+:ref:`Metadata section <server-plugins-grouping-metadata>`.
+
+With ``list`` the file ``clients.xml`` is parsed and all entries are shown::
+
+ bcfg2-admin client list
+ server01.example.com
+ laptop02.example.com
+
+This is useful for a quick check after adding an entry. If you want more
+in-depth information about a client, ``bcfg2-client clients`` can provide
+that. Please refer to the :ref:`bcfg2-info <guide-server-bcfg2_info>`
+section for further details.
diff --git a/doc/server/admin/compare.txt b/doc/server/admin/compare.txt
new file mode 100644
index 000000000..a12ce91be
--- /dev/null
+++ b/doc/server/admin/compare.txt
@@ -0,0 +1,17 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-compare-index:
+
+compare
+=======
+
+Determine differences between files or directories of client
+specification instances.::
+
+ bcfg2-admin compare <file1> <file2>
+
+If you want to compare two directories recursivly then use ``-r`` as an
+option. ::
+
+ bcfg2-admin compare -r <dir1> <dir2>
+
diff --git a/doc/server/admin/index.txt b/doc/server/admin/index.txt
index e850d9df0..c04fb9772 100644
--- a/doc/server/admin/index.txt
+++ b/doc/server/admin/index.txt
@@ -7,82 +7,24 @@ Admin
=====
The ``bcfg2-admin`` command provides you an interface which allows you
-to interact with your Bcfg2 repository in an administrative fashion. To
+to interact with your Bcfg2 :term:`repository` in an administrative fashion. To
get started, run ``bcfg2-admin help``. You will be presented with a list
of different *modes* which each provide various administrative
functionality. Available modes are listed below.
-FIXME: Need examples for each command listed below.
-
-client
-======
-
-Create, delete, or modify client entries.
-
-compare
-=======
-
-Determine differences between files or directories of client
-specification instances.
-
-init
-====
-
-Interactively initialize a new repository.
-
-minestruct
-==========
-
-Extract extra entry lists from statistics.
-
-perf
-====
-
-Query server for performance data.
-
-pull
-====
-
-Integrate configuration information from clients into the server
-repository.
-
-query
-=====
-
-Query clients.
-
-The default result format is suitable for consumption by `pdsh`_.
-This example queries the server for all clients in the *ubuntu* group::
-
- bcfg2-admin query g=ubuntu
-
-.. _pdsh: http://sourceforge.net/projects/pdsh/
-
-snapshots
-=========
-
-Interact with the Snapshots system.
-
-tidy
-====
-
-Clean up useless files in the repo.
-
-viz
-===
-
-Produce graphviz diagrams of metadata structures.
-
-The following command will produce a graphviz image which includes hosts,
-bundles, and a key::
-
- bcfg2-admin viz -H -b -k -o ~/bcfg2.png
-
-.. note:: The graphviz package available via DAG/RPMforge has been known
- to have dependency issues. We recommend installing the package
- from EPEL.
-
-xcmd
-====
-
-XML-RPC Command Interface.
+.. toctree::
+ :maxdepth: 1
+
+ backup
+ bundle
+ client
+ compare
+ init
+ minestruct
+ perf
+ pull
+ query
+ snapshots
+ tidy
+ viz
+ xcmd
diff --git a/doc/server/admin/init.txt b/doc/server/admin/init.txt
new file mode 100644
index 000000000..3e36f09b5
--- /dev/null
+++ b/doc/server/admin/init.txt
@@ -0,0 +1,47 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-init-index:
+
+init
+====
+
+Interactively initialize a new repository. Most values are automatically
+detected or a default value is provided. ::
+
+ bcfg2-admin init
+ Store bcfg2 configuration in [/etc/bcfg2.conf]:
+ Location of bcfg2 repository [/var/lib/bcfg2]:
+ Input password used for communication verification (without echoing; leave blank for a random):
+ What is the server's hostname [conf01.example.com]:
+ Input the server location [https://conf01.example.com:6789]:
+ Input base Operating System for clients:
+ 1: Red Hat/Fedora/RHEL/RHAS/Centos
+ 2: SUSE/SLES
+ 3: Mandrake
+ 4: Debian
+ 5: Ubuntu
+ 6: Gentoo
+ 7: FreeBSD
+ : 1
+
+ Generating a 2048 bit RSA private key
+ .....................+++
+ .....................+++
+ writing new private key to '/etc/bcfg2.key'
+ -----
+ Signature ok
+ subject=/C=US/ST=Illinois/L=Argonne/CN=conf01.example.com
+ Getting Private key
+
+A toplevel repository structure was created under the provided path. ::
+
+ /var/lib/bcfg2
+ |-- Base
+ |-- Bundler
+ |-- Cfg
+ |-- etc
+ |-- Metadata
+ |-- Pkgmgr
+ |-- Rules
+ `-- SSHbase
+
diff --git a/doc/server/admin/minestruct.txt b/doc/server/admin/minestruct.txt
new file mode 100644
index 000000000..ad0d0cbe2
--- /dev/null
+++ b/doc/server/admin/minestruct.txt
@@ -0,0 +1,14 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-minestruct-index:
+
+minestruct
+==========
+
+Extract extra entry lists from statistics. ::
+
+ bcfg2-admin minestruct <client> [-f xml-file] [-g groups]
+
+Hierarchy of groups in which to place the extra entries in can be determined
+with ``-g <groups>``. And ``-f <xml-output-file>`` specify the xml file in
+which to write the extra entries.
diff --git a/doc/server/admin/perf.txt b/doc/server/admin/perf.txt
new file mode 100644
index 000000000..74ac5051a
--- /dev/null
+++ b/doc/server/admin/perf.txt
@@ -0,0 +1,10 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-perf-index:
+
+perf
+====
+
+Query server for performance data. ::
+
+ bcfg2-admin perf
diff --git a/doc/server/admin/pull.txt b/doc/server/admin/pull.txt
new file mode 100644
index 000000000..d33347f6f
--- /dev/null
+++ b/doc/server/admin/pull.txt
@@ -0,0 +1,23 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-pull-index:
+
+pull
+====
+
+Integrate configuration information from clients into the server
+repository. ::
+
+ bcfg2-admin pull [-v] [-f][-I] [-s] <client> <entry type> <entry name>
+
+The following options are available:
+
+
+``-v`` verbose
+``-f`` force
+``-I`` interactive
+``-s`` stdin
+
+A full example is shown below. ::
+
+ bcfg2-admin pull
diff --git a/doc/server/admin/query.txt b/doc/server/admin/query.txt
new file mode 100644
index 000000000..f617239ab
--- /dev/null
+++ b/doc/server/admin/query.txt
@@ -0,0 +1,15 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-query-index:
+
+query
+=====
+
+Query clients.
+
+The default result format is suitable for consumption by `pdsh`_.
+This example queries the server for all clients in the *ubuntu* group::
+
+ bcfg2-admin query g=ubuntu
+
+.. _pdsh: http://sourceforge.net/projects/pdsh/
diff --git a/doc/server/admin/snapshots.txt b/doc/server/admin/snapshots.txt
new file mode 100644
index 000000000..0336944ec
--- /dev/null
+++ b/doc/server/admin/snapshots.txt
@@ -0,0 +1,8 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-snapshots-index:
+
+snapshots
+=========
+
+Interact with the Snapshots system.
diff --git a/doc/server/admin/tidy.txt b/doc/server/admin/tidy.txt
new file mode 100644
index 000000000..deff43bf6
--- /dev/null
+++ b/doc/server/admin/tidy.txt
@@ -0,0 +1,8 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-tidy-index:
+
+tidy
+====
+
+Clean up useless files in the repo.
diff --git a/doc/server/admin/viz.txt b/doc/server/admin/viz.txt
new file mode 100644
index 000000000..3556fd395
--- /dev/null
+++ b/doc/server/admin/viz.txt
@@ -0,0 +1,18 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-viz-index:
+
+viz
+===
+
+Produce graphviz diagrams of metadata structures. Make sure that the
+graphviz package is installed.
+
+The following command will produce a graphviz image which includes hosts,
+bundles, and a key::
+
+ bcfg2-admin viz -H -b -k -o ~/bcfg2.png
+
+.. note:: The graphviz package available via DAG/RPMforge has been known
+ to have dependency issues. We recommend installing the package
+ from EPEL.
diff --git a/doc/server/admin/xcmd.txt b/doc/server/admin/xcmd.txt
new file mode 100644
index 000000000..5a032127d
--- /dev/null
+++ b/doc/server/admin/xcmd.txt
@@ -0,0 +1,27 @@
+.. -*- mode: rst -*-
+
+.. _server-admin-xcmd-index:
+
+xcmd
+====
+
+XML-RPC Command Interface. ::
+
+ xcmd <xmlrpc method> <optional arguments>
+
+For debbbuging the following command can help::
+
+ bcfg2-admin xcmd Metadata.toggle_debug
+
+Those two examples can alos be found in the
+:ref:`Package section <server-plugins-generators-packages>`.
+
+To rebuild the packages plugin cache::
+
+ bcfg2-admin xcmd Packages.Refresh
+
+To perform a soft reload to reread the configuration file and
+download only missing sources.::
+
+ bcfg2-admin xcmd Packages.Reload
+
diff --git a/doc/appendix/guides/using-bcfg2-info.txt b/doc/server/bcfg2-info.txt
index b2354652f..b2354652f 100644
--- a/doc/appendix/guides/using-bcfg2-info.txt
+++ b/doc/server/bcfg2-info.txt
diff --git a/doc/server/index.txt b/doc/server/index.txt
index 0de02c400..caf90598d 100644
--- a/doc/server/index.txt
+++ b/doc/server/index.txt
@@ -6,6 +6,18 @@
The Bcfg2 Server
================
+The Bcfg2 server is responsible for taking a network description and
+turning it into a series of configuration specifications for particular
+clients. It also manages probed data and tracks statistics for clients.
+
+The Bcfg2 server takes information from two sources when generating client
+configuration specifications. The first is a pool of metadata that describes
+clients as members of an aspect-based classing system. That is, clients are
+defined in terms of aspects of their behavior. The other is a file system
+repository that contains mappings from metadata to literal configuration.
+These are combined to form the literal configuration specifications for
+clients.
+
.. toctree::
:maxdepth: 2
@@ -14,3 +26,4 @@ The Bcfg2 Server
configurationentries
info
snapshots/index
+ bcfg2-info
diff --git a/doc/server/plugins/grouping/metadata.txt b/doc/server/plugins/grouping/metadata.txt
index fc452eb2f..071d4239d 100644
--- a/doc/server/plugins/grouping/metadata.txt
+++ b/doc/server/plugins/grouping/metadata.txt
@@ -10,8 +10,8 @@ The metadata mechanism has two types of information, client metadata and
group metadata. The client metadata describes which top level group a
client is associated with.The group metadata describes groups in terms
of what bundles and other groups they include. Each aspect grouping
-and clients' memberships are reflected in the Metadata/groups.xml and
-Metadata/clients.xml files, respectively.
+and clients' memberships are reflected in the ``Metadata/groups.xml`` and
+``Metadata/clients.xml`` files, respectively.
Usage of Groups in Metadata
===========================
@@ -22,13 +22,13 @@ groups. Client membership of all other groups is by those groups being
associated with the profile or public groups. This file can be indirectly
modified from clients through use of the -p flag to bcfg2.
-Clients are associated with profile groups in Metadata/clients.xml as
+Clients are associated with profile groups in ``Metadata/clients.xml`` as
shown below.
Metadata/clients.xml
====================
-The Metadata/clients.xml file contains the mappings of Profile Groups
+The ``Metadata/clients.xml`` file contains the mappings of Profile Groups
to clients. The file is just a series of <Client /> tags, each of which
describe one host. A sample file is below:
@@ -58,7 +58,7 @@ The Clients tag has the following possible attributes:
Client Tag
----------
-Each entry in clients.xml **must** have the following properties:
+Each entry in ``clients.xml`` **must** have the following properties:
+---------+---------------------------------------+--------+
| Name | Description | Values |