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.
- BackupGenerationStatus
- BlobStoreConfiguration
- FoundationDBBackup
- FoundationDBBackupList
- FoundationDBBackupSpec
- FoundationDBBackupStatus
- FoundationDBBackupStatusBackupDetails
- FoundationDBLiveBackupStatus
- FoundationDBLiveBackupStatusState
- ImageConfig
BackupGenerationStatus stores information on which generations have reached different stages in reconciliation for the backup.
| Field | Description | Scheme | Required |
|---|---|---|---|
| reconciled | Reconciled provides the last generation that was fully reconciled. | int64 | false |
| needsBackupAgentUpdate | NeedsBackupAgentUpdate provides the last generation that could not complete reconciliation because the backup agent deployment needs to be updated. | int64 | false |
| needsBackupStart | NeedsBackupStart provides the last generation that could not complete reconciliation because we need to start a backup. | int64 | false |
| needsBackupStop | NeedsBackupStart provides the last generation that could not complete reconciliation because we need to stop a backup. | int64 | false |
| needsBackupPauseToggle | NeedsBackupPauseToggle provides the last generation that needs to have a backup paused or resumed. | int64 | false |
| needsBackupModification | NeedsBackupReconfiguration provides the last generation that could not complete reconciliation because we need to modify backup parameters. | int64 | false |
BackupState defines the desired state of a backup
BlobStoreConfiguration describes the blob store configuration.
| Field | Description | Scheme | Required |
|---|---|---|---|
| backupName | The name for the backup. If empty defaults to .metadata.name. | string | false |
| accountName | The account name to use with the backup destination. | string | true |
| bucket | The backup bucket to write to. The default is "fdb-backups". | string | false |
| urlParameters | Additional URL parameters passed to the blobstore URL. | []URLParameter | false |
FoundationDBBackup is the Schema for the foundationdbbackups API
| Field | Description | Scheme | Required |
|---|---|---|---|
| metadata | metav1.ObjectMeta | false | |
| spec | FoundationDBBackupSpec | false | |
| status | FoundationDBBackupStatus | false |
FoundationDBBackupList contains a list of FoundationDBBackup objects
| Field | Description | Scheme | Required |
|---|---|---|---|
| metadata | metav1.ListMeta | false | |
| items | []FoundationDBBackup | true |
FoundationDBBackupSpec describes the desired state of the backup for a cluster.
| Field | Description | Scheme | Required |
|---|---|---|---|
| version | The version of FoundationDB that the backup agents should run. | string | true |
| clusterName | The cluster this backup is for. | string | true |
| backupState | The desired state of the backup. The default is Running. | BackupState | false |
| agentCount | AgentCount defines the number of backup agents to run. The default is run 2 agents. | *int | false |
| snapshotPeriodSeconds | The time window between new snapshots. This is measured in seconds. The default is 864,000, or 10 days. | *int | false |
| backupDeploymentMetadata | BackupDeploymentMetadata allows customizing labels and annotations on the deployment for the backup agents. | *metav1.ObjectMeta | false |
| podTemplateSpec | PodTemplateSpec allows customizing the pod template for the backup agents. | *corev1.PodTemplateSpec | false |
| customParameters | CustomParameters defines additional parameters to pass to the backup agents. | FoundationDBCustomParameters | false |
| allowTagOverride | This setting defines if a user provided image can have it's own tag rather than getting the provided version appended. You have to ensure that the specified version in the Spec is compatible with the given version in your custom image. Deprecated: use ImageConfigs instead. | *bool | false |
| blobStoreConfiguration | This is the configuration of the target blobstore for this backup. | *BlobStoreConfiguration | false |
| mainContainer | MainContainer defines customization for the foundationdb container. | ContainerOverrides | false |
| sidecarContainer | SidecarContainer defines customization for the foundationdb-kubernetes-sidecar container. | ContainerOverrides | false |
FoundationDBBackupStatus describes the current status of the backup for a cluster.
| Field | Description | Scheme | Required |
|---|---|---|---|
| agentCount | AgentCount provides the number of agents that are up-to-date, ready, and not terminated. | int | false |
| deploymentConfigured | DeploymentConfigured indicates whether the deployment is correctly configured. | bool | false |
| backupDetails | BackupDetails provides information about the state of the backup in the cluster. | *FoundationDBBackupStatusBackupDetails | false |
| generations | Generations provides information about the latest generation to be reconciled, or to reach other stages in reconciliation. | BackupGenerationStatus | false |
FoundationDBBackupStatusBackupDetails provides information about the state of the backup in the cluster.
| Field | Description | Scheme | Required |
|---|---|---|---|
| url | string | false | |
| running | bool | false | |
| paused | bool | false | |
| snapshotTime | int | false |
FoundationDBLiveBackupStatus describes the live status of the backup for a cluster, as provided by the backup status command.
| Field | Description | Scheme | Required |
|---|---|---|---|
| DestinationURL | DestinationURL provides the URL that the backup is being written to. | string | false |
| SnapshotIntervalSeconds | SnapshotIntervalSeconds provides the interval of the snapshots. | int | false |
| Status | Status provides the current state of the backup. | FoundationDBLiveBackupStatusState | false |
| BackupAgentsPaused | BackupAgentsPaused describes whether the backup agents are paused. | bool | false |
FoundationDBLiveBackupStatusState provides the state of a backup in the backup status.
| Field | Description | Scheme | Required |
|---|---|---|---|
| Running | Running determines whether the backup is currently running. | bool | false |
URLParameter defines a single URL parameter to pass to the blobstore.
FoundationDBCustomParameter defines a single custom knob
ImageConfig provides a policy for customizing an image. When multiple image configs are provided, they will be merged into a single config that will be used to define the final image. For each field, we select the value from the first entry in the config list that defines a value for that field, and matches the version of FoundationDB the image is for. Any config that specifies a different version than the one under consideration will be ignored for the purposes of defining that image.
| Field | Description | Scheme | Required |
|---|---|---|---|
| version | Version is the version of FoundationDB this policy applies to. If this is blank, the policy applies to all FDB versions. | string | false |
| baseImage | BaseImage specifies the part of the image before the tag. | string | false |
| tag | Tag specifies a full image tag. | string | false |
| tagSuffix | TagSuffix specifies a suffix that will be added after the version to form the full tag. | string | false |