[zopeorg-checkins] CVS: NZO_setup - README.txt:1.1

[Tres Seaver]

Update of /cvs-zopeorg/NZO_setup
In directory cvs.zope.org:/tmp/cvs-serv24491

Added Files:
	README.txt 
Log Message:
 - Add README.

=== Added File NZO_setup/README.txt ===
NZO_setup README

  Overview

    This package contains the scripts, makefiles, and templates needed
    to construct the various server instances which make up the "new"
    zope.org cluster:

      - Squid cache

      - Zope app servers

      - ZEO storage server

    It should be considered the authoritative source for the configuration
    of individual servers within the cluster.

  Theory of Operation: CVS-driven Buildout

    In order to ensure that those responsible for maintaining the
    cluster know exactly what software each server instance must have,
    without relying on *any* dependencies from the surrounding
    environment beyond the "stock" build tools (gcc, GNU make).
    
    Every binary needed to run the system, and all libraries, should be
    configured and built "locally" within the server instance, using
    source checked out directly from the appropriate CVS repository.
    The repository used will normally be the "authoritative" public
    repository for the relevant package.
    
    When NZO requires application of a local patch (e.g., to fix a crash
    bug in advance of a "blessed" release), we will create a "vendor
    import" of the relevant package into the NZO repository, and check
    out from there in order to apply the patch, which will then be
    checked back in.

  Usage

    Normally, each server instance in the cluster will be built by
    checking out this package and then invoking the appropriate
    Makefile.  For instance, to build a new Squid cache instance::

      # su - squid
      $ pwd
      /home/squid
      $ cvs -d :pserver:anonymous at cvs.zope.org:/cvs-zopeorg co NZO_setup
      ....
      $ make -f NZO_setup/Makefile.squid -I NZO_setup
      ....
      $ bin/squid_start