WebSVN – DevTools – Diff – /dpkg_blat/trunk/src/ReadMe.txt

     Transfer a PackageList for future cleanup operations
     Logging and debug facilities
 Overview of Blat
 ---------------
-There are two main components in Blat
+There are three main components in Blat
     Daemon supervisor
         Responsible for start and restarting configured daemons
     Transfer Daemons
         Responsible for the package sync operations for one target
         Multiple Daemons ( targets ) are supported
+    On Target utilities
+        A set of scripts that support Blat
+        These are transferred to the target machine.
 Each Blat Daemon performs three main operations
 ) Fast package transfer
 ) Repository synchronization
 ) PackageList creation
+) Package aging (Optional)
+Each Blat target can perform the following:
+) Package aging
+) dpkg_archive content indexing
 Fast package transfer
 ===============================
 This is mechanism whereby Blat will detect the need to transfer a newly built
 package to the target system.
 ===============================
 Blat will create and send to the target a list of package-version that are
 in the current set. This list may be used to clean out the package archive,
 but this functionality has not yet been implemented.
+Package aging
+=============
+Blat can be configured to delete packages that are no longer a part of the
+current package-version set. There are 4 methods:
+) None
+   Packages will never be deleted by Blat on the target.
+   The target file system will need to be managed to prevent it filling up.
+) Immediate
+   Packages will be deleted as soon as they are not a part of the current
+   package-version set.
+) Aged by blat master
+   Packages will be marked for deletion and the blat master will delete
+   the packages after a configured number of days.
+) Aged by blat target
+   Packages will be marked for deletion and the blat target will delete
+   the packages after a configured number of days. This operation requires
+   that a cron job be configured on the target machine.
+dpkg_archive content indexing
+=============================
+Blat provides a utility that can be run by the transfer target, as a cron job,
+that will maintain a list of files and folders in the package archive.
+This list greatly simplifies the process of locating a file in the archive.
+The user simply greps the package list, rather than search the directory tree.
+The file list is in a file .../dpkg_archive/.dpkg_archive/dpkg_archive_list.txt
 Host System Requirements
 ========================
 ) Unix
    It has been designed for a Unix environment - not Windows
 The config file should be in a 'config' directory under the location
 of the blat master program.
 Installation :: Target System
 =============================
-) Create or aquire a user that has write access to the packaeg archive
+) Create or acquire a user that has write access to the package archive
-) Create or aquire a passwordless identity file and associated public key
+) Create or acquire a passwordless identity file and associated public key
    of the identity file. One set is available in the 'ssh' subdirectory.
-   Append the public part of the idenity file (id_rsa_pkg_admin.pub) to
+   Append the public part of the identity file (id_rsa_pkg_admin.pub) to
    ~/.ssh/authorized_keys
 ) Create a link from the users home directory to dpkg_archive
    The must be called dpkg_archive
-) Transfer the blat receiver scripts to a directory accessable to the
+) Transfer the blat receiver scripts to a directory accessible to the
    transfer user. ie: ~/bin
-   The reqired receiver files are:
+   The required receiver files are:
         get_plist.pl
         receive_file
         receive_package
         delete_package
+        pkg_mon.pl
+        pkg_purge.pl
-   Ensure the programs are execuatable by the transfer user.
+   Ensure the programs are executable by the transfer user.
+) Set up cron jobs (optional)
+   Will be used to maintain package information
+   Suggest crontab entry - may vary for each installation
+3 * * * /home/pkg_admin/bin/pkg_mon.pl
+6 * * 1 /home/pkg_admin/bin/pkg_purge.pl
 Installation :: Host System
 =============================
 This section really deals with the configuration of a new target.
     Will force the daemon to roll its own log files
 Debug verbosity is controlled via the 'verbose' config item
 The pkg.xxxx config items are very special.
-If the named package-versio is a symlink, then both the
+If the named package-version is a symlink, then both the
-link and the liink the package addresses will be transferred.
+link and the package addresses will be transferred.
 The link MUST address another version of the same package.
 This is intended to support the 'jats2_current' link.
 When a new version of JATS is released, then the new package
 will be transferred, as will the new link.
     g - Gigabytes
 ToDo
 ======================
-) Purging packages on target
-   Can set deletePackages to delete excess packages when the release sync
-   is performed.
 ) Better handling of soft-links for core_devl
    Works, but its prone to error
    There is no test to ensure the link exists. If the link
    is deleted, then it won't be recreated.

Subversion Repositories DevTools

(root)/dpkg_blat/trunk/src/ReadMe.txt – Rev 1038 → 1042