]> git.sur5r.net Git - bacula/bacula/blob - bacula/ReleaseNotes
- Comment out Multiple Connections in the document.
[bacula/bacula] / bacula / ReleaseNotes
1
2           Release Notes for Bacula 1.37.6
3
4   Bacula code: Total files = 414 Total lines = 123,723 (*.h *.c *.in)
5
6
7 Major Changes:
8 - This version has a new database format that is not compatible
9   with previous databases. The upgrade scripts should work, but
10   they are not yet tested.
11 - SQLite3 support, but it seems to run at 1/2 to 1/4 the speed of
12   SQLite2.
13 - First cut at ANSI labels.
14 - New communications protocol between DIR and SD to reserve 
15   drives. The DIR and SD are no longer compatible with 1.36 or
16   lower versions.
17 - Preliminary Python Event support has been added. See below for
18   configuration and details.
19 - DVD writing support, using parts, and a lot of new directives in
20   the Device resource of the Storage configuration file.
21 - Seven new options keywords in a FileSet resource:
22   ignorecase, fstype, hfsplussupport, wilddir, wildfile, regexdir,
23   and regexfile. See below for details.
24
25 New Directives:
26 - New Run directive in Job resource of DIR. It permits
27   cloning of jobs.  To clone a copy of the current job, use
28      Run = "job-name level=%l since=\"%s\""
29   Note, job-name is normally the same name as the job that
30   is running but there is no restriction on what you put. If you
31   want to start the job by hand and use job overrides such as       
32   storage=xxx, realize that the job will be started with the
33   default storage values not the overrides.  The level=%l guarantees
34   that the chosen level of the job is the same, and the since=... 
35   ensures that the job uses *exactly* the same time/date for incremental
36   and differential jobs. The since=... is ignored when level=Full.
37   A cloned job will not start additional clones, so it is not possible
38   to recurse.
39 - New Options keywords in a FileSet directive:
40   - WildDir xxx
41     Will do a wild card match against directories (files will not
42     be matched).
43   - WildFile xxx
44     Will do a wild card match against files (directories will not
45     be matched).
46   - RegexDir xxx
47     Will do a regular expression match against directories (files
48     will not be matched).
49   - RegexFile xxx
50     Will do a regular expression match against files( directories
51     will not be matched).
52   - IgnoreCase = yes | no
53     Will ignore case in wild card and regular expression matches.
54     This is handy for Windows where filename case is not significant.
55   - FsType = string
56     where string is a filesystem type: ext2, jfs, ntfs, proc,
57     reiserfs, xfs, usbdevfs, sysfs, smbfs, iso9660.  For ext3
58     systems, use ext2.  You may have multiple fstype directives
59     and thus permit multiple filesystem types.  If the type
60     specified on the fstype directive does not match the
61     filesystem for a particular directive, that directory will
62     not be backed up.  This directive can be used to prevent
63     backing up non-local filesystems.
64   - HFS Plus Support = yes | no 
65     If set, Mac OS X resource forks will be saved and restored.
66 - Label Type = ANSI | IBM | Bacula   
67   Implemented in Director Pool resource and in SD Device resource.
68   If it is specified in the SD Device resource, it will take
69   precedence over the value passed from the Director to the SD.
70   IBM is not yet implemented.
71 - Check Labels = yes | no
72   Implemented in the SD Device resource. If you intend to read
73   ANSI or IBM labels, this *must* be set. Even if the volume
74   is not ANSI labeled, you can set this to yes, and Bacula will
75   check the label type.
76 - Scripts Directory = <directory> name.  Defines the directory from 
77   which Bacula scripts will be called for events. In fact, Bacula
78   appends this name to the standard Python list of search directories,
79   so the script could also be in any of the Python system directories.
80 - In FileSet, you can exclude backing up of hardlinks (if you have
81   a lot, it can be very expensive), by using:
82     HardLinks = no
83   in the Options section. Patch supplied by David R Bosso. Thanks.
84 - MaximumPartSize = bytes (SD, Device resource)
85   Defines the maximum part size.
86 - Requires Mount = Yes/No (SD, Device resource)
87   Defines if the device require to be mounted to be read, and if it
88   must be written in a special way. If it set, the following directives 
89   must be defined in the same Device resource:
90   + Mount Point = directory
91     Directory where the device must be mounted. 
92   + Mount Command = name-string
93     Command that must be executed to mount the device. Before the command
94     is executed, %a is replaced with the Archive Device, and %m with the 
95     Mount Point.
96   + Unmount Command = name-string
97     Command that must be executed to unmount the device. Before the 
98     command is executed, %a is replaced with the Archive Device, and 
99     %m with the Mount Point.
100   + Write Part Command = name-string
101     Command that must be executed to write a part to the device. Before
102     the command is executed, %a is replaced with the Archive Device, %m 
103     with the Mount Point, %n with the current part number (0-based), 
104     and %v with the current part filename.
105   + Free Space Command = name-string
106     Command that must be executed to check how much free space is left 
107     on the device. Before the command is executed, %a is replaced with 
108     the Archive Device, %m with the Mount Point, %n with the current part
109     number (0-based), and %v with the current part filename.
110 - Write Part After Job = Yes/No (DIR, Job Resource, and Schedule Resource)
111   If this directive is set to yes (default no), a new part file will be
112   created after the job is finished.
113
114 New Commands:
115 - "python restart" restarts the Python interpreter. Rather brutal, make
116    sure no Python scripts are running. This permits you to change
117    a Python script and get Bacula to use the new script.
118
119 Items to note!!!
120 - You must add --with-python=[DIR] to the configure command line
121   if you want Python support.  Python 2.2 and 2.3 should be automatically
122   detected if in the standard place.
123 - With Python 2.2 version, the link of the Director gets a few linker
124   warnings due to the fact that Python pulls in some old non-secure
125   libraries.
126 - With Python 2.3, there are a few compiler warnings.
127 - You must either create a new catalog database or upgrade your
128   old database (upgrade scripts not yet tested).
129
130 Other Items:
131 - 2 new scripts, dvd-writepart and dvd-freespace, in the scripts directory,
132   which are designed to be used as parameters to Write Part Command and
133   Free Space Command. They need the dvd+rw-tools to be installed
134   (http://fy.chalmers.se/~appro/linux/DVD+RW/).
135 - Part files support: File volumes can now be splitted in multiple
136   files, called "parts".
137 - Python scripting support:
138   A Python script will be called at particular points or conditions
139   in Bacula called Events. The currently defined Events are called:
140
141   StartJob, EndJob, NewVolume
142
143   Where StartJob is called before the RunBeforeJob, EndJob is called 
144   after RunAfterJob, and NewVolume, is called before all other 
145   "methods" of obtaining a new Volume name, when one is needed.
146
147   The Python script of the same name as the Event name (but with a .py) 
148   is called from the Scripts Directory (a directive defined in the
149   Director resource).  Note, both the Filename, and the name of
150   the function in the file must correspond to the Event name.
151
152   Once the Python script gets control, it can have access to Bacula
153   variables by doing:
154
155      import bacula
156
157   The script is called with one argument, typically called j. This
158   argument *must* be passed unchanged to each bacula function. The
159   format of the call is slightly different for reading Bacula
160   variable and for writing bacula variables. See below.
161
162   Bacula variables can be read with:
163
164      bacula.get(j, "Variable-name")
165
166     where j is the argument passed to the function, and Variable-name
167     is on of the following:
168
169      JobId, Client, Pool, Storage, Catalog, MediaType, NumVols, DirName,
170        Level, Type, Job, JobName, JobStatus
171
172    Bacula varibles can be set using Python keyword arguments:
173
174       bacula.set(jcr=j, VolumeName="xyz")
175
176     The two currently implemented writable "variables" are:
177
178     VolumeName and JobReport
179
180    It is possible to submit a Bacula run command with the following:
181
182      bacula.run(j, "run kernsave client=Matou storage=File")
183
184    this function returns the JobId of the job that was started. If
185    there is an error, the return value is zero.
186
187    Example:
188
189 == File EndJob.py ===
190 import bacula
191
192 def EndJob(j):
193     jobid = bacula.get(j, "JobId")
194     client = bacula.get(j, "Client") 
195     bacula.set(jcr=j, JobReport="EndJob output: JobId=%d Client=%s.\n" % (jobid, client))
196     if (jobid < 5) :
197        startid = bacula.run(j, "run kernsave")
198        print "Python started jobid=", startid
199
200     return 1
201 ====
202
203 == File NewVolume.py ===
204 import bacula
205
206 def NewVolume(j):
207     jobid = bacula.get(j, "JobId")
208     print "JobId=", jobid
209     client = bacula.get(j, "Client") 
210     print "Client=" + client
211     numvol = bacula.get(j, "NumVols");
212     print "NumVols=", numvol
213     bacula.set(jcr=j, JobReport="New Volume set for Job.\n") 
214     bacula.set(jcr=j, VolumeName="TestA-001")
215     return 1
216 ====
217