Skip to main content

Snapshot configuration

[snapshot]​

Snapshot lifetimes, quotas and preparation.
[snapshot]
default_lifetime = "1h"
max_lifetime = "30days"

snapshot.default_lifetime​

non-zero durationrestart to apply

The lifetime of a Snapshot created without snapshotLifetime.

Default
"1h"
Must be
0 < default_lifetime ≤ snapshot.max_lifetime
Environment variable
ANDROMEDA__SNAPSHOT__DEFAULT_LIFETIME

snapshot.max_lifetime​

non-zero durationrestart to apply

The longest a Snapshot lives. A longer requested snapshotLifetime is cut down to this.

Default
"30days"
Must be
0 < max_lifetime
Environment variable
ANDROMEDA__SNAPSHOT__MAX_LIFETIME

[snapshot.quota]​

How many Snapshots, and how much storage, one tenant may keep.
[snapshot.quota]
max_per_tenant = "unlimited"
max_storage_per_tenant = "unlimited"

snapshot.quota.max_per_tenant​

string or positive integerrestart to apply

The most Snapshots one tenant keeps, or "unlimited" to keep any number.

Default
"unlimited"
Allowed values
"unlimited"No limit.
Environment variable
ANDROMEDA__SNAPSHOT__QUOTA__MAX_PER_TENANT

snapshot.quota.max_storage_per_tenant​

string or sizerestart to apply

The most storage one tenant's Snapshots take, or "unlimited" to let them take any amount.

Default
"unlimited"
Allowed values
"unlimited"No limit.
Must be
0 < max_storage_per_tenant
Environment variable
ANDROMEDA__SNAPSHOT__QUOTA__MAX_STORAGE_PER_TENANT

[snapshot.preparation]​

How a Snapshot is prepared.
[snapshot.preparation]
page_size = 250
max_concurrent = 4
lease_timeout = "30s"
recovery_interval = "30s"
scoped_operation_timeout = "20s"

snapshot.preparation.page_size​

positive integerrestart to apply

The results read per page while a Snapshot captures its content.

Default
250
Must be
0 < page_size
Environment variable
ANDROMEDA__SNAPSHOT__PREPARATION__PAGE_SIZE

snapshot.preparation.max_concurrent​

positive integerrestart to apply

The most Snapshots prepared at once.

Default
4
Must be
0 < max_concurrent
Environment variable
ANDROMEDA__SNAPSHOT__PREPARATION__MAX_CONCURRENT

snapshot.preparation.lease_timeout​

non-zero durationrestart to apply

How long a claim keeps a preparation from every other worker before another may take it over.

Default
"30s"
Must be
0 < lease_timeout
Environment variable
ANDROMEDA__SNAPSHOT__PREPARATION__LEASE_TIMEOUT

snapshot.preparation.recovery_interval​

non-zero durationrestart to apply

How often preparations a crash or a missed run left unfinished are resumed. Creating a Snapshot starts preparing it at once, so this sweep only recovers.

Default
"30s"
Must be
0 < recovery_interval
Environment variable
ANDROMEDA__SNAPSHOT__PREPARATION__RECOVERY_INTERVAL

snapshot.preparation.scoped_operation_timeout​

non-zero durationrestart to apply

How long a request scoped to a Snapshot waits for its capture or clone to finish. A request still waiting then is answered 503 with Retry-After.

Default
"20s"
Must be
0 < scoped_operation_timeout < request_limits.timeout
Environment variable
ANDROMEDA__SNAPSHOT__PREPARATION__SCOPED_OPERATION_TIMEOUT