Skip to content

ABS Configuration Reference

Aerospike Backup Service (ABS) reads the configuration file aerospike-backup-service.yml to create connections to Aerospike Database namespaces and storage destinations, as well as backup policies, routines, and schedules.

For the parameter list in OpenAPI format, see the Schemas section in the REST API specification.

Configuration options

Search here for individual configuration options. Expand the cards to see more details and/or usage examples.

Options

aerospike-clusters.CLUSTER_NAME.conn-timeout

integer
description

Connection timeout in milliseconds.

introduced
1.0
removed
default
30000
example

conn-timeout

5000

aerospike-clusters.CLUSTER_NAME.credentials.auth-mode

string
description

The authentication mode used by the cluster.

introduced
1.0
removed
default
INTERNAL
values

INTERNAL, EXTERNAL, PKI

aerospike-clusters.CLUSTER_NAME.credentials.password-path

string
description

File path with the password string. Mutually exclusive with password field.

introduced
1.0
removed
default
example
aerospike-clusters:
cluster1:
credentials:
user: "admin"
password-path: "/path/to/pass.txt"

aerospike-clusters.CLUSTER_NAME.credentials.password

string
description

Plaintext password for cluster authentication. If it starts with secrets, path to password stored in Aerospike Secret Agent. Only use this plaintext authentication method for testing, never in production.

introduced
1.0
removed
default
example
aerospike-clusters:
cluster1:
credentials:
user: "admin"
password: "admin"

aerospike-clusters.CLUSTER_NAME.credentials.secret-agent-name

string
description

Name of secret agent to use to fetch password. Use a previously configured secret agent in the secret-agents configuration stanza.

introduced
3.0
removed
default
example
aerospike-clusters:
cluster1:
credentials:
secret-agent-name: "demoSa"

aerospike-clusters.CLUSTER_NAME.credentials.secret-agent

object
description

Configuration for one or more secret agents to use to fetch the password.

introduced
3.0
removed
default
example
aerospike-clusters:
cluster1:
credentials:
secret-agent:
... <secret agent config here> ...

aerospike-clusters.CLUSTER_NAME.credentials.user

string
description

Plaintext username for cluster authentication.

introduced
1.0
removed
default
example
aerospike-clusters:
cluster1:
credentials:
user: "admin"
password: "admin"

aerospike-clusters.CLUSTER_NAME.credentials

object
description

Authentication details in plain text for the Aerospike cluster.

introduced
1.0
removed
default
example
aerospike-clusters:
cluster1:
credentials:
user: "admin"
password: "admin"

aerospike-clusters.CLUSTER_NAME.label

string
description

A user-selected name for the cluster. It is used only in logs and error messages.

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.max-parallel-scans

integer
description

Maximum number of simultaneous allowed data reads, or scans, from the cluster during backup. This is a cluster-scope limit for all backup policies to prevent cluster overload.

introduced
2.0
removed
default
No limit if parameter is not provided.
example
aerospike-clusters:
absDefaultCluster:
seed-nodes:
- host-name: "localhost"
port: 3000
credentials:
user: "tester"
password: "psw"
max-parallel-scans: 8
values

Any non-negative integer

aerospike-clusters.CLUSTER_NAME.seed-nodes.host-name

string
description

Host name to connect to the seed node for communication with the Aerospike Database cluster.

introduced
1.0
removed
default
example
aerospike-clusters:
absCluster1:
seed-nodes:
- host-name: "aerospike-cluster"
port: 3000
credentials:
user: admin
password: admin

aerospike-clusters.CLUSTER_NAME.seed-nodes.port

integer
description

Port to connect to the seed node for communication with the Aerospike Database cluster.

introduced
1.0
removed
default
example
aerospike-clusters:
absCluster1:
seed-nodes:
- host-name: "aerospike-cluster"
port: 3000
credentials:
user: admin
password: admin

aerospike-clusters.CLUSTER_NAME.seed-nodes.tls-name

string
description

Optional TLS certificate name used for secure connections.

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.seed-nodes

array
description

A stanza with connection details of the seed nodes, or the nodes that Aerospike Backup Service uses to communicate with the cluster. On a multi-node cluster, you can supply connection information for a single node and the rest of the nodes will automatically be discovered.

