Cloud Resource Directives

Below, there are directives common to all the Cloud resource drivers.

Note

The directives specific only to a given driver are presented in the separate section.

Name The name of the Cloud resource, for instance MyCloud in some of the examples above.
Description The description is used for display purposes in Bweb as it is the case with all resources. Not shown in examples.
Driver This defines which driver to use. Valid options are (depending on the installed cloud driver): Amazon, S3 (deprecated), Azure, Google, Oracle, Swift and File (File is used mostly for testing). Amazon is similar to S3 but uses bacula-sd-cloud-aws-driver instead of bacula-sd-cloud-s3-driver. The specific differences for the Cloud directives that are different in the File driver are discussed in the next section.
Host Name This directive specifies the hostname to be used in the URL. Each Cloud service provider has a different and unique hostname. The maximum size is 255 characters.
- Azure: This directive is not used, but it needs to be specified with dummy data to satisfy the parser.
- Google: This directive needs to be specified when gcloud has been installed in a custom location, in which case, the value should be “/path/to/google-config/folder/”.
- Oracle: The oci cli must be installed. If you configured oci into /opt/bacula/etc/oci/, this directive is not required. It needs to be specified when the oci config file is installed in a custom location, in which case its value should be “/path/to/oci/config”.
- Swift: This directive is not used, but it needs to be specified with dummy data to satisfy the parser.
Bucket Name This directive specifies the bucket name that you wish to use on the Cloud service. This name is normally a unique name that identifies where you want to place your Cloud Volume parts.
- With Amazon, the bucket must be created previously on the Cloud service.
- With S3, the bucket must be created previously on the Cloud service.
- With Azure Storage it is generally referred to as Container and it can be created automatically by Bacula when it does not exist.
- With Google Cloud, the bucket must be created previously on the Cloud service.
- With Oracle Cloud, the bucket must be created previously in the OCI Console.
The maximum bucket name size is 255 characters.
Access Key The access key is your unique user identifier given to you by your cloud service provider.

This directive needs to be specified for Bacula Storage daemon compatibility but is not relevant with the Swift driver.

Note

When dealing with the S3 Plugin (Amazon or S3 drivers), confirm the AccessKeyId value provided by your S3 Cloud provider is compatible with the Amazon API as it doesn’t allow some special characters.
Secret Key The secret key is the security key that was given to you by your cloud service provider. It is equivalent to a password.

This directive needs to be specified for Bacula Storage Daemon compatibility but is not relevant with the Swift driver.
Protocol The protocol defines the communication protocol to use with the cloud service provider. The two protocols currently supported are: HTTPS and HTTP. The default is HTTPS.
Uri Style This directive specifies the URI style to use to communicate with the cloud service provider. The two Uri Styles currently supported are: VirtualHost and Path. The default is VirtualHost.
Truncate Cache This directive specifies if and when Bacula should automatically remove (truncate) the local cache Volume parts. Local cache Volume parts can only be removed if they have been successfully uploaded to the cloud. The currently implemented values are:
- No Do not remove cache Volume parts. With this setting, you must manually delete the cache parts with a bconsole Truncate Cache command, or do so with an Admin Job that runs a Truncate Cache command. If not specified, this is the default.
- AfterUpload Each cache Volume part will be removed just after it is uploaded. Note, if this option is specified, all restores will require a download from the Cloud.
- AtEndOfJob At the end of the Job, every part that has been successfully uploaded to the Cloud will be removed (truncated). Note, if this option is specified, all restores will require a download from the Cloud.
Upload This directive specifies when local cache Volume parts will be uploaded to the Cloud. The options are:
- Manual Do not upload Volume cache parts automatically. With this option you must manually upload the Volume cache parts with a bconsole Upload command, or do so with an Admin Job that runs an Upload command. If not specified, this is the default.
- EachPart With this option, each cache Volume part will be uploaded when it is complete i.e. when the next Volume part is created or at the end of the Job.
- AtEndOfJob With this option all cache Volume parts that have not been previously uploaded will be uploaded at the end of the Job.
Maximum Concurrent Uploads The default is 3, but by using this directive, you may set it to any value that fits your environment.
Maximum Concurrent Downloads The default is 3, but by using this directive, you may set it to any value that fits your environment.
Maximum Upload Bandwidth The default is unlimited, but by using this directive, you may limit the upload bandwidth used globally by all devices referencing this Cloud resource.
Maximum Download Bandwidth The default is unlimited, but by using this directive, you may limit the download bandwidth used globally by all devices referencing this Cloud resource.
Region The Cloud resource may be configured to use a specific endpoint within a region. This directive is required for AWS-V4 regions. ex: Region="eu-central-1"