From 7c6c1e10f3cc62acc919123d0067a8a9720aeffa Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Sun, 24 Jan 2010 18:47:00 +0000 Subject: doc: Add a lot more unsorted stuff from the wiki Signed-off-by: Sol Jerome git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5703 ce84e21b-d406-0410-9b95-82705330c041 --- doc/client/debugging.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/client/debugging.txt (limited to 'doc/client/debugging.txt') diff --git a/doc/client/debugging.txt b/doc/client/debugging.txt new file mode 100644 index 000000000..c99e73c3e --- /dev/null +++ b/doc/client/debugging.txt @@ -0,0 +1,24 @@ +.. -*- mode: rst -*- + +.. _client-debugging: + +================ +Client Debugging +================ + +When working on the Bcfg2 client, it is helpful to employ a few specific techniques to isolate and remedy problems. + +First, running the client with the -f flag allows configuration from a local file, rather than querying the server. This helps rule out server configuration problems, and allows for rapid development. For example: `bcfg2 -f test-config.conf` with the following test-config.conf: + +.. code-block:: rst + + + + + + + +Next, it is important to look at the interactive mode. This is similar to the interactive mode on the server and provides an interactive Python interpreter with which one may manipulate all the objects in the client. It will setup all the infrastructure so you will have the appropriate objects to play with. It will run the client through once, then present you with an interpreter. Try it out with: `python -i /usr/bin/bcfg2` or, for more fun, a local config file and also enable Debugging and Verbose output with `-d` and `-v`, yielding `python -i /usr/bin/bcfg2 -d -v -f test-config.conf` + +Now we just explore; use `dir()` to examine different objects in the client, or run a reconfiguration again by calling `client.run()` + -- cgit v1.2.3-1-g7c22