introduced
1.0
removed
default
example
aerospike-clusters:
absCluster1:
seed-nodes:
- host-name: "aerospike-cluster"
port: 3000

aerospike-clusters.CLUSTER_NAME.tls.ca-file

string
description

Path to a trusted CA certificate file.

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.tls.ca-path

string
description

Path to a directory of trusted CA certificates.

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.tls.cert-file

string
description

Path to the chain file for mutual authentication if the Aerospike cluster supports it.

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.tls.cipher-suite

string
description

TLS cipher selection criteria. The format is the same as OpenSSL’s Cipher List Format.

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.tls.key-file-password

string
description

Password to load protected TLS-keyfile (env:VAR, file:PATH, PASSWORD).

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.tls.key-file

string
description

Path to the key for mutual authentication if the Aerospike cluster supports it.

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.tls.name

string
description

Default TLS name used to authenticate each TLS socket connection.

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.tls.protocols

string
description

TLS protocol selection criteria. This format is the same as Apache’s SSL Protocol.

introduced
1.0
removed
default
TLSv1.2

aerospike-clusters.CLUSTER_NAME.tls

object
description

A sub-stanza of a particular cluster with details about the cluster TLS configuration.

introduced
1.0
removed
default

aerospike-clusters.CLUSTER_NAME.use-services-alternate

boolean
description

Whether to use “services-alternate” instead of “services” in info request during cluster tending.

introduced
1.0
removed
default

backup-policies.POLICY_NAME.bandwidth

integer
description

Throttles backup write operations to the backup file(s) to not exceed the given bandwidth in MiB/s.

introduced
1.0
removed
default
0
example
bandwidth: 10000

backup-policies.POLICY_NAME.compression.level

integer
description

Compression level to use, or -1 if unspecified.

introduced
1.0
removed
default
0

backup-policies.POLICY_NAME.compression.mode

string
description

Compression mode to use. Options are NONE (default) or ZSTD.

introduced
1.0
removed
default
NONE
example
`NONE`
values

NONE, ZSTD

backup-policies.POLICY_NAME.compression

object
description

Compression details.

introduced
1.0
removed
default

backup-policies.POLICY_NAME.concurrent-incremental

boolean
description

Enables incremental backups to start while a full or incremental backup is ongoing.

introduced
3.1
removed
default
example

backup-policies.POLICY_NAME.encryption.key-env

string
description

Name of the environment variable containing the encryption key.

introduced
1.0
removed
default

backup-policies.POLICY_NAME.encryption.key-file

string
description

Path to the file containing the encryption key. The encryption key must be a valid PEM file.

introduced
1.0
removed
default
example
encryption:
mode: "AES256"
key-file: "/data/aerospike-backup-service/etc/aerospike-backup-service/keyfile1.dat"

backup-policies.POLICY_NAME.encryption.key-secret

string
description

Secret keyword in Aerospike Secret Agent containing the encryption key.

introduced
1.0
removed
default

backup-policies.POLICY_NAME.encryption.mode

string
description

Encryption mode to use. Options are NONE, AES128, or AES256.

introduced
1.0
removed
default
NONE
example
`NONE`
values

NONE, AES128, AES256

backup-policies.POLICY_NAME.encryption

object
description

Controls backup encryption information like the location of an encryption key or the keyword for Aerospike Secret Agent.

introduced
1.0
removed
default

backup-policies.POLICY_NAME.file-limit

integer
description

File size limit in MB for the backup file. If an .asb backup file crosses this size threshold, a new backup file is created.

introduced
1.0
removed
default
250
example
file-limit: 1024

backup-policies.POLICY_NAME.max-records

integer
description

Approximate limit for the number of records to process. Available in Database 4.9 and later.

introduced
1.0
removed
2.0
default
example
max-records: 10000

backup-policies.POLICY_NAME.max-retries

integer
description

Maximum number of retries before aborting the current transaction. Removed in 3.0 and replaced with the retry-policy substanza.

introduced
1.0
removed
3.0
default
example
"parallel":1,
"max-retries": 3

backup-policies.POLICY_NAME.no-bins

boolean
description

Only back up record metadata; digest, TTL, generation count, key.

introduced
1.0
removed
2.0
default

backup-policies.POLICY_NAME.no-indexes

boolean
description

Whether to back up secondary index definitions.

introduced
1.0
removed
default

