Configuration

The following article presents the configuration of the plugin.

The plugin consists of the following distinct parameters:

include=<path> This parameter specifies the path of a top-level directory to be backed up. It is possible to have multiple include= entries for each Fileset.
workers=<nb_workers> This parameter indicates the maximum number of parallel backup jobs that are allowed.

Note

The number of parallel workers is ultimately limited by the Maximum Concurrent Jobs setting in the Job, Client, Director, Storage, bigfs-backint.conf file specified by the conffile= plugin option, and other resources within Bacula.
files=<nb_files> This parameter defines the maximum number of files that can be processed before initiating another worker job. The default setting is 4.
conffile=<path> When this parameter is set, the plugin will search for its configuration at the specified location rather than the default location /opt/bacula/big-fs/big-fs-backint.conf.
ctrlfile=<path> This parameter indicates the base path for control files. FIFOs and .ctl files are created and used for establishing connection and communication with the bacula-fd plugin. The default value is /tmp/fs-backint.

Note

It is also possible to use the Fileset’s File = <path> clause to indicate files to backup.

The following block is an example of the Big FS Plugin configuration file and its relevant Fileset:

Fileset {
   Name = "big-fs-fileset"
   Description = "Automatic Big Filesystem Split FileSet"
   Include {
      Options {
         Signature = MD5
      }
      Plugin = "big-fs: workers=5 files=20 include=/home/user/ include=/etc/ conffile=/opt/bacula/etc/big-fs-job.conf ctrlfile=/opt/bacula/tmp/fs-backint"
   }
}

job=big-fs-job
client=hostname-fd
bconsole="/opt/bacula/etc/bconsole -n -c /opt/bacula/etc/bconsole.conf"
maximumconcurrentjobs=10
ctrlfile=/opt/bacula/tmp/fs-backint

Note

The settings maximumconcurrentjobs is a Bacula-wide configuration that is necessary for the plugin to operate effectively.
The settings maximumconcurrentjobs should be set such that it meets the condition maximumconcurrentjobs >= workers.
When multiple backint jobs are executed on the same system, each job must have its own fs-backint configuration file with the relevant job=<jobname> in it.
When multiple backint jobs are executed on the same system, each job must either have its own restricted console with the proper JobACL and FilesetACL, or add each of these ACLs to the same restricted Console configuration for each additional Job and Fileset pair.
To ensure that each job uses its own configuration file, the plugin parameter conffile=<path> should be employed.
The parameter ctrlfile=<path> must be the same in both Fileset and fs-backint.conf configurations.