EncapPackages: Broke supported platforms out to seperate file, minor updates to other doc.

git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@3495 ce84e21b-d406-0410-9b95-82705330c041

5 files changed, 102 insertions, 62 deletions

diff --git a/encap/HOWTO b/encap/HOWTO
index 1d9cc1387..784683bb7 100644
--- a/encap/HOWTO
+++ b/encap/HOWTO
@@ -1,10 +1,11 @@
-EncapPackages | EncapReadme | EncapInstall | '''EncapHowto'''
+EncapPackages | EncapReadme | EncapPlatforms | EncapInstall | '''EncapHowto'''
 
 ----
 
 = EncapHowto: Encap Packages HOWTO =
 
-TODO: Aim is to have nice HOWTO for 0.8.6 release.
+TODO: Aim is to have nice HOWTO before 1.0 release, incorporating the
+      work done at http://opensysadmin.com/trac/wiki/VirtualMachines
 
 <Reference to README and INSTALL in wiki: format>
 
diff --git a/encap/INSTALL b/encap/INSTALL
index 4d2ccf95a..cd2c5e928 100644
--- a/encap/INSTALL
+++ b/encap/INSTALL
@@ -1,4 +1,4 @@
-EncapPackages | EncapReadme | '''EncapInstall''' | EncapHowto
+EncapPackages | EncapReadme | EncapPlatforms | '''EncapInstall''' | EncapHowto
 
 ----
 
@@ -6,12 +6,18 @@ EncapPackages | EncapReadme | '''EncapInstall''' | EncapHowto
 
 == Prerequisites ==
  * Read the [wiki:EncapReadme README]
+ * GNU gcc and GNU g++
+   * If you are using the gcc distributed with Solaris/x86 10, you need to 
+     install the gcc bug fix at http://www.openssl.org/~appro/values.c by 
+     running "`ksh -f values.c`" as root (or openssl will segfault)
  * GNU make (make sure "gmake" links to GNU make on non-GNU platforms)
  * epkg (the encap package manager)
    * Canonical website is http://www.encap.org/epkg
    * Mirror of epkg binaries is available at http://www.dclark.us/mirror/
    * If built from source, first need all recommended libraries from web page
      * To ease building from source, read `epkg/README` and use `epkg/Makefile`
+ * On AIX 4.3.3, you will need GNU binutils from:
+   ftp://ftp.software.ibm.com/aix/freeSoftware/aixtoolbox/RPMS/ppc/GNUPro/binutils-2.9.aix51.020209-4.aix4.3.ppc.rpm
 
 You will need binaries of the GNU tools. For GNU and BSD based operating 
 systems, you should be able to get these via the operating system's package 
@@ -22,13 +28,13 @@ system. For commercial operating systems, these can be obtained from:
    http://aixpdslib.seas.ucla.edu/aixpdslib.html 
    (These are trivial to convert into encap packages)
  * Bull AIX Freeware at http://www.bullfreeware.com/
+ * IBM AIX Toolbox at ftp://ftp.software.ibm.com/aix/freeSoftware
 
  Solaris::
  * Freeware for Solaris at http://www.sunfreeware.com/
  * Community Software for Solaris at http://www.blastwave.org/packages.php
 
 == Advanced Packaging Tool (APT) support == 
-
 On platforms that use APT, such as Debian and Ubuntu, "bcfg2-python-apt" must
 be built. Unfortunately the version required is dependent on the version of the
 distribution. 
@@ -85,9 +91,6 @@ You can install the doc packages if you want, although it probably makes more
 sense to let bcfg2 install them on machines you want to have them on after you
 get stuff up and running.
 
-On GNU/Linux platforms, glib and gamin will also be built; these only have to
-be installed only on the bcfg2 server machine.
-
 Cheetah will be built on all platforms (as it is needed as a build-time 
 prerequisite), however for run-time it only needs to be installed on the bcfg2
 server machine.