backup-policies.POLICY_NAME.no-records

boolean
description

Whether to back up record data, metadata or bin data.

introduced
1.0
removed
default

backup-policies.POLICY_NAME.no-udfs

boolean
description

Whether to back up UDF modules.

introduced
1.0
removed
default

backup-policies.POLICY_NAME.parallel-write

integer
description

Maximum number of threads to use for writing backup files. This defaults to the same value as parallel.

introduced
3.2.0
removed
default
-
example
1

backup-policies.POLICY_NAME.parallel

integer
description

Maximum number of scan calls to run in parallel. Each scan call processes a subset of the total data partitions. This value should always be equal to or less than aerospike-clusters.CLUSTER_NAME.max-parallel-scans.

introduced
1.0
removed
default
8
example
1

backup-policies.POLICY_NAME.records-per-second

integer
description

Limit total returned records per second (RPS). If RPS is zero (the default), the records-per-second limit is not applied.

introduced
1.0
removed
default
0
example
1000

backup-policies.POLICY_NAME.remove-artifacts

boolean
description

Clear directory or remove output file.

introduced
1.0
removed
2.0
default

backup-policies.POLICY_NAME.retention.full

integer
description

The total number of full backups to retain. The minimum is 1, meaning each new full backup deletes the previous one. If not specified, all full backups are kept.

introduced
3.0
removed
default
example
full: 5
values

Any integer equal to or greater than 1

backup-policies.POLICY_NAME.retention.incremental

integer
description

The number of most recent full backups for which incremental backups are retained. Cannot exceed the value of full. If omitted, all incremental backups are kept. A value of 0 means that all previous incremental backups will be deleted after each full backup is made.

introduced
3.0
removed
default
example
incremental: 3
values

Integer values equal to or less than 0 and equal to or less than full.

backup-policies.POLICY_NAME.retention

integer
description

A stanza that optionally specifies retention rules for a given backup policy.

introduced
3.0
removed
default
example
removeFilesPolicy:
retention:
full: 5
incremental: 3

backup-policies.POLICY_NAME.retry-delay

integer
description

Delay in milliseconds to wait before retrying a failed operation.

introduced
1.0
removed
3.0
default
example
500

backup-policies.POLICY_NAME.retry-policy.base-timeout

integer
description

Initial delay between retry attempts, in milliseconds.

introduced
3.0
removed
default
1000
example

backup-policies.POLICY_NAME.retry-policy.max-retries

integer
description

Maximum number of retry attempts that will be made. If set to 0, no retries will be performed.

introduced
3.0
removed
default
5
example

backup-policies.POLICY_NAME.retry-policy.multiplier

integer
description

Increases the delay between subsequent retry attempts. The actual delay is calculated as: BaseTimeout * (Multiplier ^ attemptNumber)

introduced
3.0
removed
default
1
example

backup-policies.POLICY_NAME.retry-policy

description

Define a policy in this section for the initial waiting time before a retry, number of retries, and a multiplier that extends the wait interval. A retry policy can also be sent as part of a JSON restore request.

introduced
3.0
removed
default
example
backup-policies:
example-backup-policy:
... # additional stanzas
retry-policy:
base-timeout: 1000 # 1000 milliseconds
max-retries: 4
multiplier: 2
... # additional stanzas

backup-policies.POLICY_NAME.sealed

boolean
description

Whether backup should include keys updated during the backup process. When true, the backup contains only records that were last modified before backup started. When false, records updated during backup may be included in the backup.

introduced
1.0
removed
default

backup-policies.POLICY_NAME.socket-timeout

integer
description

Socket timeout in milliseconds. If this value is 0, it is set to total-timeout. If both socket-timeout and total-timeout are 0, there is no socket idle time limit.

introduced
1.0
removed
default
60000
example
1000

backup-policies.POLICY_NAME.total-timeout

integer
description

Total socket timeout in milliseconds.

introduced
1.0
removed
default
0
example
2000

backup-routines.ROUTINE_NAME.backup-policy

string
description

Name of the corresponding backup policy.

introduced
1.0
removed
default
example

Example backup routine containing a policy called keepFilesPolicy

backup-routines:
minioRoutine:
interval-cron: "@daily"
incr-interval-cron: "@hourly"
source-cluster: absCluster1
storage: minioStorage
namespaces: ["test"]
backup-policy: keepFilesPolicy

