From 77d428d076837bf6b4b88b940ebf349d0a42621b Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 09:36:08 +0100 Subject: backup section added --- doc/server/admin/index.txt | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/server/admin/index.txt b/doc/server/admin/index.txt index e850d9df0..64461b278 100644 --- a/doc/server/admin/index.txt +++ b/doc/server/admin/index.txt @@ -12,12 +12,20 @@ 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. +backup +====== + +Create an archive of the whole Bcfg2 repository. The archive is stored +directly in your Bcfg2 repository (e.g. /var/lib/bcfg2):: + + bcfg2-admin backup client ====== -Create, delete, or modify client entries. +Create, delete, or modify client entries.:: + + bcfg2-admin client add compare ======= -- cgit v1.2.3-1-g7c22 From 56ce7a6f6dae3993f4dee89086fab7a178b32ab2 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 09:53:06 +0100 Subject: backup section added --- doc/server/admin/index.txt | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/server/admin/index.txt b/doc/server/admin/index.txt index 64461b278..d9f6f5a63 100644 --- a/doc/server/admin/index.txt +++ b/doc/server/admin/index.txt @@ -7,7 +7,7 @@ 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. @@ -15,7 +15,7 @@ functionality. Available modes are listed below. backup ====== -Create an archive of the whole Bcfg2 repository. The archive is stored +Create an archive of the whole Bcfg2 :term:`repository`. The archive is stored directly in your Bcfg2 repository (e.g. /var/lib/bcfg2):: bcfg2-admin backup @@ -23,10 +23,18 @@ directly in your Bcfg2 repository (e.g. /var/lib/bcfg2):: client ====== -Create, delete, or modify client entries.:: +Create, delete, list, or modify client entries. :: bcfg2-admin client add + +With ``list`` the file ``clients.xml`` will + + [root@conf01 ~]# bcfg2-admin client list + Failed to find IP address for desktop01.example.com + server01.example.com + laptop02.example.com + compare ======= -- cgit v1.2.3-1-g7c22 From 32a6e5544a0ee75dd6d7ec2d1e2838b5d5ff8ce9 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 10:40:43 +0100 Subject: bundle section added --- doc/server/admin/index.txt | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/index.txt b/doc/server/admin/index.txt index d9f6f5a63..b375b6cd1 100644 --- a/doc/server/admin/index.txt +++ b/doc/server/admin/index.txt @@ -15,11 +15,45 @@ functionality. Available modes are listed below. backup ====== +.. _Sample 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):: bcfg2-admin backup +A backup is recommanded before you start using the `Samples repository`_ of +Bcfg2. + + +bundle +====== + +'list-xml' lists all available xml bundles, 'list-genshi' lists 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 + + client ====== @@ -30,7 +64,7 @@ Create, delete, list, or modify client entries. :: With ``list`` the file ``clients.xml`` will - [root@conf01 ~]# bcfg2-admin client list + # bcfg2-admin client list Failed to find IP address for desktop01.example.com server01.example.com laptop02.example.com -- cgit v1.2.3-1-g7c22 From 01e24121644c0b34f36971db3b097d059a797622 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 10:42:41 +0100 Subject: doc: text changed for bundle section --- doc/server/admin/index.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/server/admin/index.txt b/doc/server/admin/index.txt index b375b6cd1..0dc238b31 100644 --- a/doc/server/admin/index.txt +++ b/doc/server/admin/index.txt @@ -29,8 +29,8 @@ Bcfg2. bundle ====== -'list-xml' lists all available xml bundles, 'list-genshi' lists all -available genshi bundles.:: +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 -- cgit v1.2.3-1-g7c22 From e260136cdf9c7a8b70b54a52ec2c5c35b2dbe9d3 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 11:04:34 +0100 Subject: doc: admin parts separated in single files --- doc/server/admin/backup.txt | 16 +++++ doc/server/admin/bundle.txt | 30 +++++++++ doc/server/admin/client.txt | 18 ++++++ doc/server/admin/compare.txt | 9 +++ doc/server/admin/index.txt | 140 +++++----------------------------------- doc/server/admin/init.txt | 8 +++ doc/server/admin/minestruct.txt | 8 +++ doc/server/admin/perf.txt | 8 +++ doc/server/admin/pull.txt | 9 +++ doc/server/admin/query.txt | 15 +++++ doc/server/admin/snapshots.txt | 8 +++ doc/server/admin/tidy.txt | 8 +++ doc/server/admin/viz.txt | 17 +++++ doc/server/admin/xcmd.txt | 8 +++ 14 files changed, 178 insertions(+), 124 deletions(-) create mode 100644 doc/server/admin/backup.txt create mode 100644 doc/server/admin/bundle.txt create mode 100644 doc/server/admin/client.txt create mode 100644 doc/server/admin/compare.txt create mode 100644 doc/server/admin/init.txt create mode 100644 doc/server/admin/minestruct.txt create mode 100644 doc/server/admin/perf.txt create mode 100644 doc/server/admin/pull.txt create mode 100644 doc/server/admin/query.txt create mode 100644 doc/server/admin/snapshots.txt create mode 100644 doc/server/admin/tidy.txt create mode 100644 doc/server/admin/viz.txt create mode 100644 doc/server/admin/xcmd.txt (limited to 'doc') diff --git a/doc/server/admin/backup.txt b/doc/server/admin/backup.txt new file mode 100644 index 000000000..81e1d970e --- /dev/null +++ b/doc/server/admin/backup.txt @@ -0,0 +1,16 @@ +.. -*- 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):: + + 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..97b8f157f --- /dev/null +++ b/doc/server/admin/client.txt @@ -0,0 +1,18 @@ +.. -*- mode: rst -*- + +.. _server-admin-client-index: + +client +====== + +Create, delete, list, or modify client entries. :: + + bcfg2-admin client add + + +With ``list`` the file ``clients.xml`` will + + # bcfg2-admin client list + Failed to find IP address for desktop01.example.com + server01.example.com + laptop02.example.com diff --git a/doc/server/admin/compare.txt b/doc/server/admin/compare.txt new file mode 100644 index 000000000..8101c7825 --- /dev/null +++ b/doc/server/admin/compare.txt @@ -0,0 +1,9 @@ +.. -*- mode: rst -*- + +.. _server-admin-compare-index: + +compare +======= + +Determine differences between files or directories of client +specification instances. diff --git a/doc/server/admin/index.txt b/doc/server/admin/index.txt index 0dc238b31..c04fb9772 100644 --- a/doc/server/admin/index.txt +++ b/doc/server/admin/index.txt @@ -12,127 +12,19 @@ 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. -backup -====== - -.. _Sample 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):: - - bcfg2-admin backup - -A backup is recommanded before you start using the `Samples repository`_ of -Bcfg2. - - -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 - - -client -====== - -Create, delete, list, or modify client entries. :: - - bcfg2-admin client add - - -With ``list`` the file ``clients.xml`` will - - # bcfg2-admin client list - Failed to find IP address for desktop01.example.com - server01.example.com - laptop02.example.com - -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..95b657c6d --- /dev/null +++ b/doc/server/admin/init.txt @@ -0,0 +1,8 @@ +.. -*- mode: rst -*- + +.. _server-admin-init-index: + +init +==== + +Interactively initialize a new repository. diff --git a/doc/server/admin/minestruct.txt b/doc/server/admin/minestruct.txt new file mode 100644 index 000000000..d6d1ea1b0 --- /dev/null +++ b/doc/server/admin/minestruct.txt @@ -0,0 +1,8 @@ +.. -*- mode: rst -*- + +.. _server-admin-minestruct-index: + +minestruct +========== + +Extract extra entry lists from statistics. diff --git a/doc/server/admin/perf.txt b/doc/server/admin/perf.txt new file mode 100644 index 000000000..922f173cd --- /dev/null +++ b/doc/server/admin/perf.txt @@ -0,0 +1,8 @@ +.. -*- mode: rst -*- + +.. _server-admin-perf-index: + +perf +==== + +Query server for performance data. diff --git a/doc/server/admin/pull.txt b/doc/server/admin/pull.txt new file mode 100644 index 000000000..225fdc6a2 --- /dev/null +++ b/doc/server/admin/pull.txt @@ -0,0 +1,9 @@ +.. -*- mode: rst -*- + +.. _server-admin-pull-index: + +pull +==== + +Integrate configuration information from clients into the server +repository. 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..17d919ffe --- /dev/null +++ b/doc/server/admin/viz.txt @@ -0,0 +1,17 @@ +.. -*- mode: rst -*- + +.. _server-admin-viz-index: + +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. diff --git a/doc/server/admin/xcmd.txt b/doc/server/admin/xcmd.txt new file mode 100644 index 000000000..ad652980b --- /dev/null +++ b/doc/server/admin/xcmd.txt @@ -0,0 +1,8 @@ +.. -*- mode: rst -*- + +.. _server-admin-xcmd-index: + +xcmd +==== + +XML-RPC Command Interface. -- cgit v1.2.3-1-g7c22 From 22d1b5d1f3b8a7b576d57cbb05e628f124032afe Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 11:18:43 +0100 Subject: doc: Added some more details about init --- doc/server/admin/init.txt | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/init.txt b/doc/server/admin/init.txt index 95b657c6d..f1aa9b755 100644 --- a/doc/server/admin/init.txt +++ b/doc/server/admin/init.txt @@ -5,4 +5,43 @@ init ==== -Interactively initialize a new repository. +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 + -- cgit v1.2.3-1-g7c22 From cf441e055526eea5ca2cf484b38b8ce742cc4924 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 14:40:49 +0100 Subject: doc: filename format modified --- doc/server/plugins/grouping/metadata.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/server/plugins/grouping/metadata.txt b/doc/server/plugins/grouping/metadata.txt index 96fc70ff5..10ccba397 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 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 | -- cgit v1.2.3-1-g7c22 From b0b5748911a44b782bb92d1b28342094fa0a2391 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 14:56:30 +0100 Subject: doc: note that graphviz is needed --- doc/server/admin/viz.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/viz.txt b/doc/server/admin/viz.txt index 17d919ffe..3556fd395 100644 --- a/doc/server/admin/viz.txt +++ b/doc/server/admin/viz.txt @@ -5,7 +5,8 @@ viz === -Produce graphviz diagrams of metadata structures. +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:: -- cgit v1.2.3-1-g7c22 From 193165b8cf4a901f5619f23c64877c4cef8b1818 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 15:04:29 +0100 Subject: doc: Detaisl about the name added --- doc/server/admin/backup.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/backup.txt b/doc/server/admin/backup.txt index 81e1d970e..1ed918082 100644 --- a/doc/server/admin/backup.txt +++ b/doc/server/admin/backup.txt @@ -8,7 +8,8 @@ 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):: +directly in your Bcfg2 repository (e.g. ``/var/lib/bcfg2/``) and named with +the current data and time:: bcfg2-admin backup -- cgit v1.2.3-1-g7c22 From 201c2a6a3da01f4c4cc6592f8b269cb1a9621027 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 15:09:59 +0100 Subject: doc: Link to metadata section added --- doc/server/admin/client.txt | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/server/admin/client.txt b/doc/server/admin/client.txt index 97b8f157f..cb3234a3e 100644 --- a/doc/server/admin/client.txt +++ b/doc/server/admin/client.txt @@ -7,12 +7,22 @@ client Create, delete, list, or modify client entries. :: - bcfg2-admin client add + bcfg2-admin client add attr1=val1 attr2=val2 +Allowed attributes are *profile*, *uuid*, *password*, *location*, *secure*, +and *address*. -With ``list`` the file ``clients.xml`` will +A full example is shown below:: - # bcfg2-admin client list - Failed to find IP address for desktop01.example.com + bcfg2-admin client add laptop02.example.com profile="basic" + +For more details please refer to the +:ref:`Metadata section `. + +With ``list`` the file ``clients.xml`` is parsed and all entries are shown:: + + bcfg2-admin client list server01.example.com laptop02.example.com + + -- cgit v1.2.3-1-g7c22 From 08f2bab8219cf8045997a56e9383f10f742c4c64 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 15:16:34 +0100 Subject: doc: format of the repo structure --- doc/server/admin/init.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/init.txt b/doc/server/admin/init.txt index f1aa9b755..9c5b97a76 100644 --- a/doc/server/admin/init.txt +++ b/doc/server/admin/init.txt @@ -33,7 +33,7 @@ detected or a default value is provided. :: subject=/C=US/ST=Illinois/L=Argonne/CN=conf01.example.com Getting Private key -A toplevel repository structure was created under the provided path. +A toplevel repository structure was created under the provided path.:: /var/lib/bcfg2 |-- Base -- cgit v1.2.3-1-g7c22 From 035a080e5a6b9fa882ab715b61da1f17f8d39357 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 15:18:01 +0100 Subject: doc: again a small layout change --- doc/server/admin/init.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/init.txt b/doc/server/admin/init.txt index 9c5b97a76..a80a6b721 100644 --- a/doc/server/admin/init.txt +++ b/doc/server/admin/init.txt @@ -33,7 +33,7 @@ detected or a default value is provided. :: subject=/C=US/ST=Illinois/L=Argonne/CN=conf01.example.com Getting Private key -A toplevel repository structure was created under the provided path.:: +A toplevel repository structure was created under the provided path. :: /var/lib/bcfg2 |-- Base -- cgit v1.2.3-1-g7c22 From c7113ff773794ae600f195b8c56f7486bd6b3f98 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 15:18:55 +0100 Subject: doc: it should be clear that this command needs root access --- doc/server/admin/init.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/init.txt b/doc/server/admin/init.txt index a80a6b721..3e36f09b5 100644 --- a/doc/server/admin/init.txt +++ b/doc/server/admin/init.txt @@ -8,7 +8,7 @@ init Interactively initialize a new repository. Most values are automatically detected or a default value is provided. :: - # bcfg2-admin init + 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): -- cgit v1.2.3-1-g7c22 From 680b561f6dc38062ebef6324ce0367b4cdcd9d15 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 15:22:14 +0100 Subject: doc: more details about compare added --- doc/server/admin/compare.txt | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/compare.txt b/doc/server/admin/compare.txt index 8101c7825..a12ce91be 100644 --- a/doc/server/admin/compare.txt +++ b/doc/server/admin/compare.txt @@ -6,4 +6,12 @@ compare ======= Determine differences between files or directories of client -specification instances. +specification instances.:: + + bcfg2-admin compare + +If you want to compare two directories recursivly then use ``-r`` as an +option. :: + + bcfg2-admin compare -r + -- cgit v1.2.3-1-g7c22 From 528fbacad8510e78dba20ba0d2ea317bcf20fc1d Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 15:27:32 +0100 Subject: doc: Content from man page added to minestruct --- doc/server/admin/minestruct.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/minestruct.txt b/doc/server/admin/minestruct.txt index d6d1ea1b0..ad0d0cbe2 100644 --- a/doc/server/admin/minestruct.txt +++ b/doc/server/admin/minestruct.txt @@ -5,4 +5,10 @@ minestruct ========== -Extract extra entry lists from statistics. +Extract extra entry lists from statistics. :: + + bcfg2-admin minestruct [-f xml-file] [-g groups] + +Hierarchy of groups in which to place the extra entries in can be determined +with ``-g ``. And ``-f `` specify the xml file in +which to write the extra entries. -- cgit v1.2.3-1-g7c22 From 3779a1cf9901c4f4104d3bd3029858c4775d48c9 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 16:29:36 +0100 Subject: doc: Some content from the wiki added to the server section --- doc/server/index.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'doc') diff --git a/doc/server/index.txt b/doc/server/index.txt index 0de02c400..7aec60ca4 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 -- cgit v1.2.3-1-g7c22 From 23e87a19e6bca6ca9a5b84fda523f5896aa71484 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 16:37:04 +0100 Subject: doc: Client section rearranged --- doc/client/index.txt | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) (limited to 'doc') 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 + -- cgit v1.2.3-1-g7c22 From 365b71e6381fcde157a0e79bdab517df650f2a57 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 18:35:05 +0100 Subject: doc: two examples added for xcmd --- doc/server/admin/xcmd.txt | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/xcmd.txt b/doc/server/admin/xcmd.txt index ad652980b..3f775c5ac 100644 --- a/doc/server/admin/xcmd.txt +++ b/doc/server/admin/xcmd.txt @@ -5,4 +5,20 @@ xcmd ==== -XML-RPC Command Interface. +XML-RPC Command Interface. :: + + xcmd + + +Those two examples can alos be found in the +:ref:`Package section ` + +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 + -- cgit v1.2.3-1-g7c22 From 3333f10f9d9c7ea52f2ddfd0767940170af66e61 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 18:37:18 +0100 Subject: doc: added a missing full stop --- doc/server/admin/xcmd.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/server/admin/xcmd.txt b/doc/server/admin/xcmd.txt index 3f775c5ac..d77b76a25 100644 --- a/doc/server/admin/xcmd.txt +++ b/doc/server/admin/xcmd.txt @@ -9,9 +9,8 @@ XML-RPC Command Interface. :: xcmd - Those two examples can alos be found in the -:ref:`Package section ` +:ref:`Package section `. To rebuild the packages plugin cache:: -- cgit v1.2.3-1-g7c22 From 619600a0e43bdfebad28802a6be4a65c6b3b37ae Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 18:45:13 +0100 Subject: doc: Another example added --- doc/server/admin/xcmd.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc') diff --git a/doc/server/admin/xcmd.txt b/doc/server/admin/xcmd.txt index d77b76a25..5a032127d 100644 --- a/doc/server/admin/xcmd.txt +++ b/doc/server/admin/xcmd.txt @@ -9,6 +9,10 @@ XML-RPC Command Interface. :: xcmd +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 `. -- cgit v1.2.3-1-g7c22 From 0b62fcafd4cf894df05317959aadd546023b1fe4 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 19:44:07 +0100 Subject: doc: bcfg2-info moved to server section --- doc/server/bcfg2-info.txt | 132 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 doc/server/bcfg2-info.txt (limited to 'doc') diff --git a/doc/server/bcfg2-info.txt b/doc/server/bcfg2-info.txt new file mode 100644 index 000000000..5f77a3c70 --- /dev/null +++ b/doc/server/bcfg2-info.txt @@ -0,0 +1,132 @@ +.. -*- mode: rst -*- + +.. _guide-using_bcfg2_info: + +================ +Using bcfg2-info +================ + +``bcfg2-info`` is a tool for introspecting server functions. It is +useful for understanding how the server is interpreting your +repository. It consists of the same logic executed by the server to +process the repository and produce configuration specifications, just +without all of the network communication code. Think of ``bcfg2-info`` +as ``bcfg2-server`` on a stick. It is a useful location to do testing +and staging of new configuration rules, prior to deployment. This is +particularly useful when developing templates, or developing Bcfg2 +plugins. + +Getting Started +=============== + +First, fire up the bcfg2-info interpreter. + +.. code-block:: none + + [0:464] bcfg2-info + Loading experimental plugin(s): Packages + NOTE: Interfaces subject to change + Handled 8 events in 0.006s + Handled 4 events in 0.035s + Welcome to bcfg2-info + Type "help" for more information + > + +At this point, the server core has been loaded up, all plugins have +been loaded, and the ``bcfg2-info`` has both read the initial state of +the Bcfg2 repository, as well as begun monitoring it for changes. Like +*bcfg2-server*, ``bcfg2-info`` monitors the repository for changes, +however, unlike *bcfg2-server*, it does not process change events +automatically. File modification events can be processed by explicitly +calling the **update** command. This will process the events, +displaying the number of events processed and the amount of time taken +by this processing. If no events are available, no message will be +displayed. For example, after a change to a file in the repository: + +.. code-block:: none + + >update + Handled 1 events in 0.001s + > update + > + +This explicit update process allows you to control the update process, +as well as see the precise changes caused by repository +modifications. + +``bcfg2-info`` has several builtin commands that display the state of +various internal server core state. These are most useful for +examining the state of client metadata, either for a single client, or +for clients overall. + +**clients** + displays a list of clients, along with their profile groups +**groups** + displays a list of groups, the inheritance hierarchy, profile + status, and category name, if there is one. +**showclient** + displays full metadata information for a client, including + profile group, group memberships, bundle list, and any connector + data, like Probe values or Property info. + +Debugging Configuration Rules +============================= + +In addition to the commands listed above for viewing client metadata, +there are also commands which can shed light on the configuration +generation process. Recall that configuration generation occurs in +three major steps: + +1) Resolve client metadata +2) Build list of entries for the configuration +3) Bind host-specific version of each entry + +Step *1* can be viewed with the commands presented in the previous +section. The latter two steps can be examined using the following +commands. + +**showentries** + displays a list of entries (optionally filtered by type) that + appear in a client's configuration specification + +**buildfile** + Perform the entry binding process on a single entry, displaying + its results. This command is very useful when developing + configuration file templates. + +**build** + Build the full configuration specification and write it to a + file. + +**mappings** + displays the entries handled by the plugins loaded by the server + core. This command is useful when the server reports a bind + failure for an entry. + +Debugging and Developing Bcfg2 +============================== + +``bcfg2-info`` loads a full Bcfg2 server core, so it provides the ideal +environment for developing and debugging Bcfg2. Because it is hard to +automate this sort of process, we have only implemented two commands +in ``bcfg2-info`` to aid in the process. + +**profile** + The profile command produces python profiling information for + other ``bcfg2-info`` commands. This can be used to track + performance problems in configuration generation. + +**debug** + The debug command exits the ``bcfg2-info`` interpreter loop and drops + to a python interpreter prompt. The Bcfg2 server core is available + in this namespace as "self". Full documentation for the server core + is out of scope for this document. This capability is most useful + to call into plugin methods, often with setup calls or the enabling + of diagnostics. + + It is possible to return to the ``bcfg2-info`` command loop by + exiting the python interpreter with ^D. + + There is built-in support for IPython in ``bcfg2-info``. If IPython + is installed, dropping into debug mode in ``bcfg2-info`` will use + the IPython interpreter by default. -- cgit v1.2.3-1-g7c22 From 90b95c01c447399337654680fb8a1fd6211c6b61 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 22:02:05 +0100 Subject: doc: Added a ref to bcfg2-info --- doc/server/admin/client.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/admin/client.txt b/doc/server/admin/client.txt index cb3234a3e..6790cc4d0 100644 --- a/doc/server/admin/client.txt +++ b/doc/server/admin/client.txt @@ -25,4 +25,7 @@ With ``list`` the file ``clients.xml`` is parsed and all entries are shown:: 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 ` +section for further details. -- cgit v1.2.3-1-g7c22 From 575ad2c4b3da92f38eb710aa79dd07fb37b9d1a1 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 23:34:09 +0100 Subject: doc: Small changes --- doc/appendix/guides/using-bcfg2-info.txt | 132 ------------------------------- doc/client/tools.txt | 32 ++++++++ doc/client/tools/index.txt | 32 -------- doc/getting_help/faq/client.txt | 10 +++ doc/server/admin/perf.txt | 4 +- doc/server/index.txt | 1 + 6 files changed, 46 insertions(+), 165 deletions(-) delete mode 100644 doc/appendix/guides/using-bcfg2-info.txt create mode 100644 doc/client/tools.txt delete mode 100644 doc/client/tools/index.txt (limited to 'doc') diff --git a/doc/appendix/guides/using-bcfg2-info.txt b/doc/appendix/guides/using-bcfg2-info.txt deleted file mode 100644 index 5f77a3c70..000000000 --- a/doc/appendix/guides/using-bcfg2-info.txt +++ /dev/null @@ -1,132 +0,0 @@ -.. -*- mode: rst -*- - -.. _guide-using_bcfg2_info: - -================ -Using bcfg2-info -================ - -``bcfg2-info`` is a tool for introspecting server functions. It is -useful for understanding how the server is interpreting your -repository. It consists of the same logic executed by the server to -process the repository and produce configuration specifications, just -without all of the network communication code. Think of ``bcfg2-info`` -as ``bcfg2-server`` on a stick. It is a useful location to do testing -and staging of new configuration rules, prior to deployment. This is -particularly useful when developing templates, or developing Bcfg2 -plugins. - -Getting Started -=============== - -First, fire up the bcfg2-info interpreter. - -.. code-block:: none - - [0:464] bcfg2-info - Loading experimental plugin(s): Packages - NOTE: Interfaces subject to change - Handled 8 events in 0.006s - Handled 4 events in 0.035s - Welcome to bcfg2-info - Type "help" for more information - > - -At this point, the server core has been loaded up, all plugins have -been loaded, and the ``bcfg2-info`` has both read the initial state of -the Bcfg2 repository, as well as begun monitoring it for changes. Like -*bcfg2-server*, ``bcfg2-info`` monitors the repository for changes, -however, unlike *bcfg2-server*, it does not process change events -automatically. File modification events can be processed by explicitly -calling the **update** command. This will process the events, -displaying the number of events processed and the amount of time taken -by this processing. If no events are available, no message will be -displayed. For example, after a change to a file in the repository: - -.. code-block:: none - - >update - Handled 1 events in 0.001s - > update - > - -This explicit update process allows you to control the update process, -as well as see the precise changes caused by repository -modifications. - -``bcfg2-info`` has several builtin commands that display the state of -various internal server core state. These are most useful for -examining the state of client metadata, either for a single client, or -for clients overall. - -**clients** - displays a list of clients, along with their profile groups -**groups** - displays a list of groups, the inheritance hierarchy, profile - status, and category name, if there is one. -**showclient** - displays full metadata information for a client, including - profile group, group memberships, bundle list, and any connector - data, like Probe values or Property info. - -Debugging Configuration Rules -============================= - -In addition to the commands listed above for viewing client metadata, -there are also commands which can shed light on the configuration -generation process. Recall that configuration generation occurs in -three major steps: - -1) Resolve client metadata -2) Build list of entries for the configuration -3) Bind host-specific version of each entry - -Step *1* can be viewed with the commands presented in the previous -section. The latter two steps can be examined using the following -commands. - -**showentries** - displays a list of entries (optionally filtered by type) that - appear in a client's configuration specification - -**buildfile** - Perform the entry binding process on a single entry, displaying - its results. This command is very useful when developing - configuration file templates. - -**build** - Build the full configuration specification and write it to a - file. - -**mappings** - displays the entries handled by the plugins loaded by the server - core. This command is useful when the server reports a bind - failure for an entry. - -Debugging and Developing Bcfg2 -============================== - -``bcfg2-info`` loads a full Bcfg2 server core, so it provides the ideal -environment for developing and debugging Bcfg2. Because it is hard to -automate this sort of process, we have only implemented two commands -in ``bcfg2-info`` to aid in the process. - -**profile** - The profile command produces python profiling information for - other ``bcfg2-info`` commands. This can be used to track - performance problems in configuration generation. - -**debug** - The debug command exits the ``bcfg2-info`` interpreter loop and drops - to a python interpreter prompt. The Bcfg2 server core is available - in this namespace as "self". Full documentation for the server core - is out of scope for this document. This capability is most useful - to call into plugin methods, often with setup calls or the enabling - of diagnostics. - - It is possible to return to the ``bcfg2-info`` command loop by - exiting the python interpreter with ^D. - - There is built-in support for IPython in ``bcfg2-info``. If IPython - is installed, dropping into debug mode in ``bcfg2-info`` will use - the IPython interpreter by default. diff --git a/doc/client/tools.txt b/doc/client/tools.txt new file mode 100644 index 000000000..7f6e6b667 --- /dev/null +++ b/doc/client/tools.txt @@ -0,0 +1,32 @@ +.. -*- mode: rst -*- + +.. _client-tools-index: + +Available client tools +====================== + +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 far we have tools that primarily deal with packaging systems +and service management. The POSIX tool also handles file system +and permissions/groups operations. To write your own tool driver, +to handle a new packaging format, or new service architecture see +:ref:`development-client-driver`. + +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`` 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: + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/doc/client/tools/index.txt b/doc/client/tools/index.txt deleted file mode 100644 index 7f6e6b667..000000000 --- a/doc/client/tools/index.txt +++ /dev/null @@ -1,32 +0,0 @@ -.. -*- mode: rst -*- - -.. _client-tools-index: - -Available client tools -====================== - -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 far we have tools that primarily deal with packaging systems -and service management. The POSIX tool also handles file system -and permissions/groups operations. To write your own tool driver, -to handle a new packaging format, or new service architecture see -:ref:`development-client-driver`. - -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`` 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: - -.. toctree:: - :maxdepth: 1 - :glob: - - * diff --git a/doc/getting_help/faq/client.txt b/doc/getting_help/faq/client.txt index a230a84bb..aa9743048 100644 --- a/doc/getting_help/faq/client.txt +++ b/doc/getting_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/perf.txt b/doc/server/admin/perf.txt index 922f173cd..74ac5051a 100644 --- a/doc/server/admin/perf.txt +++ b/doc/server/admin/perf.txt @@ -5,4 +5,6 @@ perf ==== -Query server for performance data. +Query server for performance data. :: + + bcfg2-admin perf diff --git a/doc/server/index.txt b/doc/server/index.txt index 7aec60ca4..caf90598d 100644 --- a/doc/server/index.txt +++ b/doc/server/index.txt @@ -26,3 +26,4 @@ clients. configurationentries info snapshots/index + bcfg2-info -- cgit v1.2.3-1-g7c22 From 18b3b41b3f993b2dd5a10e1bbb8abf959c57c4e2 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 12 Dec 2010 23:34:43 +0100 Subject: doc: Added some more details --- doc/appendix/guides/fedora.txt | 19 +++++++++++++++---- doc/server/admin/pull.txt | 16 +++++++++++++++- 2 files changed, 30 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/appendix/guides/fedora.txt b/doc/appendix/guides/fedora.txt index f3a5a3929..ea0068b38 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/server/admin/pull.txt b/doc/server/admin/pull.txt index 225fdc6a2..d33347f6f 100644 --- a/doc/server/admin/pull.txt +++ b/doc/server/admin/pull.txt @@ -6,4 +6,18 @@ pull ==== Integrate configuration information from clients into the server -repository. +repository. :: + + bcfg2-admin pull [-v] [-f][-I] [-s] + +The following options are available: + + +``-v`` verbose +``-f`` force +``-I`` interactive +``-s`` stdin + +A full example is shown below. :: + + bcfg2-admin pull -- cgit v1.2.3-1-g7c22