From 232476219e69afc14647892250bba08a3118a7e7 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Thu, 14 Apr 2011 09:22:26 -0500 Subject: doc: Fix some documentation issues (#980) Signed-off-by: Sol Jerome --- doc/appendix/guides/centos.txt | 8 ++++++-- doc/appendix/guides/converging_rhel5.txt | 2 +- doc/appendix/guides/fedora.txt | 8 ++++++-- 3 files changed, 13 insertions(+), 5 deletions(-) (limited to 'doc/appendix') diff --git a/doc/appendix/guides/centos.txt b/doc/appendix/guides/centos.txt index d89d532ba..525cb5a98 100644 --- a/doc/appendix/guides/centos.txt +++ b/doc/appendix/guides/centos.txt @@ -431,7 +431,7 @@ packages. Currently, the way to manage them is using :ref:`BoundEntries .. code-block:: xml - + @@ -452,6 +452,10 @@ packages. Currently, the way to manage them is using :ref:`BoundEntries +.. note:: + + version="foo" is just a dummy attribute for the gpg-pubkey Package + To actually push the gpg keys out via Bcfg2, you will need to manage the files as well. This can be done by adding Path entries for each of the gpg keys you want to manage @@ -461,7 +465,7 @@ gpg keys you want to manage - + diff --git a/doc/appendix/guides/converging_rhel5.txt b/doc/appendix/guides/converging_rhel5.txt index 7581d307f..d6a9d2d1c 100644 --- a/doc/appendix/guides/converging_rhel5.txt +++ b/doc/appendix/guides/converging_rhel5.txt @@ -81,7 +81,7 @@ For a "Package" - + diff --git a/doc/appendix/guides/fedora.txt b/doc/appendix/guides/fedora.txt index 4e3244eaa..12432b04f 100644 --- a/doc/appendix/guides/fedora.txt +++ b/doc/appendix/guides/fedora.txt @@ -339,7 +339,7 @@ Bundle now looks like this .. code-block:: xml - + @@ -360,6 +360,10 @@ Bundle now looks like this +.. note:: + + version="foo" is just a dummy attribute for the gpg-pubkey Package + To actually push the gpg keys out via Bcfg2, you will need to manage the files as well. This can be done by adding Path entries for each of the gpg keys you want to manage @@ -369,7 +373,7 @@ of the gpg keys you want to manage - + -- cgit v1.2.3-1-g7c22 From 2f43b62afa1eee5bd0868bec709ffddc92e22c8b Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 20 Apr 2011 19:31:18 -0500 Subject: doc: Make magic groups documentation clearer Signed-off-by: Sol Jerome --- doc/appendix/guides/centos.txt | 16 ++++++++++------ doc/appendix/guides/fedora.txt | 17 +++++++++++------ doc/appendix/guides/ubuntu.txt | 15 ++++++++++----- 3 files changed, 31 insertions(+), 17 deletions(-) (limited to 'doc/appendix') diff --git a/doc/appendix/guides/centos.txt b/doc/appendix/guides/centos.txt index 525cb5a98..119c3d2f8 100644 --- a/doc/appendix/guides/centos.txt +++ b/doc/appendix/guides/centos.txt @@ -211,13 +211,17 @@ line of ``bcfg2.conf``. Then create Packages layout (as per -Due to the `Magic Groups`_, we need to modify our Metadata. Let's -add a **centos5.4** group which inherits a **centos** group -(this should replace the existing **redhat** group) present in -``/var/lib/bcfg2/Metadata/groups.xml``. The resulting file should look -something like this +Due to the :ref:`server-plugins-generators-packages-magic-groups`, +we need to modify our Metadata. Let's add a **centos5.4** group which +inherits a **centos** group (this should replace the existing **redhat** +group) present in ``/var/lib/bcfg2/Metadata/groups.xml``. The resulting +file should look something like this -.. _Magic Groups: http://trac.mcs.anl.gov/projects/bcfg2/wiki/Plugins/Packages#MagicGroups +.. note:: + + The reason we are creating a release-specific group in this case is + that the YUMSource above is specific to the 5.4 release of centos. + That is, it should not apply to other releases (5.1, 5.3, etc). .. code-block:: xml diff --git a/doc/appendix/guides/fedora.txt b/doc/appendix/guides/fedora.txt index 12432b04f..e8c1af7b6 100644 --- a/doc/appendix/guides/fedora.txt +++ b/doc/appendix/guides/fedora.txt @@ -216,13 +216,18 @@ mirror near your location according the `Mirror list`_ . -.. _Magic Groups: http://trac.mcs.anl.gov/projects/bcfg2/wiki/Plugins/Packages#MagicGroups -Due to the `Magic Groups`_, we need to modify our Metadata. Let's -add a **fedora13** group which inherits a **fedora** group -(this should replace the existing **redhat** group) present in -``/var/lib/bcfg2/Metadata/groups.xml``. The resulting file should look -something like this +Due to the :ref:`server-plugins-generators-packages-magic-groups`, +we need to modify our Metadata. Let's add a **fedora13** group which +inherits a **fedora** group (this should replace the existing **redhat** +group) present in ``/var/lib/bcfg2/Metadata/groups.xml``. The resulting +file should look something like this + +.. note:: + + The reason we are creating a release-specific group in this case is + that the YUMSource above is specific to the 13th release of fedora. + That is, it should not apply to other releases (14, 15, etc). .. code-block:: xml diff --git a/doc/appendix/guides/ubuntu.txt b/doc/appendix/guides/ubuntu.txt index 24338c6d2..56480796d 100644 --- a/doc/appendix/guides/ubuntu.txt +++ b/doc/appendix/guides/ubuntu.txt @@ -169,12 +169,17 @@ Create Packages layout (as per :ref:`packages-exampleusage`) in -Due to the `Magic Groups`_, we need to modify our Metadata. Let's add -an **ubuntu-lucid** group which inherits the **ubuntu** group already -present in ``/var/lib/bcfg2/Metadata/groups.xml``. The resulting file -should look something like this +Due to the :ref:`server-plugins-generators-packages-magic-groups`, +we need to modify our Metadata. Let's add an **ubuntu-lucid** +group which inherits the **ubuntu** group already present in +``/var/lib/bcfg2/Metadata/groups.xml``. The resulting file should look +something like this -.. _Magic Groups: http://trac.mcs.anl.gov/projects/bcfg2/wiki/Plugins/Packages#MagicGroups +.. note:: + + The reason we are creating a release-specific group in this case is + that the APTSource above is specific to the lucid release of ubuntu. + That is, it should not apply to other releases (hardy, maverick, etc). .. code-block:: xml -- cgit v1.2.3-1-g7c22 From 6da7d24710fe67c80c4a71f227cd01675eebca88 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 21 Apr 2011 08:50:06 -0400 Subject: Lots of cleanup for bcfg2-repo-validate rewrite: * Changed all references to bcfg2-repo-validate in the documentation to bcfg2-lint * Wrote man pages for bcfg2-lint and bcfg2-lint.conf * Cleaned up straggling references to bcfg2-repo-validate in Makefiles, spec files, and the POSIX tool * A few minor bug fixes --- doc/appendix/guides/centos.txt | 2 +- doc/appendix/guides/fedora.txt | 3 +-- doc/appendix/guides/import-existing-ssh-keys.txt | 2 +- doc/appendix/guides/ubuntu.txt | 2 +- 4 files changed, 4 insertions(+), 5 deletions(-) (limited to 'doc/appendix') diff --git a/doc/appendix/guides/centos.txt b/doc/appendix/guides/centos.txt index 119c3d2f8..dae11e5d4 100644 --- a/doc/appendix/guides/centos.txt +++ b/doc/appendix/guides/centos.txt @@ -244,7 +244,7 @@ file should look something like this .. note:: When editing your xml files by hand, it is useful to occasionally run - `bcfg2-repo-validate` to ensure that your xml validates properly. + `bcfg2-lint` to ensure that your xml validates properly. The final thing we need is for the client to have the proper arch group membership. For this, we will make use of the diff --git a/doc/appendix/guides/fedora.txt b/doc/appendix/guides/fedora.txt index e8c1af7b6..db23e94bf 100644 --- a/doc/appendix/guides/fedora.txt +++ b/doc/appendix/guides/fedora.txt @@ -249,8 +249,7 @@ file should look something like this .. note:: When editing your xml files by hand, it is useful to occasionally - run ``bcfg2-repo-validate`` to ensure that your xml validates - properly. + run ``bcfg2-lint`` to ensure that your xml validates properly. Add a probe +++++++++++ diff --git a/doc/appendix/guides/import-existing-ssh-keys.txt b/doc/appendix/guides/import-existing-ssh-keys.txt index e606ba908..64a1b62cd 100644 --- a/doc/appendix/guides/import-existing-ssh-keys.txt +++ b/doc/appendix/guides/import-existing-ssh-keys.txt @@ -46,7 +46,7 @@ Validate your repository Validation can be performed using the following command:: - bcfg2-repo-validate -v + bcfg2-lint Run the bcfg2 client ==================== diff --git a/doc/appendix/guides/ubuntu.txt b/doc/appendix/guides/ubuntu.txt index 56480796d..ff87e7d97 100644 --- a/doc/appendix/guides/ubuntu.txt +++ b/doc/appendix/guides/ubuntu.txt @@ -202,7 +202,7 @@ something like this .. note:: When editing your xml files by hand, it is useful to occasionally run - `bcfg2-repo-validate` to ensure that your xml validates properly. + `bcfg2-lint` to ensure that your xml validates properly. The last thing we need is for the client to have the proper arch group membership. For this, we will make use of the -- cgit v1.2.3-1-g7c22 From 5481b93ae68bdf2f13ed80c821761fbf87a568e2 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Thu, 21 Apr 2011 17:28:42 -0500 Subject: doc: Add security and updates repositories (Reported by Kevin Bowling on IRC) These are enabled by default on Ubuntu installs, so it makes sense to add them here in case the dependency paths are different. Signed-off-by: Sol Jerome --- doc/appendix/guides/ubuntu.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'doc/appendix') diff --git a/doc/appendix/guides/ubuntu.txt b/doc/appendix/guides/ubuntu.txt index ff87e7d97..86f82d0b8 100644 --- a/doc/appendix/guides/ubuntu.txt +++ b/doc/appendix/guides/ubuntu.txt @@ -167,6 +167,26 @@ Create Packages layout (as per :ref:`packages-exampleusage`) in amd64 i386 + + lucid + http://archive.ubuntu.com/ubuntu + lucid-updates + main + multiverse + restricted + universe + amd64 + + + lucid + http://security.ubuntu.com/ubuntu + lucid-security + main + multiverse + restricted + universe + amd64 + Due to the :ref:`server-plugins-generators-packages-magic-groups`, -- cgit v1.2.3-1-g7c22 From ca22f61e441563e46ac668c007fc10bb9e9694a9 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Sat, 23 Apr 2011 21:54:21 -0500 Subject: doc: Add documentation for bootstrapping new clients Signed-off-by: Sol Jerome --- doc/appendix/guides/bootstrap.txt | 39 +++++++++++++++++++++++++++++++++++++++ doc/appendix/guides/centos.txt | 5 +++++ doc/appendix/guides/ubuntu.txt | 17 +++++++++++------ 3 files changed, 55 insertions(+), 6 deletions(-) create mode 100644 doc/appendix/guides/bootstrap.txt (limited to 'doc/appendix') diff --git a/doc/appendix/guides/bootstrap.txt b/doc/appendix/guides/bootstrap.txt new file mode 100644 index 000000000..b9b5f318e --- /dev/null +++ b/doc/appendix/guides/bootstrap.txt @@ -0,0 +1,39 @@ +.. -*- mode: rst -*- + +.. _appendix-guides-bootstrap: + +========= +Bootstrap +========= + +Once you have your bcfg2 server setup and working, a common next step to +take is automating the addition of new clients. + +The method for bootstrapping your clients will vary depending on your +needs. The simplest way to go about this is to create a public default +group in ``Metadata/groups.xml``. Example: + +.. code-block:: xml + + + +This allows clients to freely associate themselves with this group so that +you will not be required to manually add them to ``Metadata/clients.xml`` +prior to running the client. + +.. note:: + + Reverse DNS will need to work in order to automate the process of + bootstrapping clients without first adding them to + ``Metadata/clients.xml``. + +There are command line options available on the client which allow +you to specify the options that are normally found in the client's +``/etc/bcfg2.conf``:: + + bcfg2 -x password -p basic -S https://bcfg2-server:6789 + +The above command will add the client to ``Metadata/clients.xml`` with the +profile *basic*. Generally, the configuration given to the client by the +bcfg2 server in this initial run will include the ``/etc/bcfg2.conf`` file +so that the client won't need to specify these options on future runs. diff --git a/doc/appendix/guides/centos.txt b/doc/appendix/guides/centos.txt index dae11e5d4..d788891de 100644 --- a/doc/appendix/guides/centos.txt +++ b/doc/appendix/guides/centos.txt @@ -586,3 +586,8 @@ Dynamic (web) reports ===================== See installation instructions at :ref:`reports-dynamic` + +Next Steps +========== + +:ref:`getting_started-index-next-steps` diff --git a/doc/appendix/guides/ubuntu.txt b/doc/appendix/guides/ubuntu.txt index 86f82d0b8..a597a5492 100644 --- a/doc/appendix/guides/ubuntu.txt +++ b/doc/appendix/guides/ubuntu.txt @@ -506,13 +506,8 @@ Now we run the client and see there are no more unmanaged entries! :: managed. Please see :ref:`unsorted-writing_specification` for more details. -Dynamic (web) reports -===================== - -See installation instructions at :ref:`appendix-guides-web-reports-install` - Upstart -======= +^^^^^^^ Upstart services are defined like this: @@ -526,3 +521,13 @@ Some Upstart services require additional parameters, like network-interface and + +Dynamic (web) reports +===================== + +See installation instructions at :ref:`appendix-guides-web-reports-install` + +Next Steps +========== + +:ref:`getting_started-index-next-steps` -- cgit v1.2.3-1-g7c22 From 0168732743ea6ae76c65b32e7f91dc92582871b2 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Sat, 14 May 2011 16:15:25 -0500 Subject: doc: Fix groups in centos guide (#1006) Signed-off-by: Sol Jerome --- doc/appendix/guides/centos.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/appendix') diff --git a/doc/appendix/guides/centos.txt b/doc/appendix/guides/centos.txt index d788891de..0b5b83211 100644 --- a/doc/appendix/guides/centos.txt +++ b/doc/appendix/guides/centos.txt @@ -195,17 +195,17 @@ line of ``bcfg2.conf``. Then create Packages layout (as per - centos5.4 + centos-5.4 http://mrepo/centos5-x86_64/RPMS.os x86_64 - centos5.4 + centos-5.4 http://mrepo/centos5-x86_64/RPMS.updates x86_64 - centos5.4 + centos-5.4 http://mrepo/centos5-x86_64/RPMS.extras x86_64 @@ -227,9 +227,9 @@ file should look something like this - + - + -- cgit v1.2.3-1-g7c22