From f14d32e1e370ce47a9ef5a2b8dad8ae5ee630eb1 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Fri, 12 Feb 2010 14:53:29 +0000 Subject: doc: Clean up more documentation Signed-off-by: Sol Jerome git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5721 ce84e21b-d406-0410-9b95-82705330c041 --- doc/unsorted/annotated_examples.txt | 39 +++++++++++++++++++++---------------- 1 file changed, 22 insertions(+), 17 deletions(-) (limited to 'doc/unsorted/annotated_examples.txt') diff --git a/doc/unsorted/annotated_examples.txt b/doc/unsorted/annotated_examples.txt index 99c6f774c..b5b7e6b4e 100644 --- a/doc/unsorted/annotated_examples.txt +++ b/doc/unsorted/annotated_examples.txt @@ -11,7 +11,8 @@ ntp example Author: Jason Pepas -Here is a series of example configurations for bcfg2, each introducing another layer of functionality. +Here is a series of example configurations for bcfg2, each introducing +another layer of functionality. * After each change, run 'bcfg-repo-validate -v'. * Run the server with 'bcfg2-server -v'. @@ -20,7 +21,8 @@ Here is a series of example configurations for bcfg2, each introducing another l package only ------------ -Our example starts with the bare minimum configuration setup. We have a client, a profile group, a list of packages, and a base configuration. +Our example starts with the bare minimum configuration setup. We have +a client, a profile group, a list of packages, and a base configuration. :: @@ -77,7 +79,7 @@ Setup an etc directory structure, and add it to the base.:: - + @@ -86,10 +88,10 @@ create a bundle The above configuration layout works fine for a single service, but that method of organization would quickly become a nightmare as you -approach the number of packages, services, and config files required -to represent a fully configured host. Bundles allow the grouping of -related configuration entries that are used to provide a single -service. This is done for several reasons: +approach the number of packages, services, and config files required to +represent a fully configured host. Bundles allow the grouping of related +configuration entries that are used to provide a single service. This +is done for several reasons: * Grouping related things in one place makes it easier to add those entries for a multiple groups of clients @@ -102,20 +104,20 @@ service. This is done for several reasons: entity in that bundle is modified. This ensures that new configuration files and software are used after installation. -The config file, package, and -service are really all related components describing the idea of an -ntp client, so they should be logically grouped together. We use a -bundle to accomplish this.:: +The config file, package, and service are really all related components +describing the idea of an ntp client, so they should be logically +grouped together. We use a bundle to accomplish this.:: # cat Bundler/ntp.xml - + After this bundle is created, it must be associated with a group (or -groups). Add a bundle child element to the group(s) which should install this bundle.:: +groups). Add a bundle child element to the group(s) which should install +this bundle.:: # cat Metadata/groups.xml @@ -146,8 +148,8 @@ I added a new bundle: .. code-block: xml - - + + @@ -162,14 +164,17 @@ The `users.sh` script looks like this: mysql --defaults-extra-file=/etc/mysql/debian.cnf mysql \ < /root/bcfg2-install/mysql/users.sql -On debian there is a user account in `/etc/mysql/debian.cnf` automatically created, but you could also (manually) create a user in the database that has enough permissions and add the login information in a file yourself. This file looks like this:: +On debian there is a user account in ``/etc/mysql/debian.cnf`` +automatically created, but you could also (manually) create a user in +the database that has enough permissions and add the login information +in a file yourself. This file looks like this:: [client] host = localhost user = debian-sys-maint password = XXXXXXXXXX -The `users.sql` looks like this:: +The ``users.sql`` looks like this:: DELETE FROM db; INSERT INTO db VALUES ('localhost', 'phpmyadmin', 'pma', 'Y', 'Y', -- cgit v1.2.3-1-g7c22