backup-routines.ROUTINE_NAME.bin-list

array
description

List of bin names to back up. An empty list backs up all bins.

introduced
1.0
removed
default
[]
example
["dataBin"]

backup-routines.ROUTINE_NAME.incr-interval-cron

string
description

Interval for incremental backup as a cron expression string. Intervals are extended cron (7 symbols: year, month, week, day, hour, minute, second). All times are in UTC time zone. Supported reserved words: @yearly, @monthly, @weekly, @daily, @hourly

introduced
1.0
removed
default
example
*/10 * * * * *

backup-routines.ROUTINE_NAME.interval-cron

string
description

Interval for full backup as a cron expression string. Intervals are extended cron (7 symbols: year, month, week, day, hour, minute, second). All times are in UTC time zone. Supported reserved words: @yearly, @monthly, @weekly, @daily, @hourly

introduced
1.0
removed
default
example
0 0 * * * *

backup-routines.ROUTINE_NAME.namespaces

array
description

List of namespaces to back up. Empty list implies backup of whole cluster.

introduced
1.0
removed
default
[]
example
["source-ns1"]

backup-routines.ROUTINE_NAME.node-list

array
description

List of nodes to back up. Formatted as a list of IP addresses and/or host names followed by port numbers. Empty list implies backup of whole cluster.

introduced
1.0
removed
default
[]
example
IP_ADDRESS:PORT(,IP_ADDRESS:PORT,...)

backup-routines.ROUTINE_NAME.partition-list

string
description

Filter that specifies individual partitions or a range of partitions to back up. Partition filters can be ranges, individual partitions, or records after a specific digest within a single partition.

  • A range is specified as ”-”: “100-50” backs up 50 partitions starting from 100.
  • A single partition is specified as a number: “0” backs up the first partition at position 0.
  • Multiple entries can be comma-separated: “0,100,200,300,400,500” backs up only the partitions in the list.

By default, all partitions are backed up. This field is mutually exclusive with node-list.

introduced
1.0
removed
default
example

Back up partitions 100, 200, and a range of 400 partitions starting at 300.

100,200,300-400

backup-routines.ROUTINE_NAME.prefer-racks

array
description

List of Aerospike Database rack IDs to prefer when reading records for a backup.

introduced
1.0
removed
default
[]
example
[0]

backup-routines.ROUTINE_NAME.secret-agent

string
description

The Secret Agent configuration for the routine (optional).

introduced
1.0
removed
default
[]
example
secret-agent-configuration

backup-routines.ROUTINE_NAME.set-list

array
description

List of set names to back up. An empty list backs up all sets.

introduced
1.0
removed
default
[]
example
["set1"]

backup-routines.ROUTINE_NAME.source-cluster

string
description

Name of the corresponding source cluster.

introduced
1.0
removed
default
example
testCluster

backup-routines.ROUTINE_NAME.storage

string
description

Name of the corresponding storage provider configuration.

introduced
1.0
removed
default
example

Example using minIO storage

storage: minioStorage

backup-routines

stringrequired
description

A top-level stanza specifying the details of one or more backup routines.

introduced
1.0
removed
default
example

Example routine called routine1

backup-routines:
routine1:
interval-cron: "1/30 * * * * *"
incr-interval-cron: "1/5 * * * * *"
backup-policy: "policy1"
source-cluster: "cluster1"
storage: "local1"
namespaces: ["test"]

cluster

required
description

A top-level stanza containing cluster objects for each of the Aerospike clusters that ABS is connected to.

introduced
1.0
removed
default
example
aerospike-clusters:
cluster1:
use-services-alternate: false
seed-nodes:
- host-name: "127.0.0.1"
port: 3000
credentials:
user: "admin"
password: "admin"

service.http.address

string
description

The HTTP listen address.

introduced
1.0
removed
default
0.0.0.0
example

Example service stanza with http and logger substanzas

service:
http:
address: 10.0.0.1
port: 8080

service.http.context-path

string
description

Specifies a custom path for the ABS API endpoints.

introduced
1.0
removed
default
8080
example

Example service stanza with http and logger substanzas

service:
http:
address: 10.0.0.1
port: 8080

service.http.port

description

The HTTP listen port.

introduced
1.0
removed
default
8080
example

