From 8ddd63548d2f971751e05f6c0784698453eb53d1 Mon Sep 17 00:00:00 2001 From: Daniel Joseph Barnhart Clark Date: Mon, 28 Aug 2006 18:20:38 +0000 Subject: EncapPackages: Sadly not going to be able to do testing and doc update before vacation; updated doc to at least alert users to this fact. git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@2127 ce84e21b-d406-0410-9b95-82705330c041 --- encap/ChangeLog | 6 +++++- encap/HOWTO | 9 ++++++--- encap/INSTALL | 1 + encap/README | 51 +-------------------------------------------------- encap/TODO | 16 ++++------------ 5 files changed, 17 insertions(+), 66 deletions(-) (limited to 'encap') diff --git a/encap/ChangeLog b/encap/ChangeLog index b49550313..a1bc6cc1c 100644 --- a/encap/ChangeLog +++ b/encap/ChangeLog @@ -51,4 +51,8 @@ * epkg Makefile - to build epkg when prebuilt binaries aren't available 0.9:: - * Major directory structure changes \ No newline at end of file + * Major directory structure changes + * Bunch of other stuff - TODO + + 0.91:: + * TODO \ No newline at end of file diff --git a/encap/HOWTO b/encap/HOWTO index 4dcc12d24..51b2d8c88 100644 --- a/encap/HOWTO +++ b/encap/HOWTO @@ -1,5 +1,11 @@ = Encap based bootstrap for bcfg2 and complete bcfg2 client toolchain = +This documentation is not up to date with the current state of the encap code. +A complete doc refresh should be done in time for the 0.8.4 release. + +This should be considered an alpha version. Everything compiles and seems to +work, but it has not yet been tested. + This bootstrap code is a method for getting bcfg2 (as a client), including all dependencies, up and running on a new platform as quickly as possible (from source). @@ -36,9 +42,6 @@ GNU/Linux and FreeBSD. When using this packaging, `/etc/bcfg2.conf` is instead `/usr/local/etc/bcfg2.conf`. -This should be considered an alpha version. Everything compiles and seems to -work, but it has not yet been tested with a working bcfg2 repository. - == Building and installing everything == 1. Make sure all of the Prerequisites (see below) are installed. 1. The build user needs write access to the encap source and build diff --git a/encap/INSTALL b/encap/INSTALL index e69de29bb..f5b12376f 100644 --- a/encap/INSTALL +++ b/encap/INSTALL @@ -0,0 +1 @@ +For now, look at the HOWTO \ No newline at end of file diff --git a/encap/README b/encap/README index 964fd2341..1d8344a30 100644 --- a/encap/README +++ b/encap/README @@ -1,50 +1 @@ -tools-build ------------ -Tools used during the build process; should be built before anything else. - * m4 - The macro processor, used by mkencap, which is used by everything. - * makeself - A utility to create self-extracting archives, used by the - top-level Makefile to create the bcfg2-*.run distributions. - * patch - Used to patch daemontools and ostiary sources before they build. - -bcfg2-client ------------- -bcfg2 gettext libgcc libiconv libstdc++ libxml2 libxslt lxml openssl pkg-config pyopenssl pyrex python zlib - -bcfg2-cheetah -------------- -The cheetah python-powered templating system. Used as a build tool by bcfg2-site, and by bcfg2-server. Build order: - -bcfg2-python-apt ----------------- -Needed for bcfg2 clients that use the "Advanced Packaging Tool" (apt), such as Debian and Ubuntu. - -bcfg2-server ------------- -Gamin (and glib, upon which it depends), which are needed by the bcfg2 server. Only for GNU/Linux. - -bcfg2-site ----------- -Tools to make an encap package with your site-specific bcfg2.conf, -custom bcfg2 generators, bcfg2 client run frequency, etc. - -tools-deploy/daemontools ------------------------- -D. J. Bernstein's daemontools - a collection of tools for managing UNIX services the same way across all UNIX platforms. Used by bcfg2-site to run ostiary and bcfg2-client; may also be used to run bcfg2-server. - -tools-deploy/ostiary --------------------- -Ray Ingles' ostiary - simple, secure remote script execution. Used by bcfg2-site to enable the remote kickoff of bcfg2-client runs. - -bcfg2-python-apt ----------------- -Before building this, make sure that you have these libraries installed: - * /usr/lib/libapt-pkg* (Part of the "apt" package on Debian) - * /usr/lib/libapt-inst* (Part of the "apt-utils" package on Debian) - -You also must have the "libapt-pkg-dev" package installed. - -To see if your Debian variant is supported, do "grep ifeq Makefile" and see if -any of those strings match "cat /etc/issue". - -It should be pretty trivial to add new Debian platforms; if you have any -issues, mail the bcfg2-dev list or open a ticket. +For now, look at the HOWTO diff --git a/encap/TODO b/encap/TODO index 5820f63ae..259740fb3 100644 --- a/encap/TODO +++ b/encap/TODO @@ -1,21 +1,13 @@ = TODO = -== For 0.8.3 == - * Small documentation update - - * Build everywhere, basic test - - * Send blurb to desai for 0.8.3 announcement: - * daemontools & ostiary stuff - * encap support for Solaris (sparc and x86) - * Binary epkg archive at - http://www.pobox.com/users/dclark/mirror/bcfg2-encaps - == For 0.8.4 == - * Big documentation update + * Build everywhere, basic test + * Double-check all permissions, and make sure they are not effected by the environment's umask + + * Big documentation update * Handle removals nicely (preremove/postremove scripts) * Work towards full compliance with encap 2.1 spec -- cgit v1.2.3-1-g7c22