doc: Add documentation for bootstrapping new clients

Signed-off-by: Sol Jerome <sol.jerome@gmail.com>

6 files changed, 66 insertions, 55 deletions

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
+
+    <Group profile='true' name='basic' public='true' default='true'>
+
+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
 
     <Service name="network-interface" status="on" type="upstart" parameters="INTERFACE=eth0"/>
     <Service name="bridge-network-interface" status="on" type="upstart" parameters="INTERFACE=br0"/>
+
+Dynamic (web) reports
+=====================
+
+See installation instructions at :ref:`appendix-guides-web-reports-install`
+
+Next Steps
+==========
+
+:ref:`getting_started-index-next-steps`
diff --git a/doc/getting_started/index.txt b/doc/getting_started/index.txt
index b256edd2d..65ac296f7 100644
--- a/doc/getting_started/index.txt
+++ b/doc/getting_started/index.txt
@@ -223,11 +223,13 @@ you will find that we now have a correct entry::
 
 Done! Now we just have 242 (or more) entries to take care of!
 
-:ref:`server-plugins-structures-bundler-index` is a relatively easy
-directory to populate. You can find many samples of Bundles in the
-`Bundle Repository`_, many of which can be used without editing.
+:ref:`server-plugins-structures-bundler-index` is a
+relatively easy directory to populate. You can find many
+samples of Bundles in the :ref:`Bundler Example Repository
+<server-plugins-structures-bundler-index-examples>`, many of which can
+be used without editing.
 
-.. _Bundle Repository: http://docs.bcfg2.org/server/plugins/structures/bundler/index.html#other-examples
+.. _getting_started-index-next-steps:
 
 Next Steps
 ==========
@@ -247,6 +249,9 @@ Run ``bcfg2-info``, and type help and the prompt when it comes up.
 ``bcfg2-admin`` can perform a variety of repository maintenance
 tasks. Run ``bcfg2-admin`` help for details.
 
+Once you have the server setup, you may be interested in
+:ref:`bootstrapping <appendix-guides-bootstrap>` additional clients.
+
 Platform-specific Quickstart Notes
 ==================================
 
diff --git a/doc/server/plugins/structures/bundler/index.txt b/doc/server/plugins/structures/bundler/index.txt
index c84d6cdbe..9fd897385 100644
--- a/doc/server/plugins/structures/bundler/index.txt
+++ b/doc/server/plugins/structures/bundler/index.txt
@@ -228,6 +228,8 @@ The latter form is preferred if the if block contains multiple
 files. While this example is simple, the test in the if block can in
 fact be any python statement.
 
+.. _server-plugins-structures-bundler-index-examples:
+
 Other examples
 ==============
 
diff --git a/doc/unsorted/help.txt b/doc/unsorted/help.txt
deleted file mode 100644
index 155dbf77c..000000000
--- a/doc/unsorted/help.txt
+++ /dev/null
@@ -1,45 +0,0 @@
-.. -*- mode: rst -*-
-
-.. _unsorted-help:
-
-================
-Ways to get help
-================
-
-Interactive Help
-================
-
-* [wiki:IRCChannel IRC Channel, with indexed archives]
-* [wiki:MailingList Mailing list, with indexed archives]
-
-Note that the IRC channel tends to be much busier than the mailing list; use whichever seems most appropriate for your query, but don't let the lack of mailing list activity make you think the project isn't active.
-
-Frequently Asked Questions
-==========================
-
-* [wiki:FAQ The FAQ]
-
-Examples
-========
-
-* There are examples sprinkled throughout this wiki; we should link to them from here.
-* The [http://www.fsf.org Free Software Foundation] is (very slowly) working towards having configurations for the majority of the machines it administers available via [http://config.fsf.org config.fsf.org]. This is a tie-in with the [http://autonomo.us/2008/07/franklin-street-statement/ Franklin Street Statement on Freedom and Network Services] (FSF offices are on Franklin Street). Documentation on how to have a public access Bcfg2 configuration repository will be at PublicRepository.
-
-Manuals
-=======
-
-* The current canonical source of documentation are pages on this wiki ([wiki:UsingBcfg2]). Please mail the MailingList for editor access to this wiki.
-* There is a printed manual in the SAGE short topics series, "!#19: Configuration Management with Bcfg2", that you can [https://db.usenix.org/cgi-bin/sage/booklets/order.cgi order] for $20 (or get for free if you are a [http://www.sage.org/index.html SAGE] member and haven't gotten a booklet yet during your current membership year). The book includes documentation up to and including most features in Bcfg2 0.9.6. Note that all proceeds from the sale of this book go to SAGE.
-
-FLOSS Manual Project
-====================
-
-A project is getting started to make a user-contributed manual using the [http://en.flossmanuals.net/ FLOSS Manuals] web site and tools. The intention is for this manual to be based on but not a verbatim copy of the information on the wiki, formatted in a way that is easier for new users to read, and written mostly by users of Bcfg2, rather than the authors of Bcfg2. This manual will also be free (as in freedom and price).
-
-One important point is that new contributors can get edit access to the manual in about a minute, and the manual is edited via WYSIWYG tools, so there should be pretty much no barrier for new manual authors to get started.
-
-There will be an announcement to the mailing list about this soon.
-
-If you are seriously interested in dedicating time to this manual, it would make sense to read the [http://en.flossmanuals.net/FLOSSManuals FLOSS Manuals Manual] (free online) and the [https://db.usenix.org/cgi-bin/sage/booklets/order.cgi Configuration Management with Bcfg2] manual ($20). If you are willing to commit time to manual writing, would like physical copies of these manuals, and purchasing them would be a financial hardship for you, email [http://pobox.com/~dclark Danny Clark] at dclark@pobox.com (ping djbclark on [wiki:IRCChannel #bcfg2 irc] if you don't get a reply) with your postal address (don't be shy, I already bought a bunch of these, and they aren't doing much good sitting on my shelf :-).
-
-You can get to the Bcfg2 FLOSS Manual at http://docs.bcfg2.org (which just redirects to http://en.flossmanuals.net/bin/view/BCFG2).