Spec schema
BackupPlan Spec defines the selected state of BackupPlan.
BackupPlan
:
metadata
:
name
:
string
spec
:
backupLocation
:
gcsOptions
:
bucket
:
string
key
:
string
type
:
string
dbclusterRef
:
string
Field
TypeRequired or optional
Description
name
string
Required
Name of the BackupPlan resource.
backupLocation
object
Optional
BackupLocation specifies the remote object storage location to store backups. For example, specs to a Cloud Storage bucket. This field is optional. By default, backups are stored in the backup disk.
backupLocation.gcsOptions
object
Optional
gcsOptions is a reference to dependent options for Cloud Storage.
backupLocation.gcsOptions.bucket
string
Required
Bucket is a required field—for example,
dbs-dump-bucket
. A user must ensure proper write access to the storage bucket from within the Operator.backupLocation.gcsOptions.key
string
Required
Object key for the dump files—for example,
ods-dump/scottschema.dmp
.dbclusterRef
string
Optional
The DBCluster name that this backup plan configures. This field is required and immutable.
Status schema
BackupPlanStatus defines the observed state of BackupPlan.
conditions
:
-
lastTransactionTime
:
string
message
:
string
observedGeneration
:
integer
reason
:
string
status
:
string
type
:
string
criticalIncidents
:
-
code
:
string
createTime
:
string
message
:
string
messageTemplateParams
:
object
resource
:
component
:
string
location
:
cluster
:
string
group
:
string
kind
:
string
name
:
string
namespace
:
string
version
:
string
stackTrace
:
-
component
:
string
message
:
string
transientUntil
:
string
lastBackupTime
:
string
nextBackupTime
:
string
observedGeneration
:
integer
phase
:
string
reconciled
:
boolean
recoveryWindow
:
begin
:
string
end
:
string
Field
TypeRequired or optional
Description
conditions
list (object)
Optional
Conditions represent the latest available observations of the Entity's current state.
conditions[].lastTransactionTime
string
Required
The last time the condition transitioned from one status to another. This is when the underlying condition changed. If that is not known, then use the time when the API field changed.
conditions[].message
string
Required
A human readable message indicating details about the transition. This can be an empty string.
conditions[].observedGeneration
integer
Optional
Represents the
.metadata.generation
that the condition was set based upon. For example, if .metadata.generation
is 12
but the .status.conditions[x].observedGeneration
is 9
, the condition is out of date with respect to the current state of the instance.conditions[].reason
string
Required
maximum length: 1024, minimum length: 1 Contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types might define expected values and meanings for this field. The value must be a CamelCase string. This field cannot not be empty.
conditions[].status
string
Required
Status of the condition, one of
True
, False
, Unknown
.conditions[].type
string
Required
Maximum length: 316 Type of condition in CamelCase or in
foo.example.com/CamelCase
.criticalIncidents
list (object)
Required
A flat list of all active Critical Incidents. CriticalIncident contains all information about an ongoing critical incident.
criticalIncidents[].code
string
Required
The error code of this particular error. Error codes are formatted as
DBSE
followed by a number, like DBSE1012
.criticalIncidents[].createTime
string
Required
The timestamp when this Incident is created at the origin.
criticalIncidents[].message
string
Optional
The incident or error that occurred.
criticalIncidents[].messageTemplateParams
object
Optional
Contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the user interface.
criticalIncidents[].resource
object
Required
Contains information about the Database Service component that reported the incident, as well as information about the cluster manager resource.
criticalIncidents[].resource.component
string
Required
An internal identifier of the Database Service subsystem that reported the incident.
criticalIncidents[].resource.location
object
Optional
Location.
criticalIncidents[].resource.location.cluster
string
Optional
The name of the cluster of the affected cluster manager resource.
criticalIncidents[].resource.location.group
string
Optional
The Group name of the cluster manager resource.
criticalIncidents[].resource.location.kind
string
Optional
The Kind of the cluster manager resource.
criticalIncidents[].resource.location.name
string
Optional
The name of the affected cluster manager resource.
criticalIncidents[].resource.location.namespace
string
Optional
The namespace of the affected cluster manager resource.
criticalIncidents[].resource.location.version
string
Optional
The Version of the cluster manager resource.
criticalIncidents[].stackTrace
list (object)
Optional
An unstructured list of messages from the stack trace.
criticalIncidents[].stackTrace.component
string
Optional
The name of a Database Service component that logged the message.
criticalIncidents[].stackTrace.message
string
Optional
Logged message.
criticalIncidents[].transientUntil
string
Optional
If present,
TransientUntil
indicates that the issue must be considered transient until the specified time.lastBackupTime
string
Optional
The timestamp for the most recently executed backup.
nextBackupTime
string
Optional
The timestamp for the next scheduled backup.
observedGeneration
integer
Optional
The generation observed by the controller.
phase
string
Optional
The phase of a BackupPlan.
reconciled
boolean
Optional
Whether the resource was reconciled by the controller.
recoveryWindow
object
Optional
The available recovery window.
recoveryWindow.begin
string
Optional
Begin time.
recoveryWindow.end
string
Optional
End time.
