diff options
Diffstat (limited to 'doc/client')
-rw-r--r-- | doc/client/agent.txt | 10 | ||||
-rw-r--r-- | doc/client/index.txt | 27 | ||||
-rw-r--r-- | doc/client/modes.txt | 4 | ||||
-rw-r--r-- | doc/client/tools/apt.txt | 6 | ||||
-rw-r--r-- | doc/client/tools/index.txt | 10 | ||||
-rw-r--r-- | doc/client/tools/yumng.txt | 8 |
6 files changed, 36 insertions, 29 deletions
diff --git a/doc/client/agent.txt b/doc/client/agent.txt index eec66964f..ef152133e 100644 --- a/doc/client/agent.txt +++ b/doc/client/agent.txt @@ -8,11 +8,11 @@ Agent Functionality using SSH The Bcfg2 agent code provides the ability to trigger a client update from the server using a secure mechanism that is restricted to running -the bcfg2 client with the options the agent was started with. This same +the Bcfg2 client with the options the agent was started with. This same capability is provided by SSH keypairs, if properly configured. Setup is pretty easy: -#. Create an ssh keypair that is to be used solely for triggering bcfg2 +#. Create an ssh keypair that is to be used solely for triggering Bcfg2 client runs. This key may or may not have a password associated with it; a keyphrase will make things more secure, but will require a person to enter the key passphrase, so it will not be usable automatically.:: @@ -29,8 +29,8 @@ is pretty easy: command="/usr/sbin/bcfg2 -q <other options>",no-port-forwarding,no-X11-forwarding,no-pty,no-agent-forwarding,from="<bcfg2-server ipaddr>" <pub key> - This key is now only useful to call the bcfg2 client, from the - bcfg2-server's ip address. If PermitRootLogin was set to no in + This key is now only useful to call the Bcfg2 client, from the + Bcfg2 server's ip address. If PermitRootLogin was set to no in sshd_config, you will need to set it to forced-commands-only. Adding a & to the end of the command will cause the command to immediately return. @@ -41,7 +41,7 @@ is pretty easy: Note that you will not be able to alter the command line options from the ones specified in authorized_keys in any way. Also, it is not - needed that the invocation of bcfg2 in the ssh command match. The + needed that the invocation of Bcfg2 in the ssh command match. The following will have the same result.:: $ ssh -i /path/to/key root@client /bin/true diff --git a/doc/client/index.txt b/doc/client/index.txt index 536bedfbb..5e6551387 100644 --- a/doc/client/index.txt +++ b/doc/client/index.txt @@ -5,10 +5,11 @@ 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: +The Bcfg2 client attempts to reconcile the current configuration state +with the configuration passed down from the server using various client +tools. It 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. @@ -22,16 +23,22 @@ architecture, as opposed to one with a smarter 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: - agent - debugging - metadata - modes + tools/* + +Other client-related documentation +---------------------------------- .. toctree:: :maxdepth: 2 - :glob: - tools/* + agent + debugging + metadata + modes diff --git a/doc/client/modes.txt b/doc/client/modes.txt index f3f48ca38..55aec34e7 100644 --- a/doc/client/modes.txt +++ b/doc/client/modes.txt @@ -33,7 +33,7 @@ How do I use it? #. In the Bcfg2 repository, put `paranoid='true'` in the ``info.xml`` file. #. On the client, create ``/var/cache/bcfg2`` (or specify an alternate - path in the [paranoid] section of /etc/bcfg2). + path in the [paranoid] section of ``/etc/bcfg2``). #. On the client, run `bcfg2` with the `-P` option (alternatively, you can set *paranoid* to *true* in the **[client]** section of ``bcfg2.conf``). @@ -47,7 +47,7 @@ Extra configuration ------------------- Here is an example of how to use the extra paranoid features available -in 1.0. For the following section in bcfg2.conf:: +in 1.0. For the following section in ``bcfg2.conf``:: [paranoid] path = /my/custom/backup/path diff --git a/doc/client/tools/apt.txt b/doc/client/tools/apt.txt index dba359e4a..8ce997007 100644 --- a/doc/client/tools/apt.txt +++ b/doc/client/tools/apt.txt @@ -2,9 +2,9 @@ .. _client-tools-apt: -===================== -Bcfg2 APT Client Tool -===================== +=============== +APT Client Tool +=============== The APT tool allows you to configure custom options in ``bcfg2.conf`` for systems where the tools reside in non-standard locations. The diff --git a/doc/client/tools/index.txt b/doc/client/tools/index.txt index a613b9d40..878a221ee 100644 --- a/doc/client/tools/index.txt +++ b/doc/client/tools/index.txt @@ -5,7 +5,7 @@ Client Tool Drivers =================== -Client tool drivers allow bcfg2 to execute configuration operations by +Client tool drivers allow Bcfg2 to execute configuration operations by interfacing with platform and distribution specific tools. Tool drivers handle any reconfiguration or verification operation. So @@ -16,21 +16,21 @@ operations. To write your own tool driver, to handle a new packaging format, or new service architecture see :ref:`development-index-writingtooldrivers` -When the bcfg2 client is run, it attempts to instantiate each of these +When the Bcfg2 client is run, it attempts to instantiate each of these drivers. The succeeding list of drivers are printed as a debug message after this process has completed. Drivers can supercede one another, for example, the Yum driver conflicts (and unloads) the RPM driver. This -behavior can be overridden by running the bcfg2 client with the -D +behavior can be overridden by running the Bcfg2 client with the -D flag. This flag takes a colon delimited list of drivers to use on the system. -Currently these are the tool drivers that are distributed with bcfg2: +Currently these are the tool drivers that are distributed with Bcfg2: Action ------ Pre and post-install tests and actions. This driver executes commands -and supplies status information to the bcfg2 server via the statistics +and supplies status information to the Bcfg2 server via the statistics mechanism. It can also be used to prevent bundle installation when pre-conditions are not met. See the UsingActions page for more details. diff --git a/doc/client/tools/yumng.txt b/doc/client/tools/yumng.txt index 07706ad8b..c3b645a4f 100644 --- a/doc/client/tools/yumng.txt +++ b/doc/client/tools/yumng.txt @@ -74,7 +74,7 @@ RPMng.VerifyPackages() ---------------------- The RPMng.VerifyPackages method generates a number of structures that -record the state of the of the system compared to the bcfg2 literal +record the state of the of the system compared to the Bcfg2 literal configuration retrieved from the server. These structures are mainly used by the RPMng.Install method. @@ -150,7 +150,7 @@ From the command line:: This produces quite a bit of output so you may want to redirect the output to a file for review. -In the bcfg2.conf file:: +In the ``bcfg2.conf`` file:: [client] #drivers = Action,Chkconfig,POSIX,YUMng @@ -411,7 +411,7 @@ the clients abstract configuration. The gpg-pubkey package/instance is treated as an install only package. gpg-pubkey packages are installed by the RPMng driver with the rpm -import command. -gpg-pubkey packages will be removed by bcfg2 -r packages if they are +gpg-pubkey packages will be removed by ``bcfg2 -r packages`` if they are not in the clients configuration. .. code-block:: xml @@ -752,7 +752,7 @@ For RPMng a minimal entry is verify_fail_action ^^^^^^^^^^^^^^^^^^ -The way I have bcfg2 configured for my development systems. This way +The way I have Bcfg2 configured for my development systems. This way it reports bad, but doesn't do anything about it. .. code-block:: xml |