diff --git a/encap/PLATFORMS b/encap/PLATFORMS
new file mode 100644
index 000000000..cf94c207c
--- /dev/null
+++ b/encap/PLATFORMS
@@ -0,0 +1,64 @@
+EncapPackages | EncapReadme | '''EncapPlatforms''' | EncapInstall | EncapHowto
+
+----
+
+= Bcfg2/Encap Platforms =
+
+Below is a table of platforms that have been successfully bootstrapped using
+the encap package management code.
+
+|||| '''OS'''||'''Vendor'''||'''Version'''||'''Arch'''||'''By'''||'''Bcfg2'''||
+||  1 || AIX       || IBM     || 4.3.1   || POWER  || dc || 0.9.5  ||
+||  2 || AIX       || IBM     || 4.3.3   || POWER  || dc || 0.9.4i ||
+||  3 || AIX       || IBM     || 5.2.0   || POWER  || dc || 0.9.4i ||
+||  4 || AIX       || IBM     || 5.3.0   || POWER  || dc || 0.9.4i ||
+||  5 || BSD       || FreeBSD || 6.2     || ix86   || dc || 0.9.5  ||
+||  6 || BSD       || FreeBSD || 6.2     || x86_64 || dc || 0.9.5  ||
+||  7 || GNU/Linux || CentOS  || 5.0     || ix86   || dc || 0.9.5  ||
+||  8 || GNU/Linux || CentOS  || 5.0     || x86_64 || dc || 0.9.5  ||
+||  9 || GNU/Linux || Debian  || Sarge   || ix86   || dc || 0.9.5  ||
+|| 10 || GNU/Linux || Debian  || Etch    || ix86   || dc || 0.9.4i ||
+|| 11 || GNU/Linux || Debian  || Etch    || x86_64 || dc || 0.9.4i ||
+|| 12 || GNU/Linux || Debian  || Lenny   || ix86   || dc || 0.9.5  ||
+|| 13 || GNU/Linux || Debian  || Sid     || ix86   || dc || 0.9.5  ||
+|| 14 || GNU/Linux || Redhat  || 6.0     || ix86   || dc || 0.9.4i ||
+|| 15 || GNU/Linux || Redhat  || 7.2     || ix86   || dc || 0.9.4i ||
+|| 16 || GNU/Linux || Redhat  || RHEL4   || ix86   || dc || 0.9.4i ||
+|| 17 || GNU/Linux || SuSE    || SLES8   || ix86   || dc || 0.9.4i ||
+|| 18 || GNU/Linux || SuSE    || SLES10  || ix86   || dc || 0.9.4i ||
+|| 19 || GNU/Linux || SuSE    || SLES10  || x86_64 || dc || 0.9.4i ||
+|| 20 || GNU/Linux || Ubuntu  || Dapper  || ix86   || dc || 0.9.5  ||
+|| 21 || GNU/Linux || Ubuntu  || Dapper  || x86_64 || dc || 0.9.5  ||
+|| 22 || GNU/Linux || Ubuntu  || Edgy    || ix86   || dc || 0.9.5  ||
+|| 23 || GNU/Linux || Ubuntu  || Feisty  || ix86   || dc || 0.9.5  ||
+|| 24 || Solaris   || Sun     || 2.6     || Sparc  || dc || 0.9.4i ||
+|| 25 || Solaris   || Sun     || 8       || Sparc  || dc || 0.9.4i ||
+|| 26 || Solaris   || Sun     || 9       || Sparc  || dc || 0.9.4i ||
+|| 27 || Solaris   || Sun     || 10      || Sparc  || dc || 0.9.4i ||
+|| 28 || Solaris   || Sun     || 10      || x86_64 || dc || 0.9.5  ||
+
+* Redhat 6.0 has egcs-2.91.66
+
+dc: "Daniel Clark" <mailto:dclark@member.fsf.org>
+
+== Adding new platforms ==
+If you bootstrap a platform not listed above, please add a comment to:
+ * http://trac.mcs.anl.gov/projects/bcfg2/ticket/74
+so that platform can be added to the list.
+
+If you modified any of the files in this package to be able to bootstrap the
+new platform, please include either diffs or a tarball of your modified
+version in a new ticket so your changes can be incorporated into a new
+release.
+
+Any other notes, such as where you got the GNU binaries or any issues people
+should be aware of, would also be appreciated.
+
+You may want to scan all of the bootstrapped binaries and libraries with
+`ldd` (or equivalent) to make sure there are no dependencies on libraries
+other than those included with the base operating system and the libraries
+built as part of the bootstrap process.
+
+== Documentation Version ==
+ * This is a copy of: $Id$
+ * Most recent version: http://www.bcfg2.org/browser/trunk/bcfg2/encap/PLATFORMS
\ No newline at end of file
diff --git a/encap/README b/encap/README
index 5f0da7531..f434d9cdd 100644
--- a/encap/README
+++ b/encap/README
@@ -1,4 +1,4 @@
-EncapPackages | '''EncapReadme''' | EncapInstall | EncapHowto
+EncapPackages | '''EncapReadme''' | EncapPlatforms | EncapInstall | EncapHowto
 
 ----
 
@@ -10,20 +10,20 @@ running on many platforms as quickly as possible, from source.
 == What you get ==
 The end result is a self-extracting/self-installing bcfg2 client distribution
 that does a complete client install, which includes:
- * the epkg encap package manager
- * all software on which bcfg2 depends
- * bcfg2 itself
- * ostiary to kick off bcfg2 client runs remotely
- * runit to run bcfg2 client as a periodic service with logging
- * all with site-specific configuration parameters, set at build time in a
+ * The epkg encap package manager
+ * All software on which bcfg2 depends
+ * Bcfg2 itself
+ * Ostiary to kick off bcfg2 client runs remotely
+ * Runit to run bcfg2 client as a periodic service with logging
+ * All with site-specific configuration parameters, set at build time in a
    single unified build-time configuration file, site-settings.conf
- * optional install-time entry of bcfg2 and ostiary passwords, interactively
+ * Optional install-time entry of bcfg2 and ostiary passwords, interactively
    or via environment variables
 
 As well as:
