-
Notifications
You must be signed in to change notification settings - Fork 26
/
snapshots_expire.go
196 lines (170 loc) · 6.11 KB
/
snapshots_expire.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
Copyright (C) 2019 The snapscheduler authors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package controllers
import (
"context"
"errors"
"sort"
"time"
snapschedulerv1 "github.com/backube/snapscheduler/api/v1"
"github.com/go-logr/logr"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"sigs.k8s.io/controller-runtime/pkg/client"
)
// expireByCount deletes the oldest snapshots until the number of snapshots for
// a given PVC (created by the supplied schedule) is no more than the
// schedule's maxCount. This function is the entry point for count-based
// expiration of snapshots.
func expireByCount(schedule *snapschedulerv1.SnapshotSchedule,
logger logr.Logger, c client.Client) error {
if schedule.Spec.Retention.MaxCount == nil {
// No count-based retention configured
return nil
}
snapList, err := snapshotsFromSchedule(schedule, logger, c)
if err != nil {
logger.Error(err, "unable to retrieve list of snapshots")
return err
}
grouped := groupSnapsByPVC(snapList)
for _, list := range grouped {
list = sortSnapsByTime(list)
if len(list) > int(*schedule.Spec.Retention.MaxCount) {
list = list[:len(list)-int(*schedule.Spec.Retention.MaxCount)]
err := deleteSnapshots(list, logger, c)
if err != nil {
return err
}
}
}
return nil
}
// expireByTime deletes snapshots that are older than the retention time in the
// specified schedule. It only affects snapshots that were created by the provided schedule.
// This function is the entry point for the time-based expiration of snapshots
func expireByTime(schedule *snapschedulerv1.SnapshotSchedule,
logger logr.Logger, c client.Client) error {
expiration, err := getExpirationTime(schedule, time.Now(), logger)
if err != nil {
logger.Error(err, "unable to determine snapshot expiration time")
return err
}
if expiration == nil {
// No time-based retention configured
return nil
}
snapList, err := snapshotsFromSchedule(schedule, logger, c)
if err != nil {
logger.Error(err, "unable to retrieve list of snapshots")
return err
}
expiredSnaps := filterExpiredSnaps(snapList, *expiration)
logger.Info("deleting expired snapshots", "expiration", expiration.Format(time.RFC3339),
"total", len(snapList), "expired", len(expiredSnaps))
err = deleteSnapshots(expiredSnaps, logger, c)
return err
}
func deleteSnapshots(snapshots []MultiversionSnapshot, logger logr.Logger, c client.Client) error {
for _, snap := range snapshots {
err := snap.Delete(context.TODO(), c, client.PropagationPolicy(metav1.DeletePropagationBackground))
if err != nil {
logger.Error(err, "error deleting snapshot", "name", snap.ObjectMeta().Name)
return err
}
}
return nil
}
// getExpirationTime returns the cutoff Time for snapshots created with the
// referenced schedule. Any snapshot created prior to the returned time should
// be considered expired.
func getExpirationTime(schedule *snapschedulerv1.SnapshotSchedule,
now time.Time, logger logr.Logger) (*time.Time, error) {
if schedule.Spec.Retention.Expires == "" {
// No time-based retention configured
return nil, nil
}
lifetime, err := time.ParseDuration(schedule.Spec.Retention.Expires)
if err != nil {
logger.Error(err, "unable to parse spec.retention.expires")
return nil, err
}
if lifetime < 0 {
err := errors.New("duration must be greater than 0")
logger.Error(err, "invalid value for spec.retention.expires")
return nil, err
}
expiration := now.Add(-lifetime).UTC()
return &expiration, nil
}
// filterExpiredSnaps returns the set of expired snapshots from the provided list.
func filterExpiredSnaps(snaps []MultiversionSnapshot,
expiration time.Time) []MultiversionSnapshot {
outList := make([]MultiversionSnapshot, 0)
for _, snap := range snaps {
if snap.ObjectMeta().CreationTimestamp.Time.Before(expiration) {
outList = append(outList, snap)
}
}
return outList
}
// snapshotsFromSchedule returns a list of snapshots that were created by the
// supplied schedule
func snapshotsFromSchedule(schedule *snapschedulerv1.SnapshotSchedule,
logger logr.Logger, c client.Client) ([]MultiversionSnapshot, error) {
labelSelector := &metav1.LabelSelector{
MatchLabels: map[string]string{
ScheduleKey: schedule.Name,
},
}
selector, err := metav1.LabelSelectorAsSelector(labelSelector)
if err != nil {
logger.Error(err, "unable to create label selector for snapshot expiration")
return nil, err
}
listOpts := []client.ListOption{
client.InNamespace(schedule.Namespace),
client.MatchingLabelsSelector{
Selector: selector,
},
}
snapList, err := ListMVSnapshot(context.TODO(), c, listOpts...)
if err != nil {
logger.Error(err, "unable to retrieve list of snapshots")
return nil, err
}
return snapList, nil
}
// groupSnapsByPVC takes a list of snapshots and groups them by the PVC they
// were created from
func groupSnapsByPVC(snaps []MultiversionSnapshot) map[string][]MultiversionSnapshot {
groupedSnaps := make(map[string][]MultiversionSnapshot)
for _, snap := range snaps {
pvcName := snap.SourcePvcName()
if pvcName != nil {
if groupedSnaps[*pvcName] == nil {
groupedSnaps[*pvcName] = []MultiversionSnapshot{}
}
groupedSnaps[*pvcName] = append(groupedSnaps[*pvcName], snap)
}
}
return groupedSnaps
}
// sortSnapsByTime sorts the snapshots in order of ascending CreationTimestamp
func sortSnapsByTime(snaps []MultiversionSnapshot) []MultiversionSnapshot {
sorted := append([]MultiversionSnapshot(nil), snaps...)
sort.Slice(sorted, func(i, j int) bool {
return sorted[i].ObjectMeta().CreationTimestamp.Before(&sorted[j].ObjectMeta().CreationTimestamp)
})
return sorted
}