summaryrefslogtreecommitdiffstats
path: root/doc/server
diff options
context:
space:
mode:
authorSol Jerome <solj@ices.utexas.edu>2010-04-10 16:20:14 -0500
committerSol Jerome <solj@ices.utexas.edu>2010-04-10 16:20:14 -0500
commit1999c74bba44c20c37c70d93245e02305a44652a (patch)
treecfd461689888753990d0e3f48c673663f42f3ddd /doc/server
parentb5a201ea431cc3cf33c77364bb0bbf33716401bd (diff)
downloadbcfg2-1999c74bba44c20c37c70d93245e02305a44652a.tar.gz
bcfg2-1999c74bba44c20c37c70d93245e02305a44652a.tar.bz2
bcfg2-1999c74bba44c20c37c70d93245e02305a44652a.zip
doc: Style consistency updates
Signed-off-by: Sol Jerome <solj@ices.utexas.edu>
Diffstat (limited to 'doc/server')
-rw-r--r--doc/server/configurationentries.txt2
-rw-r--r--doc/server/plugins/generators/decisions.txt2
-rw-r--r--doc/server/plugins/generators/hostbase.txt12
-rw-r--r--doc/server/plugins/generators/nagiosgen.txt6
-rw-r--r--doc/server/plugins/generators/sshbase.txt4
-rw-r--r--doc/server/plugins/index.txt4
-rw-r--r--doc/server/reports/dynamic.txt15
-rw-r--r--doc/server/reports/static.txt8
8 files changed, 24 insertions, 29 deletions
diff --git a/doc/server/configurationentries.txt b/doc/server/configurationentries.txt
index b07f8de2a..393984771 100644
--- a/doc/server/configurationentries.txt
+++ b/doc/server/configurationentries.txt
@@ -48,7 +48,7 @@ a device, directory, hardlink, symlink, etc), then you will specify both
the *type* and any other necessary attributes in `Rules`_.
.. note:: A tool for converting old POSIX entries is available in the
- bcfg2 source directory at tools/posixunified.py
+ Bcfg2 source directory at tools/posixunified.py
+-------------+----------------------+-----------------+--------------------------+
| Type | Replacement/New | Description | Attributes |
diff --git a/doc/server/plugins/generators/decisions.txt b/doc/server/plugins/generators/decisions.txt
index 52e5c316e..5c7332dfb 100644
--- a/doc/server/plugins/generators/decisions.txt
+++ b/doc/server/plugins/generators/decisions.txt
@@ -22,7 +22,7 @@ should be corrected during the current run of the installation tool. The
Decision plugin is the only stock plugin that generates entries for
client's whitelists or blacklists.
-The Decision plugin uses a directory in the bcfg2 repository called
+The Decision plugin uses a directory in the Bcfg2 repository called
Decisions. Files in the Decisions subdirectory are named similarly to
files managed by Cfg, probes, TCheetah, and TGenshi. File basenames
are either whitelist or blacklist. These files have a simple format;
diff --git a/doc/server/plugins/generators/hostbase.txt b/doc/server/plugins/generators/hostbase.txt
index bf28e401d..c6007f70e 100644
--- a/doc/server/plugins/generators/hostbase.txt
+++ b/doc/server/plugins/generators/hostbase.txt
@@ -138,11 +138,11 @@ Enable the Hostbase plugin
--------------------------
Now that the database is accessible and there is some data in it, you can
-enable the Hostbase plugin on your bcfg2 server to start generating some
+enable the Hostbase plugin on your Bcfg2 server to start generating some
configuration files. All that needs to be done is to add ``Hostbase``
to the end of the list of generators in your bcfg2.conf file. To see
-what's being generated by Hostbase, fire up a bcfg2 development server:
-``bcfg2-info``. For more information on how to use the bcfg2 development
+what's being generated by Hostbase, fire up a Bcfg2 development server:
+``bcfg2-info``. For more information on how to use the Bcfg2 development
server, type help at the prompt. For our purposes, type ``debug``.
This will bring you to an interactive python prompt where you can access
bcfg's core data.
@@ -190,7 +190,7 @@ in the database. This can be done through and XMLRPC function
available from the Bcfg2 server. From a client that is configured
to receive one or more hostbase bundles, you'll need to first
edit your ``python/site-packages/Bcfg2/Client/Proxy.py`` file.
-Add ``'Hostbase.rebuildState'`` to the list of methods in the bcfg2
+Add ``'Hostbase.rebuildState'`` to the list of methods in the Bcfg2
client proxy object. The modified list is shown below:
.. code-block:: python
@@ -200,9 +200,9 @@ client proxy object. The modified list is shown below:
name = 'bcfg2'
methods = ['AssertProfile', 'GetConfig', 'GetProbes', 'RecvProbeData', 'RecvStats', 'Hostbase.rebuildState']
-Now copy the file ``hostbasepush.py`` from ``bcfg2/tools`` in the bcfg2
+Now copy the file ``hostbasepush.py`` from ``bcfg2/tools`` in the Bcfg2
source to your machine. When this command is run as root, it triggers
-the Hostbase to rebuild it's files, then runs the bcfg2 client on your
+the Hostbase to rebuild it's files, then runs the Bcfg2 client on your
local machine to grab the new configs.
NIS Authentication
diff --git a/doc/server/plugins/generators/nagiosgen.txt b/doc/server/plugins/generators/nagiosgen.txt
index f6362dbdd..64b9c02fa 100644
--- a/doc/server/plugins/generators/nagiosgen.txt
+++ b/doc/server/plugins/generators/nagiosgen.txt
@@ -120,7 +120,7 @@ add services, and commands specific to the hostgroup (Bcfg2 group) in
hostgroup_name web-server
}
-Create a nagios bcfg2 bundle /var/lib/bcfg2/Bundler/nagios.xml
+Create a nagios Bcfg2 bundle ``/var/lib/bcfg2/Bundler/nagios.xml``
.. code-block:: xml
@@ -166,6 +166,6 @@ Update nagios configuration file to use nagiosgen.cfg::
cfg_file=/etc/nagios/nagiosgen.cfg
Note that some of these files are built on demand, each time a client
-in group "nagios-server" checks in with the bcfg2 server. Local nagios
-instances can be configured to use the !NagiosGen directory in the bcfg2
+in group "nagios-server" checks in with the Bcfg2 server. Local nagios
+instances can be configured to use the !NagiosGen directory in the Bcfg2
repository directly.
diff --git a/doc/server/plugins/generators/sshbase.txt b/doc/server/plugins/generators/sshbase.txt
index ec378956d..6abb05ed9 100644
--- a/doc/server/plugins/generators/sshbase.txt
+++ b/doc/server/plugins/generators/sshbase.txt
@@ -6,7 +6,7 @@
SSHbase
=======
-SSHbase is a purpose build bcfg2 plugin for managing ssh host keys. It
+SSHbase is a purpose build Bcfg2 plugin for managing ssh host keys. It
is responsible for making ssh keys persist beyond a client rebuild and
building a proper ssh_known_hosts file, including a correct localhost
record for the current system.
@@ -47,7 +47,7 @@ Getting started
===============
#. Add SSHbase to the **plugins** line in ``/etc/bcfg2.conf`` and
- restart the server -- This enables the SSHbase plugin in the bcfg2
+ restart the server -- This enables the SSHbase plugin on the Bcfg2
server.
#. Add Path entries for ``/etc/ssh/ssh_known_hosts``, and
diff --git a/doc/server/plugins/index.txt b/doc/server/plugins/index.txt
index 8035f3c31..126331325 100644
--- a/doc/server/plugins/index.txt
+++ b/doc/server/plugins/index.txt
@@ -18,8 +18,8 @@ perform one of several tasks:
Enabling Plugins
================
-In order for the bcfg2 server to use a plugin, it needs to be listed on
-the *plugins* line in bcfg2.conf.
+In order for the Bcfg2 server to use a plugin, it needs to be listed on
+the *plugins* line in ``bcfg2.conf``.
Default Plugins
===============
diff --git a/doc/server/reports/dynamic.txt b/doc/server/reports/dynamic.txt
index 88319d263..6345e724d 100644
--- a/doc/server/reports/dynamic.txt
+++ b/doc/server/reports/dynamic.txt
@@ -20,7 +20,7 @@ Prerequisites
Install
-------
-Be sure to include the specified fields included the example bcfg2.conf
+Be sure to include the specified fields included the example ``bcfg2.conf``
file. These can be specified in either ``/etc/bcfg2.conf``, if it is readable
by the webserver user, or ``/etc/bcfg2-web.conf``.
@@ -32,9 +32,9 @@ If you are not using sqlite (the default choice), please see the
:ref:`alternative-databases` section below.
The recommended statistics plugin is DBStats. To use it, add it to the
-``plugins`` line in your bcfg2.conf.
+**plugins** line in your ``bcfg2.conf``.
-Restart the bcfg2 server. Run a client in dryrun mode in order to get
+Restart the Bcfg2 server. Run a client in dryrun mode in order to get
the client's statistics loaded into the database.
.. _dynamic-http-install:
@@ -124,13 +124,8 @@ Apache conf::
Notes on Alternative Databases
------------------------------
-If you choose to use a different database, you'll need to edit settings.py
-from inside of the brpt module. Instructions on this process can be found
-on the Django website. The provided sqlite database file is pre-populated
-with the appropriate tables, if you choose a different database engine,
-you will need to run "python manage.py syncdb" from the brpt module
-directory to configure it before importing any data. As of vers 0.9.5,
-these settings are moved to the more appropriate /etc/bcfg2.conf
+If you choose to use a different database, you'll need to edit
+``/etc/bcfg2.conf``.
Summary and Features
====================
diff --git a/doc/server/reports/static.txt b/doc/server/reports/static.txt
index 0767a6b2d..d5d96fe12 100644
--- a/doc/server/reports/static.txt
+++ b/doc/server/reports/static.txt
@@ -43,11 +43,11 @@ record most of the data that users would like.
Setup
=====
-In order to configure your bcfg2 server for receiving reports, you
+In order to configure your Bcfg2 server for receiving reports, you
will need to list the Statistics plugin in the plugins line of your
-bcfg2.conf (starting in 1.0). You will also need a [statistics] section
-in your bcfg2.conf. You can find out more about what goes there in the
-bcfg2.conf manpage.
+``bcfg2.conf``. You will also need a [statistics] section
+in your ``bcfg2.conf``. You can find out more about what goes there in the
+``bcfg2.conf`` manpage.
Output
======