Example service stanza with http stanza and port of 8080

service:
http:
address: 10.0.0.1
port: 8080

service.http.rate.size

integer
description

Rate limiter token bucket size, also known as the burst threshold.

introduced
1.0
removed
default
1024
example

Example service stanza with all service.http.rate substanzas listed

service:
http:
address: 10.0.0.1
port: 8080
rate:
size:
tps:
white-list:

service.http.rate.tps

integer
description

Rate limiter tokens per second threshold.

introduced
1.0
removed
default
1024
example

Example service stanza with all service.http.rate substanzas listed

service:
http:
address: 10.0.0.1
port: 8080
rate:
size:
tps:
white-list:

service.http.rate.white-list

list of strings
description

List of IP addresses allowed during rate limiting. All addresses are allowed by default.

introduced
1.0
removed
default
example

Example service stanza with all service.http.rate substanzas listed

service:
http:
address: 10.0.0.1
port: 8080
rate:
size:
tps:
white-list:

service.http.rate

description

HTTP rate limiter configuration.

introduced
1.0
removed
default
0.0.0.0
example

Example service stanza with all service.http.rate substanzas listed

service:
http:
address: 10.0.0.1
port: 8080
rate:
size:
tps:
white-list:

service.http.timeout

integer
description

Timeout for HTTP server operations in milliseconds.

introduced
1.0
removed
default
5000
example

Example service stanza with a 10-second timeout

service:
http:
address: 10.0.0.1
port: 8080
timeout: 10000

service.http

required
description

Configures the HTTP server for ABS.

introduced
1.0
removed
default
example

Example service stanza with http and logger substanzas

service:
http:
port: 9000
logger:
level: INFO
file-writer:
filename: /var/log/aerospike-backup-service.log

service.logger.file-writer.compress

boolean
description

Determines if the rotated log files should be compressed using gzip. The default is to not compress.

introduced
1.0
removed
default
false
example

Example file-writer substanza enabling file compression with gzip

service:
logger:
level: INFO
file-writer:
filename: /var/log/aerospike-backup-service.log
compress: true

service.logger.file-writer.filename

stringrequired
description

Log destination.

introduced
1.0
removed
default
example

Example service stanza with logger substanza

service:
logger:
level: INFO
file-writer:
filename: /var/log/aerospike-backup-service.log

service.logger.file-writer.maxage

int
description

Maximum number of days to retain log files based on the timestamp in the filename. Default is to not remove log files based on age.

introduced
1.0
removed
default
example

Example logger stanza set to remove backups after 30 days

service:
logger:
maxage: 30
file-writer:
filename: /var/log/aerospike-backup-service.log

service.logger.file-writer.maxbackups

integer
description

Maximum number of log files to retain. The default is to retain all log files.

introduced
1.0
removed
default
example

Example logger config keeping 10 old log files

service:
logger:
maxbackups: 10
file-writer:
filename: /var/log/aerospike-backup-service.log

service.logger.file-writer.maxsize

integer
description

Maximum size in megabytes of the log file before it gets rotated.

introduced
1.0
removed
default
example

Example service stanza with logger substanza

service:
logger:
level: INFO
file-writer:
filename: /var/log/aerospike-backup-service.log

service.logger.file-writer

description

Substanza that configures the file writing protocol, such as the destination directory.

introduced
1.0
removed
default
example

Example logger stanza with the filename specified

service:
logger:
level: INFO
file-writer:
filename: /var/log/aerospike-backup-service.log

service.logger.format

string
description

Format is the logger format (PLAIN, JSON).

introduced
1.0
removed
default
PLAIN
example

Example stanza setting the format to JSON

service:
logger:
level: INFO
format: JSON
file-writer:
filename: /var/log/aerospike-backup-service.log
values

PLAIN, JSON

service.logger.level

string
description

Log level.

introduced
1.0
removed
default
DEBUG
example

Example logger stanza setting the level to INFO

service:
logger:
level: INFO
format: PLAIN
file-writer:
filename: /var/log/aerospike-backup-service.log
values

TRACE, DEBUG, INFO, WARN, WARNING, ERROR

service.logger.stdout-writer

boolean
description

Whether to enable logging to the standard output.

introduced
1.0
removed
default
true
example

Example service stanza with logger substanza

