From afda2ecb1591429d162c2620d10e85ca0a4833c8 Mon Sep 17 00:00:00 2001 From: Raul Cuza Date: Sat, 13 Mar 2010 18:04:28 -0500 Subject: First stab at bringing CentOS documentation unto the v1 era. --- doc/quickstart/centos.txt | 73 +++++++++++++++++++++++++++++------------------ doc/quickstart/index.txt | 7 ++--- doc/quickstart/ubuntu.txt | 2 +- 3 files changed, 49 insertions(+), 33 deletions(-) (limited to 'doc/quickstart') diff --git a/doc/quickstart/centos.txt b/doc/quickstart/centos.txt index 6910c1910..81caf65a2 100644 --- a/doc/quickstart/centos.txt +++ b/doc/quickstart/centos.txt @@ -1,38 +1,41 @@ .. -*- mode: rst -*- .. _quickstart-centos: +.. _EPEL: http://fedoraproject.org/wiki/EPEL ===================== Quickstart for CentOS ===================== -This is a complete getting started guide for CentOS. With this document you should be able to install a Bcfg2 server, a Bcfg2 client, and change the `/etc/motd` file on the client. +This is a complete getting started guide for CentOS. With this document you should be able to install a Bcfg2 server, a Bcfg2 client, and change the ``/etc/motd`` file on the client. -Install Bcfg2 -============= +Install Bcfg2 From RPM +====================== -You can install Bcfg2 from source or build your own RPM. See :ref:`using_bcfg2-with-centos` for information about building Bcfg2 from source and making your own packages. +The fastest way to get Bcfg2 onto your system is to get a RPM someone else has already made. We'll be using the ones that are distributed through EPEL_, but depending on your aversion to risk you could download an RPM from other places as well. See :ref:`using_bcfg2-with-centos` for information about building Bcfg2 from source and making your own packages. +Using EPEL +---------- + + * Make sure EPEL is a valid repository on your server. The `instructions `_ on how to do this basically say:: + + # su -c 'rpm -Uvh http://download.fedora.redhat.com/pub/epel/5/i386/epel-release-5-3.noarch.rpm' + ...lot's of output... -Using prebuilt rpm packages -########################### * Install the bcfg2-server and bcfg2 RPMs :: - [root@centos ~]# rpm -Uvh ftp://fr.rpmfind.net/linux/EPEL/5Server/x86_64/bcfg2-server-0.9.6-1.el5.noarch.rpm ftp://fr.rpmfind.net/linux/EPEL/5Server/x86_64/bcfg2-0.9.6-1.el5.noarch.rpm - Retrieving ftp://fr.rpmfind.net/linux/EPEL/5Server/x86_64/bcfg2-server-0.9.6-1.el5.noarch.rpm - Retrieving ftp://fr.rpmfind.net/linux/EPEL/5Server/x86_64/bcfg2-0.9.6-1.el5.noarch.rpm - warning: /var/tmp/rpm-xfer.xHWepA: Header V3 DSA signature: NOKEY, key ID 217521f6 - Preparing... ########################################### [100%] - 1:bcfg2 ########################################### [ 50%] - 2:bcfg2-server ########################################### [100%] + $ sudo yum install bcfg2-server bcfg2 + +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 -########################## +========================== +*This section needs to be updated for v1* -Now that you're done with the install, you need to intialize your -repository and setup your bcfg2.conf. bcfg2-admin init is a tool which -allows you to automate this:: +Now that you're done with the install, you need to initialize your +repository and setup your ``/etc/bcfg2.conf``. ``bcfg2-admin init`` +is a tool which allows you to automate this:: [root@centos ~]# bcfg2-admin init Store bcfg2 configuration in [/etc/bcfg2.conf]: @@ -72,17 +75,22 @@ allows you to automate this:: Change responses as necessary Start the server -################ +================ You are now ready to start your bcfg2 server for the first time:: - [root@centos ~]# /etc/init.d/bcfg2-server start - Starting Configuration Management Server: bcfg2-server [ OK ] - [root@centos ~]# tail /var/log/messages - Mar 3 12:42:26 centos bcfg2-server[24818]: Failed to read file probed.xml - Mar 3 12:42:26 centos bcfg2-server[24818]: Creating new statistics file /var/lib/bcfg2/etc/statistics.xml - Mar 3 12:42:26 centos bcfg2-server[24818]: Processed 16 gamin events in 0.103 seconds. 0 collapsed - Mar 3 12:42:41 centos bcfg2-server[24818]: Bound to port 6789 + $ sudo /sbin/service bcfg2-server start + +To verify that everything started ok, look for the running daemon and check the logs:: + + $ sudo /sbin/service bcfg2-server status + $ sudo tail /var/log/messages + Mar 23 12:42:26 centos bcfg2-server[24818]: Failed to read file probed.xml + Mar 23 12:42:26 centos bcfg2-server[24818]: Creating new statistics file /var/lib/bcfg2/etc/statistics.xml + Mar 23 12:42:26 centos bcfg2-server[24818]: Processed 16 gamin events in 0.103 seconds. 0 collapsed + Mar 23 12:42:41 centos bcfg2-server[24818]: Bound to port 6789 + +*This part needs to be updated for v1* Run bcfg2 to be sure you are able to communicate with the server:: @@ -164,12 +172,17 @@ Now if you run the client, no more warning:: Bring your first machine under Bcfg2 control -------------------------------------------- +*This section needs to be updated for v1* + Now it is time to get your first machine's configuration into your Bcfg2 repository. Let's start with the server itself. + Quick and Easy ++++++++++++++ +*This section needs to be updated for v1* + First, create a base file containing all installed packages:: [root@centos ~]# cat create-base.sh @@ -205,7 +218,9 @@ As you can see, the centos5 group inherits the centos group. Now let's get a Pkgmgr listing based on the installed package versions Generate Pkgmgr listing -####################### +======================= + +*This section needs to be updated for v1* :: @@ -403,10 +418,14 @@ Running the client again yields a much more manageable result:: Unmanaged entries: 43 Generate service listing -######################## +======================== + +*This section needs to be updated for v1* DBStats ------- Setting up Django +++++++++++++++++ + +*This section needs to be updated for v1* diff --git a/doc/quickstart/index.txt b/doc/quickstart/index.txt index 1f197e52c..29ea8f27b 100644 --- a/doc/quickstart/index.txt +++ b/doc/quickstart/index.txt @@ -14,10 +14,7 @@ or to drop in on our `IRC channel`_. .. _mailing list: https://trac.mcs.anl.gov/projects/bcfg2/wiki/MailingList .. _IRC channel: https://trac.mcs.anl.gov/projects/bcfg2/wiki/IRCChannel -For distribution-specific guides, choose one of the following: - - * :ref:`quickstart-centos` - * :ref:`quickstart-ubuntu` +See the `Platform-specific Quickstart Notes`_ at the end of this page in case your operating systems has been favored with its own quickstart document. Get and Install Bcfg2 Server ============================ @@ -257,7 +254,7 @@ Platform-specific Quickstart Notes ================================== .. toctree:: - :hidden: + :maxdepth: 2 centos ubuntu diff --git a/doc/quickstart/ubuntu.txt b/doc/quickstart/ubuntu.txt index 365167ed4..666674b7e 100644 --- a/doc/quickstart/ubuntu.txt +++ b/doc/quickstart/ubuntu.txt @@ -2,7 +2,7 @@ .. _quickstart-ubuntu: -This is a complete getting started guide for Ubuntu +Quickstart for Ubuntu =================================================== .. note:: -- cgit v1.2.3-1-g7c22