Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: supports incremental backup config in cluster CR #8788

Merged
merged 7 commits into from
Jan 10, 2025
Merged

fix: supports incremental backup config in cluster CR #8788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c01598e
fix: supports incremental backup config in cluster CR
gnolong Jan 10, 2025
5422da0
Merge branch 'main' of github.com:apecloud/kubeblocks into support/sp…
gnolong Jan 10, 2025
4cb1c6e
fix
gnolong Jan 10, 2025
0a1cd5f
fix doc
gnolong Jan 10, 2025
b8c2d88
fix typo
gnolong Jan 10, 2025
f41ce49
fix api
gnolong Jan 10, 2025
5cadf0d
fix lint
gnolong Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions apis/apps/v1/cluster_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,6 +679,17 @@ type ClusterBackup struct {
// +kubebuilder:default=false
// +optional
PITREnabled *bool `json:"pitrEnabled,omitempty"`

// Specifies whether to enable incremental backup.
//
// +kubebuilder:default=false
// +optional
IncrementalBackupEnabled *bool `json:"incrementalBackupEnabled,omitempty"`

// The cron expression for the incremental backup schedule. The timezone is in UTC. See https://en.wikipedia.org/wiki/Cron.
//
// +optional
IncrementalCronExpression string `json:"incrementalCronExpression,omitempty"`
}

// ClusterPhase defines the phase of the Cluster within the .status.phase field.
Expand Down
5 changes: 5 additions & 0 deletions apis/apps/v1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions apis/apps/v1alpha1/cluster_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,17 @@ type ClusterBackup struct {
// +kubebuilder:default=false
// +optional
PITREnabled *bool `json:"pitrEnabled,omitempty"`

// Specifies whether to enable incremental backup.
//
// +kubebuilder:default=false
// +optional
IncrementalBackupEnabled *bool `json:"incrementalBackupEnabled,omitempty"`

// The cron expression for the incremental backup schedule. The timezone is in UTC. See https://en.wikipedia.org/wiki/Cron.
//
// +optional
IncrementalCronExpression string `json:"incrementalCronExpression,omitempty"`
}

// ClusterResources is deprecated since v0.9.
Expand Down
5 changes: 5 additions & 0 deletions apis/apps/v1alpha1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions config/crd/bases/apps.kubeblocks.io_clusters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ spec:
description: Specifies whether automated backup is enabled for
the Cluster.
type: boolean
incrementalBackupEnabled:
default: false
description: Specifies whether to enable incremental backup.
type: boolean
incrementalCronExpression:
description: The cron expression for the incremental backup schedule.
The timezone is in UTC. See https://en.wikipedia.org/wiki/Cron.
type: string
method:
description: Specifies the backup method to use, as defined in
backupPolicy.
Expand Down Expand Up @@ -16377,6 +16385,14 @@ spec:
description: Specifies whether automated backup is enabled for
the Cluster.
type: boolean
incrementalBackupEnabled:
default: false
description: Specifies whether to enable incremental backup.
type: boolean
incrementalCronExpression:
description: The cron expression for the incremental backup schedule.
The timezone is in UTC. See https://en.wikipedia.org/wiki/Cron.
type: string
method:
description: Specifies the backup method to use, as defined in
backupPolicy.
Expand Down
11 changes: 11 additions & 0 deletions controllers/apps/cluster/transformer_cluster_backup_policy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,6 +597,7 @@ func (r *backupPolicyBuilder) mergeClusterBackup(
// disable A and enable B.
exist := false
hasSyncPITRMethod := false
hasSyncIncMethod := false
enableAutoBackup := boolptr.IsSetToTrue(backup.Enabled)
for i, s := range backupSchedule.Spec.Schedules {
if s.BackupMethod == backup.Method {
Expand Down Expand Up @@ -630,6 +631,16 @@ func (r *backupPolicyBuilder) mergeClusterBackup(
}
hasSyncPITRMethod = true
}
if as.Spec.BackupType == dpv1alpha1.BackupTypeIncremental && backup.IncrementalBackupEnabled != nil &&
!hasSyncIncMethod && len(backup.Method) > 0 && m.CompatibleMethod == backup.Method {
// auto-sync the first compatible incremental backup for the 'incrementalBackupEnabled' option.
mergeSchedulePolicy(&dpv1alpha1.SchedulePolicy{
Enabled: backup.IncrementalBackupEnabled,
RetentionPeriod: backup.RetentionPeriod,
CronExpression: backup.IncrementalCronExpression,
}, &backupSchedule.Spec.Schedules[i])
hasSyncIncMethod = true
}
if as.Spec.BackupType == dpv1alpha1.BackupTypeFull && enableAutoBackup {
// disable the automatic backup for other full backup method
backupSchedule.Spec.Schedules[i].Enabled = boolptr.False()
Expand Down
16 changes: 16 additions & 0 deletions deploy/helm/crds/apps.kubeblocks.io_clusters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ spec:
description: Specifies whether automated backup is enabled for
the Cluster.
type: boolean
incrementalBackupEnabled:
default: false
description: Specifies whether to enable incremental backup.
type: boolean
incrementalCronExpression:
description: The cron expression for the incremental backup schedule.
The timezone is in UTC. See https://en.wikipedia.org/wiki/Cron.
type: string
method:
description: Specifies the backup method to use, as defined in
backupPolicy.
Expand Down Expand Up @@ -16377,6 +16385,14 @@ spec:
description: Specifies whether automated backup is enabled for
the Cluster.
type: boolean
incrementalBackupEnabled:
default: false
description: Specifies whether to enable incremental backup.
type: boolean
incrementalCronExpression:
description: The cron expression for the incremental backup schedule.
The timezone is in UTC. See https://en.wikipedia.org/wiki/Cron.
type: string
method:
description: Specifies the backup method to use, as defined in
backupPolicy.
Expand Down
48 changes: 48 additions & 0 deletions docs/developer_docs/api-reference/cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2533,6 +2533,30 @@ bool
<p>Specifies whether to enable point-in-time recovery.</p>
</td>
</tr>
<tr>
<td>
<code>incrementalBackupEnabled</code><br/>
<em>
bool
</em>
</td>
<td>
<em>(Optional)</em>
<p>Specifies whether to enable incremental backup.</p>
</td>
</tr>
<tr>
<td>
<code>incrementalCronExpression</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>The cron expression for the incremental backup schedule. The timezone is in UTC. See <a href="https://en.wikipedia.org/wiki/Cron">https://en.wikipedia.org/wiki/Cron</a>.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="apps.kubeblocks.io/v1.ClusterComponentConfig">ClusterComponentConfig
Expand Down Expand Up @@ -14954,6 +14978,30 @@ bool
<p>Specifies whether to enable point-in-time recovery.</p>
</td>
</tr>
<tr>
<td>
<code>incrementalBackupEnabled</code><br/>
<em>
bool
</em>
</td>
<td>
<em>(Optional)</em>
<p>Specifies whether to enable incremental backup.</p>
</td>
</tr>
<tr>
<td>
<code>incrementalCronExpression</code><br/>
<em>
string
</em>
</td>
<td>
<em>(Optional)</em>
<p>The cron expression for the incremental backup schedule. The timezone is in UTC. See <a href="https://en.wikipedia.org/wiki/Cron">https://en.wikipedia.org/wiki/Cron</a>.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="apps.kubeblocks.io/v1alpha1.ClusterComponentConfig">ClusterComponentConfig
Expand Down
Loading