Changes between Version 2 and Version 3 of EncapReadme


Ignore:
Timestamp:
10/06/06 06:43:05 (15 years ago)
Author:
dclark
Comment:

Applies to SVN and 0.8.5 release

Legend:

Unmodified
Added
Removed
Modified
  • EncapReadme

    v2 v3  
    1616 * ostiary to kick off bcfg2 client runs remotely 
    1717 * daemontools to run bcfg2 client as a periodic service with logging 
    18  * all with site-specific configuration parameters, set at build time in a    
     18 * all with site-specific configuration parameters, set at build time in a 
    1919   single unified build-time configuration file, site-settings.conf 
    2020 * optional install-time entry of bcfg2 and ostiary passwords, interactively 
    2121   or via environment variables 
    22     
     22 
    2323As well as: 
    2424 * encap packages for software on which the bcfg2 server functionality 
     
    3636creates encap packages for bcfg2 and dependencies to `/usr/local/encap`, and 
    3737installs symbolic links to these packages from `/usr/local` (the usual encap 
    38 thing).  
     38thing). 
    3939 
    4040It attempts to be as self contained as possible; everything gets linked to 
    4141under `/usr/local/lib/bcfg2`, except for bcfg2 itself and some dependent 
    42 software, which is prefixed by `b2-` (`b2-openssl`, `b2-python` etc.).   
     42software, which is prefixed by `b2-` (`b2-openssl`, `b2-python` etc.). 
    4343 
    4444To run the bcfg2 server, you also need to install gamin, which supports a 
     
    5353 
    5454== Environment variables and Sentinel files == 
    55 Before the initial make/gmake and before the client install, you can set some  
     55Before the initial make/gmake and before the client install, you can set some 
    5656environment variables to control some behaviors: 
    57  * `DEST="<path>"` - Set where the final build output goes. Default is  
     57 * `DEST="<path>"` - Set where the final build output goes. Default is 
    5858   `./DIST` 
    59  * `REPLACE_CONFIG="yes"` - Unconditionally replace local configuration files  
    60    for bcfg2 and ostiary with those included in the distribution. The old  
     59 * `REPLACE_CONFIG="yes"` - Unconditionally replace local configuration files 
     60   for bcfg2 and ostiary with those included in the distribution. The old 
    6161   files are saved to <filename>-<date>. 
    62  * `LOC_BCFG2_PASSWD="<password>"` , `LOC_OST_PASSWD="<password>"` - Set the  
    63    bcfg2 server and ostiaryd daemon passwords, to avoid being interactively  
     62 * `LOC_BCFG2_PASSWD="<password>"` , `LOC_OST_PASSWD="<password>"` - Set the 
     63   bcfg2 server and ostiaryd daemon passwords, to avoid being interactively 
    6464   prompted for them. 
    6565 
     
    7070 
    7171Sentinel file names: 
    72  * `.SENTINEL_SITE` - Indicates that the bcfg2 client has been previously  
     72 * `.SENTINEL_SITE` - Indicates that the bcfg2 client has been previously 
    7373   installed. 
    7474 * `.SENTINEL_BCFG2` - Indicates that the files have been modified by bcfg2 
    7575   itself. (If you change any of the config files mentioned below via bcfg2, 
    76    you'll want to put this sentinel file in the appropriate directory with  
     76   you'll want to put this sentinel file in the appropriate directory with 
    7777   bcfg2 as well). 
    78     
     78 
    7979If either of these files exist, the install will not overwrite the existing 
    8080config files unless `REPLACE_CONFIG="yes"` is set. 
     
    8989}}} 
    9090 
    91 == About daemontools integration ==  
     91== About daemontools integration == 
    9292In order to avoid a lot of platform/distribution-specific code, the encap 
    9393bcfg2 distribution includes and uses [http://cr.yp.to/daemontools.html 
    94 daemontools] (with some common patches) instead of init scripts and cron.  
     94daemontools] (with some common patches) instead of init scripts and cron. 
    9595 
    9696The bcfg2 client (.run) distribution uses daemontools to run ostiary, and to 
    97 run the bcfg2 client periodically.  
     97run the bcfg2 client periodically. 
    9898 
    9999On the server, edit `/usr/local/etc/default/bcfg2-server/env/OPTIONS` to 
    100100include the options you want to start up the bcfg2 server with, and then do 
    101 {{{  
    102 ln -s /usr/local/var/svc.d/bcfg2-server /service/  
     101{{{ 
     102ln -s /usr/local/var/svc.d/bcfg2-server /service/ 
    103103}}} 
    104 to enable the service.  
     104to enable the service. 
    105105 
    106106You can use `/command/svstat /service/bcfg2-server` to see the status, and 
     
    119119The following actions are available via ostiary; you can add more by editing 
    120120`/usr/local/etc/ostiary.cfg`. The <password> is a value you set during 
    121 compile-time or (preferably) .run file install time.  
     121compile-time or (preferably) .run file install time. 
    122122 * `<password>-bcfg2-dvqn` : Run `bcfg2-client -d -v -q -n` 
    123123 * `<password>-bcfg2-dvn` : Run `bcfg2-client -d -v -n` 
     
    127127 * `<password>-bcfg2-v` : Run `bcfg2-client -v` 
    128128 * `<password>-bcfg2-restart` : Restart the bcfg2-client daemontools service 
    129   
     129 
    130130There are plans for the future for a bcfg2 plugin that will set per-machine 
    131131passwords after the initial install, however as with cfengine the worst that 
     
    145145`/usr/local/var/multilog/bcfg2-client-ostiary` 
    146146 
    147 == Supported Platforms ==  
     147== Supported Platforms == 
    148148Below is a table of platforms that have been successfully bootstrapped using 
    149149this code. 
    150150 
    151 || OS        || Vendor || Version || Arch  || GCC   || By || Bcfg2 || 
    152 || AIX       || IBM    || 5.3     || POWER || 4.1.0 || dc || 0.8.3 || 
    153 || GNU/Linux || Debian || Sarge   || i386  || 3.3.5 || dc || 0.8.3 || 
    154 || GNU/Linux || Debian || Sid     || i386  || 4.1.2 || dc || 0.8.3 || 
    155 || GNU/Linux || Ubuntu || Dapper  || i386  || 4.0.3 || dc || 0.8.3 || 
    156 || Solaris   || Sun    || 10      || i386  || 3.4.3 || dc || 0.8.3 || 
    157 || Solaris   || Sun    || 10      || Sparc || 3.4.3 || dc || 0.8.3 || 
     151|| OS        || Vendor || Version || Arch  || GCC     || By || Bcfg2 || 
     152|| AIX       || IBM    || 5.2     || POWER || 3.3.2   || dc || 0.8.5 || 
     153|| AIX       || IBM    || 5.3     || POWER || 4.1.1   || dc || 0.8.5 || 
     154|| GNU/Linux || Debian || Sarge   || i386  || 3.3.5   || dc || 0.8.5 || 
     155|| GNU/Linux || Debian || Sid     || i386  || 4.1.2   || dc || 0.8.5 || 
     156|| GNU/Linux || Redhat || 7.2     || i386  || 2.96    || dc || 0.8.5 || 
     157|| GNU/Linux || SuSE   || SLES8   || i386  || 3.2.2   || dc || 0.8.5 || 
     158|| GNU/Linux || SuSE   || SLES10  || i386  || 4.1.0   || dc || 0.8.5 || 
     159|| GNU/Linux || Ubuntu || Dapper  || i386  || 4.0.3   || dc || 0.8.5 || 
     160|| Solaris   || Sun    || 10      || i386  || 3.4.3   || dc || 0.8.5 || 
     161|| Solaris   || Sun    || 10      || Sparc || 3.4.3   || dc || 0.8.5 || 
    158162 
    159163dc: "Daniel Clark" <mailto:dclark@member.fsf.org> 
     
    161165If you bootstrap a platform not listed above, please add a comment to: 
    162166 * http://trac.mcs.anl.gov/projects/bcfg2/ticket/74 
    163 so that platform can be added to the list.  
     167so that platform can be added to the list. 
    164168 
    165169If you modified any of the files in this package to be able to bootstrap the 
    166170new platform, please include either diffs or a tarball of your modified 
    167171version in a new ticket so your changes can be incorporated into a new 
    168 release.  
     172release. 
    169173 
    170174Any other notes, such as where you got the GNU binaries or any issues people 
    171 should be aware of, would also be appreciated.  
     175should be aware of, would also be appreciated. 
    172176 
    173177You may want to scan all of the bootstrapped binaries and libraries with 
    174178`ldd` (or equivalent) to make sure there are no dependencies on libraries 
    175179other than those included with the base operating system and the libraries 
    176 built as part of the bootstrap process.  
    177  
    178 == libgcc and libstdc++ == 
    179 On non-GNU operating systems, libgcc and libstdc++ are a run-time 
    180 requirement. These libraries are usually distributed with gcc/g++, so the 
    181 bootstrap system attempts to create encap packages containing those 
    182 libraries by copying them from the build machine. To test that this worked, 
    183 you'll want to either temporarily remove gcc/g++ from the build machine and 
    184 make sure everything still works, or install the bcfg2 client on a "clean" 
    185 machine (without a gcc/g++ install) and test on that machine. 
     180built as part of the bootstrap process. 
    186181 
    187182== Encap profile (.ep) documentation == 
    188 Note that the doc for the encap profile format is in  
     183Note that the doc for the encap profile format is in 
    189184[wiki:EncapManEncapProfile `man 5 encap_profile`]. 
    190185 
     
    194189 
    195190== Documentation Version == 
    196  * This is a copy of: $Id: README 2206 2006-09-05 15:01:39Z dclark $ 
     191 * This is a copy of: $Id: README 2393 2006-10-06 04:13:07Z dclark $ 
    197192 * Most recent version: http://www.bcfg2.org/browser/trunk/bcfg2/encap/README