- * encap packages for software on which the bcfg2 server functionality
-   depends (glib, gamin, and cheetah)
- * encaps of optional documentation packages
+ * Encaps of optional documentation packages
+ * Optionally you can build the software the bcfg2 server requires (cd to 
+   the encap/src/encap-packages/server directory and type "make")
 
 == Internet resources ==
 For a more general overview, see http://www.bcfg2.org/wiki/EncapPackages
@@ -139,47 +139,30 @@ point you will enter one of the above-listed values, such as
 `<password>-bcfg2-dvqn` (the command to run and the password are
 integrated into the same string).
 
+Another useful way of running ostiary is to put the password in a text file
+(on the local filesystem with appropriate permissions) and then do:
+{{{
+for HOST in $(bcfg2-query -u); do 
+    printf "$HOST: "
+    ostclient -a $HOST:1711 -f 0 < file-with-password.txt
+    sleep 1
+done
+}}}
+This will run the ostiary command associated with the password in
+"file-with-password.txt" on all hosts bcfg2 thinks are up. The sleep
+delay is arbitrary and not really required, but can be useful if you
+are monitoring the bcfg2 server logs interactively for client connections.
+
 Logs of bcfg2-client runs kicked off via ostiary are in
 `/usr/local/var/svlogd/bcfg2-client-ostiary`
 
-== Supported Platforms ==
-Below is a table of platforms that have been successfully bootstrapped using
-this code.
-
-|| OS        || Vendor || Version || Arch   || GCC     || By || Bcfg2 ||
-|| AIX       || IBM    || 5.2     || POWER  || 3.3.2   || dc || 0.8.5 ||
-|| AIX       || IBM    || 5.3     || POWER  || 4.1.1   || dc || 0.8.5 ||
-|| GNU/Linux || Debian || Sarge   || i386   || 3.3.5   || dc || 0.8.5 ||
-|| GNU/Linux || Debian || Etch    || x86_64 || 4.1.2   || dc || 0.9.2 ||
-|| GNU/Linux || Debian || Sid     || i386   || 4.1.2   || dc || 0.8.5 ||
-|| GNU/Linux || SuSE   || SLES8   || i386   || 3.2.2   || dc || 0.8.5 ||
-|| GNU/Linux || SuSE   || SLES10  || i386   || 4.1.0   || dc || 0.8.5 ||
-|| GNU/Linux || Ubuntu || Dapper  || i386   || 4.0.3   || dc || 0.8.5 ||
-
-dc: "Daniel Clark" <mailto:dclark@member.fsf.org>
-
-If you bootstrap a platform not listed above, please add a comment to:
- * http://trac.mcs.anl.gov/projects/bcfg2/ticket/74
-so that platform can be added to the list.
-
-If you modified any of the files in this package to be able to bootstrap the
-new platform, please include either diffs or a tarball of your modified
-version in a new ticket so your changes can be incorporated into a new
-release.
-
-Any other notes, such as where you got the GNU binaries or any issues people
-should be aware of, would also be appreciated.
-
-You may want to scan all of the bootstrapped binaries and libraries with
-`ldd` (or equivalent) to make sure there are no dependencies on libraries
-other than those included with the base operating system and the libraries
-built as part of the bootstrap process.
-
 == Encap profile (.ep) documentation ==
 Note that the doc for the encap profile format is in
 [wiki:EncapManEncapProfile `man 5 encap_profile`].
 
 == Next steps ==
+ 1. You can check to see if your platform has been successfully
+    bootstrapped before; see [wiki:EncapPlatforms PLATFORMS]
  1. Build and install; see [wiki:EncapInstall INSTALL]
  1. Set up your server and clients; see [wiki:EncapHowto HOWTO]
 
diff --git a/encap/TODO b/encap/TODO
index 18a0edf98..cff7cc7fb 100644
--- a/encap/TODO
+++ b/encap/TODO
@@ -1,14 +1,4 @@
 = EncapTodo: TODO =
- * Fix this:
-
-nasa:~/svn/bcfg2/encap/src/bcfg2-site# bcfg2-admin help
-/usr/local/lib/bcfg2/lib/python2.4/site-packages/M2Crypto-0.17-py2.4-linux-i686.egg/M2Crypto/__m2crypto.py:3: UserWarning: Module lxml was already imported from /usr/local/lib/bcfg2/lib/python2.4/site-packages/lxml-1.2.1-py2.4-linux-i686.egg/lxml/__init__.pyc, but /usr/local/lib/bcfg2/lib/python2.4/site-packages/lxml-1.2.1-py2.4-linux-i686.egg is being added to sys.path
-[... and then seems to work fine ...]
-
- * Add new version of XML.py patch to bcfg2 encap.
-
- * Move to using svlogd for runit run logs; see:
-   * http://www.thedjbway.org/svscanboot.html
 
  * Write HOWTO
 
@@ -16,6 +6,5 @@ nasa:~/svn/bcfg2/encap/src/bcfg2-site# bcfg2-admin help
 
  * Work towards full compliance with encap 2.1 spec
 
- 
 == Documentation Version ==
 $Id$