Resource: BackupPlan
Defines the configuration and scheduling for a "line" of Backups.
JSON representation |
---|
{ "name": string, "uid": string, "createTime": string, "updateTime": string, "description": string, "cluster": string, "retentionPolicy": { object ( |
Fields | |
---|---|
name |
Output only. The full name of the BackupPlan resource. Format: |
uid |
Output only. Server generated global unique identifier of UUID format. |
createTime |
Output only. The timestamp when this BackupPlan resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The timestamp when this BackupPlan resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
description |
User specified descriptive string for this BackupPlan. |
cluster |
Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:
|
retentionPolicy |
RetentionPolicy governs lifecycle of Backups created under this plan. |
labels |
A set of custom labels supplied by user. An object containing a list of |
backupSchedule |
Defines a schedule for automatic Backup creation via this BackupPlan. |
etag |
Output only. |
deactivated |
This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False |
backupConfig |
Defines the configuration of Backups created via this BackupPlan. |
protectedPodCount |
Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. |
state |
Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update |
stateReason |
Output only. Human-readable description of why BackupPlan is in the current |
RetentionPolicy
RetentionPolicy defines a Backup retention policy for a BackupPlan.
JSON representation |
---|
{ "backupDeleteLockDays": integer, "backupRetainDays": integer, "locked": boolean } |
Fields | |
---|---|
backupDeleteLockDays |
Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (createTime + backupDeleteLockDays). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking) |
backupRetainDays |
The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (createTime + backupRetainDays). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backupRetainDays must be >= Default: 0 (no automatic deletion) |
locked |
This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the Default: False |
Schedule
Defines scheduling parameters for automatically creating Backups via this BackupPlan.
JSON representation |
---|
{ "cronSchedule": string, "paused": boolean } |
Fields | |
---|---|
cronSchedule |
A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the Default (empty): no automatic backup creation will occur. |
paused |
This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False |
BackupConfig
BackupConfig defines the configuration of Backups created via this BackupPlan.
JSON representation |
---|
{ "includeVolumeData": boolean, "includeSecrets": boolean, "encryptionKey": { object ( |
Fields | |
---|---|
includeVolumeData |
This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False |
includeSecrets |
This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False |
encryptionKey |
This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted. |
Union field backup_scope . This defines the "scope" of the Backup - which namespaced resources in the cluster will be included in a Backup. Exactly one of the fields of backup_scope MUST be specified. backup_scope can be only one of the following: |
|
allNamespaces |
If True, include all namespaced resources |
selectedNamespaces |
If set, include just the resources in the listed namespaces. |
selectedApplications |
If set, include just the resources referenced by the listed ProtectedApplications. |
State
State
Enums | |
---|---|
STATE_UNSPECIFIED |
Default first value for Enums. |
CLUSTER_PENDING |
Waiting for cluster state to be RUNNING. |
PROVISIONING |
The BackupPlan is in the process of being created. |
READY |
The BackupPlan has successfully been created and is ready for Backups. |
FAILED |
BackupPlan creation has failed. |
DEACTIVATED |
The BackupPlan has been deactivated. |
DELETING |
The BackupPlan is in the process of being deleted. |
Methods |
|
---|---|
|
Creates a new BackupPlan in a given location. |
|
Deletes an existing BackupPlan. |
|
Retrieve the details of a single BackupPlan. |
|
Gets the access control policy for a resource. |
|
Lists BackupPlans in a given location. |
|
Update a BackupPlan. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |