Skip to content

restore_spec.md

Latest commit

 

History

History
84 lines (55 loc) · 3.73 KB

restore_spec.md

File metadata and controls

84 lines (55 loc) · 3.73 KB

API Docs

This Document documents the types introduced by the FoundationDB Operator to be consumed by users.

Note this document is generated from code comments. When contributing a change to this document please do so by changing the code comments.

Table of Contents

FoundationDBKeyRange

FoundationDBKeyRange describes a range of keys for a command. The keys in the key range must match the following pattern: ^[A-Za-z0-9\/\\-]+$. All other characters can be escaped with \xBB, where BB is the hexadecimal value of the byte.

Field Description Scheme Required
start Start provides the beginning of the key range. string true
end End provides the end of the key range. string true

Back to TOC

FoundationDBRestore

FoundationDBRestore is the Schema for the foundationdbrestores API

Field Description Scheme Required
metadata metav1.ObjectMeta false
spec FoundationDBRestoreSpec false
status FoundationDBRestoreStatus false

Back to TOC

FoundationDBRestoreList

FoundationDBRestoreList contains a list of FoundationDBRestore objects

Field Description Scheme Required
metadata metav1.ListMeta false
items []FoundationDBRestore true

Back to TOC

FoundationDBRestoreSpec

FoundationDBRestoreSpec describes the desired state of the backup for a cluster.

Field Description Scheme Required
destinationClusterName DestinationClusterName provides the name of the cluster that the data is being restored into. string true
keyRanges The key ranges to restore. []FoundationDBKeyRange false
blobStoreConfiguration This is the configuration of the target blobstore for this backup. *BlobStoreConfiguration false
customParameters CustomParameters defines additional parameters to pass to the backup agents. FoundationDBCustomParameters false
encryptionKeyPath The path to the encryption key used to encrypt the backup. string false
backupVersion Instead of the latest version the backup can be restored to, restore to the specified version. *uint64 false

Back to TOC

FoundationDBRestoreState

FoundationDBRestoreState represents the states for a restore in FDB: https://github.com/apple/foundationdb/blob/fe47ce24d361a8c2d625c4d549f86ff98363de9e/fdbclient/FileBackupAgent.actor.cpp#L120-L140

Back to TOC

FoundationDBRestoreStatus

FoundationDBRestoreStatus describes the current status of the restore for a cluster.

Field Description Scheme Required
running Running describes whether the restore is currently running. bool false
state State describes the FoundationDBRestoreState state. FoundationDBRestoreState false

Back to TOC

FoundationDBCustomParameter

FoundationDBCustomParameter defines a single custom knob

Back to TOC