service:
logger:
level: INFO
stdout-writer: false
file-writer:
filename: /var/log/aerospike-backup-service.log

service.logger

required
description

Configures the ABS logger, such as enabling the logs, setting the log level, and setting the log format.

introduced
1.0
removed
default
example

Example service stanza with logger substanza

service:
logger:
level: INFO
file-writer:
filename: /var/log/aerospike-backup-service.log

service

required
description

Top-level stanza that configures the operation of the Aerospike Backup Service, including logging and HTTP endpoint.

introduced
1.0
removed
default
example

Example service stanza with http and logger substanzas

service:
http:
port: 9000
logger:
level: INFO
file-writer:
filename: /var/log/aerospike-backup-service.log

storage.STORAGE_NAME.azure-storage.account-key

description

Azure storage account key for Shared Key authentication. This is sensitive information. Can be a path in secret agent or an actual value.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.azure-storage.account-name

description

Azure storage account name for Shared Key authentication.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.azure-storage.client-id

description

Azure Active Directory client ID for AAD authentication.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.azure-storage.client-secret

description

Azure Active Directory client secret for AAD authentication. This is sensitive information. Can be a path in secret agent or an actual value.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.azure-storage.container-name

required
description

Name of the Azure Blob container.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.azure-storage.endpoint

required
description

Azure Blob service endpoint URL.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.azure-storage.min-part-size

description

The minimum size in bytes of individual chunks uploaded during a multipart upload.

introduced
3.2
removed
default
5242880
example
values

integer

storage.STORAGE_NAME.azure-storage.path

description

Root path for the backup repository within the container. If not specified, backups will be saved in the container’s root.

introduced
3.0
removed
default
example
path: backups
values

string

storage.STORAGE_NAME.azure-storage.secret-agent-name

description

Secret Agent configuration (optional). Link to a preconfigured agent. Mutually exclusive with secret-agent.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.azure-storage.secret-agent

description

Secret Agent object definition. Mutually exclusive with secret-agent-name.

introduced
3.0
removed
default
example

storage.STORAGE_NAME.azure-storage.tenant-id

description

Azure Active Directory tenant ID for AAD authentication.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.azure-storage

description

Stanza defining Azure storage options. Mutually exclusive with other storage objects. Can also take a secret-agent substanza.

introduced
3.0
removed
default
example
storage:
azure-blob-storage-example:
azure-storage:
endpoint: http://127.0.0.1:6000/devstoreaccount1
container-name: testcontainer
path: backups
account-name: devstoreaccount1

storage.STORAGE_NAME.gcp-storage.bucket-name

required
description

GCP storage bucket name.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.gcp-storage.endpoint

description

Alternative URL. It is not recommended to use an alternate URL in a production environment.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.gcp-storage.key-file-path

description

Path to the file containing the service account key in JSON format.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.gcp-storage.key

description

Service account key in JSON format. This is sensitive information. Can be a path in secret agent or an actual value.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.gcp-storage.min-part-size

description

The minimum size in bytes of individual chunks uploaded during a multipart upload.

introduced
3.2
removed
default
5242880
example
values

integer

storage.STORAGE_NAME.gcp-storage.path

description

Root path for the backup repository. If not specified, backups will be saved in the bucket’s root.

introduced
3.0
removed
default
example
path: backups
values

string

storage.STORAGE_NAME.gcp-storage.secret-agent-name

description

Secret Agent configuration (optional). Link to one of preconfigured agents. Mutually exclusive with secret-agent.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.gcp-storage.secret-agent

description

Secret Agent object definition. Mutually exclusive with secret-agent-name.

introduced
3.0
removed
default
example
values

object

storage.STORAGE_NAME.gcp-storage

description

Stanza defining GCP storage options. Mutually exclusive with other storage objects. Can also take a secret-agent substanza.

introduced
3.0
removed
default
example
storage:
gcp-storage-example:
gcp-storage:
key-file-path: key-file.json
bucket-name: gcp-backup-bucket
path: backups
endpoint: http://127.0.0.1:9020

storage.STORAGE_NAME.local-storage.path

required
description

Root path for the backup directory when backing up locally.

introduced
3.0
removed
default
example
storage:
example-local-storage-object:
local-storage:
path: backups

storage.STORAGE_NAME.local-storage

description

