[bacula/bacula] / bacula / ReleaseNotes

          Release Notes for Bacula 1.37.14

  Bacula code: Total files = 422 Total lines = 129,844 (*.h *.c *.in)

Note! The DB has been upgraded from version 8 to 9 and requres
a DB upgrade.

Major Changes:
- This version has a new DIR <--> SD protocol. Both must be
  upgraded at the same time. Deamons are not compatible with
  prior versions. All FDs must be upgraded.
- There is a new database format that is not compatible
  with previous databases.
- SQLite3 support, but it seems to run at 1/2 to 1/4 the speed of
  SQLite2.
- Multiple drive autochanger support.
- Support for ANSI/IBM labels.
- New communications protocol between DIR and SD to reserve 
  drives.
- Python Event support has been added. See below for
  configuration and details.
- DVD writing support, using parts, and a lot of new directives in
  the Device resource of the Storage configuration file thanks
  to Nicolas Boichat.
- Seven new options keywords in a FileSet resource:
  ignorecase, fstype, hfsplussupport, wilddir, wildfile, regexdir,
  and regexfile thanks to Pruben Guldberg). See below for details.
- Restore of all files for a Job or set of jobs even if the file
  records have been removed from the catalog.
- Restore of a directory (non-recursive, i.e. only one level).
- Support for TLS (ssl) between all the daemon connections thanks
  to Landon Fuller.
- Any Volume in the Pool named Scratch may be reassigned to any
  other Pool when a new Volume is needed.
- You may clone a Job and thus write (almost) the same data
  to multiple Volumes simultaneously (see below). Actually, 
  any Job may start any other Job with this mechanism, so it
  also be used to group jobs.
- Unicode filename support for Win32 (thanks to Thorsten Engel)
- New manual format with an index (thanks to Karl Cunningham).
- New Web site format (thanks to Michael Scherer).
- Seeking on disk Volumes during restore.

New Directives:
- New Run directive in Job resource of DIR. It permits
  cloning of jobs.  To clone a copy of the current job, use
     Run = "job-name level=%l since=\"%s\""
  Note, job-name is normally the same name as the job that
  is running but there is no restriction on what you put. If you
  want to start the job by hand and use job overrides such as       
  storage=xxx, realize that the job will be started with the
  default storage values not the overrides.  The level=%l guarantees
  that the chosen level of the job is the same, and the since=... 
  ensures that the job uses *exactly* the same time/date for incremental
  and differential jobs. The since=... is ignored when level=Full.
  A cloned job will not start additional clones, so it is not possible
  to recurse.
- New Options keywords in a FileSet directive:
  - WildDir xxx
    Will do a wild card match against directories (files will not
    be matched).
  - WildFile xxx
    Will do a wild card match against files (directories will not
    be matched).
  - RegexDir xxx
    Will do a regular expression match against directories (files
    will not be matched).
  - RegexFile xxx
    Will do a regular expression match against files( directories
    will not be matched).
  - IgnoreCase = yes | no
    Will ignore case in wild card and regular expression matches.
    This is handy for Windows where filename case is not significant.
  - FsType = string
    where string is a filesystem type: ext2, jfs, ntfs, proc,
    reiserfs, xfs, usbdevfs, sysfs, smbfs, iso9660.  For ext3
    systems, use ext2.  You may have multiple fstype directives
    and thus permit multiple filesystem types.  If the type
    specified on the fstype directive does not match the
    filesystem for a particular directive, that directory will
    not be backed up.  This directive can be used to prevent
    backing up non-local filesystems.
  - HFS Plus Support = yes | no 
    If set, Mac OS X resource forks will be saved and restored.
- Label Type = ANSI | IBM | Bacula   
  Implemented in Director Pool resource and in SD Device resource.
  If it is specified in the SD Device resource, it will take
  precedence over the value passed from the Director to the SD.
  IBM is not yet implemented.
- Check Labels = yes | no
  Implemented in the SD Device resource. If you intend to read
  ANSI or IBM labels, this *must* be set. Even if the volume
  is not ANSI labeled, you can set this to yes, and Bacula will
  check the label type.
- Scripts Directory = <directory> name.  Defines the directory from 
  which Bacula scripts will be called for events. In fact, Bacula
  appends this name to the standard Python list of search directories,
  so the script could also be in any of the Python system directories.
- In FileSet, you can exclude backing up of hardlinks (if you have
  a lot, it can be very expensive), by using:
    HardLinks = no
  in the Options section. Patch supplied by David R Bosso. Thanks.
- MaximumPartSize = bytes (SD, Device resource)
  Defines the maximum part size.
