summaryrefslogtreecommitdiffstats
path: root/doc/appendix
diff options
context:
space:
mode:
Diffstat (limited to 'doc/appendix')
-rw-r--r--doc/appendix/guides/bootstrap.txt39
-rw-r--r--doc/appendix/guides/centos.txt31
-rw-r--r--doc/appendix/guides/converging_rhel5.txt2
-rw-r--r--doc/appendix/guides/fedora.txt28
-rw-r--r--doc/appendix/guides/import-existing-ssh-keys.txt2
-rw-r--r--doc/appendix/guides/ubuntu.txt54
6 files changed, 123 insertions, 33 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 d89d532ba..d788891de 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
</YUMSource>
</Sources>
-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
@@ -240,7 +244,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 final thing we need is for the client to have the proper
arch group membership. For this, we will make use of the
@@ -431,7 +435,7 @@ packages. Currently, the way to manage them is using :ref:`BoundEntries
.. code-block:: xml
<Bundle name='base-packages'>
- <BoundPackage name="gpg-pubkey" type="rpm">
+ <BoundPackage name="gpg-pubkey" type="rpm" version="foo">
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-5" version="e8562897" release="459f07a4"/>
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL" version="217521f6" release="45e8a532"/>
</BoundPackage>
@@ -452,6 +456,10 @@ packages. Currently, the way to manage them is using :ref:`BoundEntries
<Package name='yum'/>
</Bundle>
+.. 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 +469,7 @@ gpg keys you want to manage
<Bundle name='base-packages'>
<Path name='/etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-5'/>
<Path name='/etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL'/>
- <BoundPackage name="gpg-pubkey" type="rpm">
+ <BoundPackage name="gpg-pubkey" type="rpm" version="foo">
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-5" version="e8562897" release="459f07a4"/>
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL" version="217521f6" release="45e8a532"/>
</BoundPackage>
@@ -578,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/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"
<Bundle name='keys'>
<!-- GPG keys -->
- <BoundPackage name="gpg-pubkey" type="yum">
+ <BoundPackage name="gpg-pubkey" type="rpm" version="foo">
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL" version="217521f6" release="45e8a532"/>
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release" version="37017186" release="45761324"/>
</BoundPackage>
diff --git a/doc/appendix/guides/fedora.txt b/doc/appendix/guides/fedora.txt
index 4e3244eaa..db23e94bf 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`_ .
</YUMSource>
</Sources>
-.. _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
@@ -244,8 +249,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.
+ run ``bcfg2-lint`` to ensure that your xml validates properly.
Add a probe
+++++++++++
@@ -339,7 +343,7 @@ Bundle now looks like this
.. code-block:: xml
<Bundle name='base-packages'>
- <BoundPackage name="gpg-pubkey" type="rpm">
+ <BoundPackage name="gpg-pubkey" type="rpm" version="foo">
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-5" version="e8562897" release="459f07a4"/>
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL" version="217521f6" release="45e8a532"/>
</BoundPackage>
@@ -360,6 +364,10 @@ Bundle now looks like this
<Package name='yum'/>
</Bundle>
+.. 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 +377,7 @@ of the gpg keys you want to manage
<Bundle name='base-packages'>
<Path name='/etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-5'/>
<Path name='/etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL'/>
- <BoundPackage name="gpg-pubkey" type="rpm">
+ <BoundPackage name="gpg-pubkey" type="rpm" version="foo">
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-5" version="e8562897" release="459f07a4"/>
<Instance simplefile="/etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL" version="217521f6" release="45e8a532"/>
</BoundPackage>
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 24338c6d2..a597a5492 100644
--- a/doc/appendix/guides/ubuntu.txt
+++ b/doc/appendix/guides/ubuntu.txt
@@ -167,14 +167,39 @@ Create Packages layout (as per :ref:`packages-exampleusage`) in
<Arch>amd64</Arch>
<Arch>i386</Arch>
</APTSource>
+ <APTSource>
+ <Group>lucid</Group>
+ <URL>http://archive.ubuntu.com/ubuntu</URL>
+ <Version>lucid-updates</Version>
+ <Component>main</Component>
+ <Component>multiverse</Component>
+ <Component>restricted</Component>
+ <Component>universe</Component>
+ <Arch>amd64</Arch>
+ </APTSource>
+ <APTSource>
+ <Group>lucid</Group>
+ <URL>http://security.ubuntu.com/ubuntu</URL>
+ <Version>lucid-security</Version>
+ <Component>main</Component>
+ <Component>multiverse</Component>
+ <Component>restricted</Component>
+ <Component>universe</Component>
+ <Arch>amd64</Arch>
+ </APTSource>
</Sources>
-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
+
+.. note::
-.. _Magic Groups: http://trac.mcs.anl.gov/projects/bcfg2/wiki/Plugins/Packages#MagicGroups
+ 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
@@ -197,7 +222,7 @@ 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 last thing we need is for the client to have the proper
arch group membership. For this, we will make use of the
@@ -481,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:
@@ -501,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`
generated by cgit v1.2.3-1-g7c22 (git 2.25.1) at 2024-09-16 08:09:03 +0000