Stanza defining local storage options. Mutually exclusive with other storage objects.

introduced
3.0
removed
default
example
storage:
example-local-storage-object:
local-storage:
path: backups

storage.STORAGE_NAME.path

description

Root path for the backup directory.

introduced
1.0
removed
3.0
default
example
path: backups

storage.STORAGE_NAME.s3-endpoint-override

string
description

Alternative endpoint for the S3 SDK to communicate (AWS S3 optional).

introduced
1.0
removed
3.0
default
example
s3-endpoint-override: http://host.docker.internal:9000

storage.STORAGE_NAME.s3-log-level

string
description

Log level of the AWS S3 SDK (AWS S3 optional).

introduced
1.0
removed
3.0
default
example
s3-log-level: FATAL

storage.STORAGE_NAME.s3-profile

string
description

The S3 profile name (AWS S3 optional).

introduced
1.0
removed
3.0
default
example
s3-profile: default

storage.STORAGE_NAME.s3-region

string
description

S3 region string (AWS S3 optional).

introduced
1.0
removed
3.0
default
example
s3-region: eu-central-1

storage.STORAGE_NAME.s3-storage.access-key-id

description

Access Key ID for authentication with S3 StaticCredentialsProvider. This is sensitive information. Can be a path in secret agent or an actual value.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.s3-storage.bucket

required
description

The S3 bucket name.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.s3-storage.max-async-connections

description

The maximum number of simultaneous requests allowed from S3. This parameter was named max_async_connections until 3.1

introduced
3.0
removed
default
example
values

integer

storage.STORAGE_NAME.s3-storage.min-part-size

description

The minimum size in bytes of individual chunks uploaded during a multipart upload. This parameter was named min_part_size until version 3.1.

introduced
3.0
removed
default
5242880
example
values

integer

storage.STORAGE_NAME.s3-storage.path

description

The root path for the backup repository within the bucket. If not specified, backups will be saved in the bucket’s root.

introduced
3.0
removed
default
example
path: backups
values

string

storage.STORAGE_NAME.s3-storage.s3-endpoint-override

description

An alternative endpoint for the S3 SDK to communicate (AWS S3 optional).

introduced
3.0
removed
default
example
s3-endpoint-override: http://host.docker.internal:9000
values

string

storage.STORAGE_NAME.s3-storage.s3-log-level

description

The log level of the AWS S3 SDK (AWS S3 optional).

introduced
3.0
removed
default
FATAL
example
values

string

storage.STORAGE_NAME.s3-storage.s3-profile

description

The S3 profile name (AWS S3 optional).

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.s3-storage.s3-region

required
description

The S3 region string.

introduced
3.0
removed
default
example
region: eu-central-1
values

string

storage.STORAGE_NAME.s3-storage.secret-access-key

description

Secret Access Key for authentication with S3 StaticCredentialsProvider. This is sensitive information. Can be a path in Aerospike Secret Agent or an actual value.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.s3-storage.secret-agent-name

description

Secret Agent configuration (optional). Link to one of preconfigured agents. Mutually exclusive with secret-agent.

introduced
3.0
removed
default
example
values

string

storage.STORAGE_NAME.s3-storage.secret-agent

description

Secret Agent object definition. Mutually exclusive with secret-agent-name.

introduced
3.0
removed
default
example

storage.STORAGE_NAME.s3-storage

description

Stanza defining AWS S3 storage options. Mutually exclusive with other storage objects. Can also take a secret-agent substanza.

introduced
3.0
removed
default
example
storage:
aws-s3-example-object:
s3-storage:
bucket: as-backup-bucket
path: backups
s3-region: eu-central-1

storage.STORAGE_NAME.type

string
description

Type of the storage provider.

introduced
1.0
removed
3.0
default
example
type: local

storage

required
description

A top-level stanza with options for configuring local or remote storage. Define a custom name for each storage object you create, then use further parameters to define each object’s details.

introduced
1.0
removed
default
example
storage:
# Example 1: Local Storage
storage1:
local-storage:
path: /local/backups
# Example 2: S3 Storage
storage2:
s3-storage:
bucket: my-backup-bucket
path: backups
s3-profile: default
s3-region: eu-central-1
Feedback

Was this page helpful?

What type of feedback are you giving?

What would you like us to know?

+Capture screenshot

Can we reach out to you?