- Requires Mount = Yes/No (SD, Device resource)
  Defines if the device require to be mounted to be read, and if it
  must be written in a special way. If it set, the following directives 
  must be defined in the same Device resource:
  + Mount Point = directory
    Directory where the device must be mounted. 
  + Mount Command = name-string
    Command that must be executed to mount the device. Before the command
    is executed, %a is replaced with the Archive Device, and %m with the 
    Mount Point.
  + Unmount Command = name-string
    Command that must be executed to unmount the device. Before the 
    command is executed, %a is replaced with the Archive Device, and 
    %m with the Mount Point.
  + Write Part Command = name-string
    Command that must be executed to write a part to the device. Before
    the command is executed, %a is replaced with the Archive Device, %m 
    with the Mount Point, %n with the current part number (0-based), 
    and %v with the current part filename.
  + Free Space Command = name-string
    Command that must be executed to check how much free space is left 
    on the device. Before the command is executed, %a is replaced with 
    the Archive Device, %m with the Mount Point, %n with the current part
    number (0-based), and %v with the current part filename.
- Write Part After Job = Yes/No (DIR, Job Resource, and Schedule Resource)
  If this directive is set to yes (default no), a new part file will be
  created after the job is finished.

New Commands:
- "python restart" restarts the Python interpreter. Rather brutal, make
   sure no Python scripts are running. This permits you to change
   a Python script and get Bacula to use the new script.

Items to note!!!
- You must add --with-python=[DIR] to the configure command line
  if you want Python support.  Python 2.2 and 2.3 should be automatically
  detected if in the standard place.
- With Python 2.2 version, the link of the Director gets a few linker
  warnings due to the fact that Python pulls in some old non-secure
  libraries.
- With Python 2.3, there are a few compiler warnings.
- You must either create a new catalog database or upgrade your
  old database (the PostgreSQL upgrade scripts not yet tested).

Other Items:
- 2 new scripts, dvd-writepart and dvd-freespace, in the scripts directory,
  which are designed to be used as parameters to Write Part Command and
  Free Space Command. They need the dvd+rw-tools to be installed
  (http://fy.chalmers.se/~appro/linux/DVD+RW/).
- Part files support: File volumes can now be splitted in multiple
  files, called "parts".

NOTE THE FOLLOWING IS NOW OUT OF DATE!!!!
- Python scripting support:
  A Python script will be called at particular points or conditions
  in Bacula called Events. The currently defined Events are called:

  StartJob, EndJob, NewVolume

  Where StartJob is called before the RunBeforeJob, EndJob is called 
  after RunAfterJob, and NewVolume, is called before all other 
  "methods" of obtaining a new Volume name, when one is needed.

  The Python script of the same name as the Event name (but with a .py) 
  is called from the Scripts Directory (a directive defined in the
  Director resource).  Note, both the Filename, and the name of
  the function in the file must correspond to the Event name.

  Once the Python script gets control, it can have access to Bacula
  variables by doing:

     import bacula

  The script is called with one argument, typically called jcr. This
  argument *must* be used to access each bacula function. The
  format of the call is slightly different for reading Bacula
  variable and for writing bacula variables. See below.

  Bacula variables can be read with:

     jcr.get("Variable-name")

    where jcr is the argument passed to the function, and Variable-name
    is on of the following:

     JobId, Client, Pool, Storage, Catalog, MediaType, NumVols, DirName,
       Level, Type, Job, JobName, JobStatus

   Bacula varibles can be set using Python keyword arguments:

      jcr.set(VolumeName="xyz")

    The two currently implemented writable "variables" are:

    VolumeName and JobReport

   It is possible to submit a Bacula run command with the following:

     jcr.run("run kernsave client=Matou storage=File")

   this function returns the JobId of the job that was started. If
   there is an error, the return value is zero.

   Example:

== File EndJob.py ===
import bacula

def EndJob(jcr):
    jobid = jcr.get("JobId")
    client = jcr.get("Client") 
    jcr.set(JobReport="EndJob output: JobId=%d Client=%s.\n" % (jobid, client))
    if (jobid < 5) :
       startid = jcr.run("run kernsave")
       print "Python started jobid=", startid

    return 1
====

== File NewVolume.py ===
import bacula

def NewVolume(jcr):
    jobid = jcr.get("JobId")
    print "JobId=", jobid
    client = jcr.get("Client") 
    print "Client=" + client
    numvol = jcr.get("NumVols");
    print "NumVols=", numvol
    jcr.set(JobReport="New Volume set for Job.\n") 
    jcr.set(VolumeName="TestA-001")
    return 1
====