Cloud Resource

The Cloud Storage Driver must be installed in the Bacula Storage Daemon Plugin Directory to be used.

Name

Name = <Device-Name> The name of the Cloud resource. This is the logical Cloud name, and may be any string up to 127 characters in length.

Description

Description = <Text> The description is used for display purposes as is the case with all resource.

Driver

Driver = <DriverName> This defines which driver to use. It can be S3, Amazon, Azure, Google, Oracle or Swift. There is also a File driver, which is used mostly for testing.

Host Name

Host Name = <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 and may contain a TCP port specification. This directive is not used with the Azure driver.

Bucket Name

Bucket Name = <Name> This directive specifies the bucket name that you wish to use on the Cloud service. This name is normally a unique name that you create on the cloud service that identifies where you want to place your Cloud Volumes. The maximum bucket name size is 255 characters.

Access Key

Access Key = <String> The access key is your unique user identifier given to you by your cloud service provider.

Secret Key

Secret Key = <String> The secret key is the security key that was given to you by your cloud service provider. It is equivalent to a password.

Protocol

Protocol = <HTTP | HTTPS> The protocol defines the communications protocol to use with the cloud service provider. The two protocols currently supported are: HTTPS and HTTP. The default is HTTPS.

Uri Style

Uri Style = <VirtualHost | Path> 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

Truncate Cache = <Truncate-kw> This directive specifies when Bacula should automatically remove (truncate) the local cache parts. Local cache parts will only be removed if they have been uploaded to the cloud. The currently implemented values are:

  • No Do not remove cache. With this option you must manually delete the cache parts with the bconsole truncate cache command, or do so with an Admin Job that runs the truncate cache command. This is the default.

  • AfterUpload Each part will be removed just after it is uploaded. Note, if this option [2]_ is specified, all restores will require a download from the Cloud.

  • AtEndOfJob With this option [3]_, at the end of the Job, every part that has been uploaded to the Cloud will be removed (truncated).

Upload

Upload = <Upload-kw> This directive specifies when local cache parts will be uploaded to the Cloud. The options are:

  • Manual / No 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

Maximum Concurrent Uploads = <number> The default is 3, but by using this directive, you may set it to any value you want.

Maximum Concurrent Downloads

Maximum Concurrent Downloads = <number> The default is 3, but by using this directive, you may set it to any value you want.

Maximum Upload Bandwidth

Maximum Upload Bandwidth = <speed> 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

Maximum Download Bandwidth = <speed> 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

Region = <String> The Cloud resource can be configured to use a specific endpoint within a region. This directive is required for AWS-V4 regions, ex: Region=. “eu-central-1”

An example of a Cloud Resource might be:

Cloud {
    Name = AmazonCloud
    Driver = "Amazon"
    HostName = "s3.amazonaws.com"
    BucketName = "BaculaVolumes"
    AccessKey = "BZIXAIS39DYNER5FZ"
    SecretKey = "beesheeg7iTe0Gaex7aedie4aWohfuewohGaa0"
    Protocol = HTTPS
    UriStyle = VirtualHost
    Truncate Cache = No
    Upload = EachPart
    Region = "us-east-1"
    MaximumUploadBandwidth = 5MB/s
}

Transfer Priority

Transfer Priority = <High | Medium | Low> When restoring directly a part from Glacier, this directive indicates the rehydration priority level. Values can be High, Medium or Low. Default is High. Those values match respectively Expeditive, Standard and Bulk transfers tiers within S3.

Transfer Retention

Transfer Retention = <time-period-specification> This directive indicates the number of days the restored part must remain in S3’s Reduced Redundancy Storage (RRS), available for download into the cache. At the end of this period the part will be removed from S3; the object will remain in Glacier. The minimum value is 1 day. The default is 5 days.

BlobEndpoint

BlobEndpoint This directive can be used to specify a custom URL for either the Azure Cloud blob (used by the Azure Driver) or the Amazon S3 blob (used by the Amazon Driver).

EndpointSuffix

EndpointSuffix use this directive to specify a custom URL postfix for Azure (used by the Azure Driver only). Ex: EnbpointSuffix=”core.chinacloudapi.cn”

StorageClass

StorageClass (available with Bacula Enterprise 14.0.5 and later) this directive can be used to specify the storageClass for all parts transferred to the cloud, independently of the destination bucket class. Values can be S3Standard, S3StandardIA, S3IntelligentTiering, S3OneZoneIA, S3GlacierInstantRetrieval, S3GlacierFlexibleRetrieval, S3GlacierDeepArchive, S3Rrs. (used by the Amazon Driver only).

Go back to Storage Daemon Resource Types page.

Go back to the Technical Reference for Storage Daemon.

Go back to the main Technical Reference page.