forked from jacksegal/google-compute-snapshot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gcloud-snapshot.sh
executable file
·400 lines (305 loc) · 8.58 KB
/
gcloud-snapshot.sh
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
#!/usr/bin/env bash
export PATH=$PATH:/usr/local/bin/:/usr/bin
###############################
## ##
## INITIATE SCRIPT FUNCTIONS ##
## ##
## FUNCTIONS ARE EXECUTED ##
## AT BOTTOM OF SCRIPT ##
## ##
###############################
#
# DOCUMENTS ARGUMENTS
#
usage() {
echo -e "\nUsage: $0 [-n] [-d <days>] [-t <label_name>] [-i <instance_name>] [-i <instance_zone>]" 1>&2
echo -e "\nOptions:\n"
echo -e " -d Number of days to keep snapshots. Snapshots older than this number deleted."
echo -e " Default if not set: 7 [OPTIONAL]"
echo -e " -t Only back up disks that have this specified label with value set to 'true'."
echo -e " -i Instance name to create backups for. If empty, makes backup for the calling"
echo -e " host."
echo -e " -n Exclude Instance ID from snapshot names. Default format follows:"
echo -e " [device_name]-[instance_id]-[timestamp]"
echo -e " Useful when long instance names are included in the v-disk name."
echo -e " -z Instance zone. If empty, uses the zone of the calling host."
echo -e "\n"
exit 1
}
#
# GETS SCRIPT OPTIONS AND SETS GLOBAL VAR $OLDER_THAN
#
setScriptOptions()
{
while getopts ":d:t:i:nz:" o; do
case "${o}" in
d)
opt_d=${OPTARG}
;;
t)
opt_t=${OPTARG}
;;
i)
opt_i=${OPTARG}
;;
n)
opt_n='TOGGLED'
;;
z)
opt_z=${OPTARG}
;;
*)
usage
;;
esac
done
shift $((OPTIND-1))
if [[ -n $opt_d ]];then
OLDER_THAN=$opt_d
else
OLDER_THAN=7
fi
if [[ -n $opt_t ]];then
LABEL_CLAUSE="AND labels.$opt_t=true"
else
LABEL_CLAUSE=""
fi
if [[ -n $opt_i ]];then
OPT_INSTANCE_NAME=$opt_i
else
OPT_INSTANCE_NAME=""
fi
# Negate this for cleaner code later
if [[ -n $opt_n ]];then
OPT_USE_INSTANCE_ID=false
else
OPT_USE_INSTANCE_ID=true
fi
if [[ -n $opt_z ]];then
OPT_INSTANCE_ZONE=$opt_z
else
OPT_INSTANCE_ZONE=""
fi
}
#
# RETURNS INSTANCE NAME
#
getInstanceName()
{
if [[ -z "$OPT_INSTANCE_NAME" ]];then
# get the name for this vm
local instance_name="$(curl -s "http://metadata.google.internal/computeMetadata/v1/instance/hostname" -H "Metadata-Flavor: Google")"
# strip out the instance name from the fullly qualified domain name the google returns
echo -e "${instance_name%%.*}"
else
echo $OPT_INSTANCE_NAME
fi
}
#
# RETURNS INSTANCE ID
#
getInstanceId()
{
if [[ -z "$OPT_INSTANCE_NAME" ]];then # no typo: only when querying for the calling machine get the real instance ID
echo -e "$(curl -s "http://metadata.google.internal/computeMetadata/v1/instance/id" -H "Metadata-Flavor: Google")"
else
echo $(echo $INSTANCE_NAME | md5sum | cut -d' ' -f1)
fi
}
#
# RETURNS INSTANCE ZONE
#
getInstanceZone()
{
if [[ -z "$OPT_INSTANCE_ZONE" ]];then
local instance_zone="$(curl -s "http://metadata.google.internal/computeMetadata/v1/instance/zone" -H "Metadata-Flavor: Google")"
# strip instance zone out of response
echo -e "${instance_zone##*/}"
else
echo $OPT_INSTANCE_ZONE
fi
}
#
# RETURNS LIST OF DEVICES
#
# input: ${INSTANCE_NAME}
#
getDeviceList()
{
echo -e "$(gcloud compute disks list --filter "users~instances/$1\$ $LABEL_CLAUSE" --format='value(name)')"
}
#
# RETURNS SNAPSHOT NAME
#
createSnapshotName()
{
# google compute snapshot name cannot be longer than 62 characters
local name_max_len=62
if [ $OPT_USE_INSTANCE_ID == true ]; then
# create snapshot name with instance ID ($2) included
local name="gcs-$1-$2-$3"
# Use this later to calculate max length for the snapshot name
local req_chars="gcs--$2-$3"
else
local name="gcs-$1-$3"
local req_chars="gcs--$3"
fi
# check if snapshot name is longer than max length
if [ ${#name} -ge ${name_max_len} ]; then
# work out how many characters that leaves us for the device name
local device_name_len=`expr ${name_max_len} - ${#req_chars}`
# shorten the device name
local device_name=${1:0:device_name_len}
# create new (acceptable) snapshot name
if [ $OPT_USE_INSTANCE_ID == true ]; then
name="gcs-${device_name}-$2-$3" ;
else
name="gcs-${device_name}-$3" ;
fi
fi
echo -e ${name}
}
#
# CREATES SNAPSHOT AND RETURNS OUTPUT
#
# input: ${DEVICE_NAME}, ${SNAPSHOT_NAME}, ${INSTANCE_ZONE}
#
createSnapshot()
{
echo -e "$(gcloud compute disks snapshot $1 --snapshot-names $2 --zone $3)"
}
#
# GETS LIST OF SNAPSHOTS AND SETS GLOBAL ARRAY $SNAPSHOTS
#
# input: ${SNAPSHOT_REGEX}
# example usage: getSnapshots "(gcs-.*${INSTANCE_ID}-.*)"
#
getSnapshots()
{
# create empty array
SNAPSHOTS=()
# get list of snapshots from gcloud for this device
local gcloud_response="$(gcloud compute snapshots list --filter="name~'"$1"'" --uri)"
# loop through and get snapshot name from URI
while read line
do
# grab snapshot name from full URI
snapshot="${line##*/}"
# add snapshot to global array
SNAPSHOTS+=(${snapshot})
done <<< "$(echo -e "$gcloud_response")"
}
#
# RETURNS SNAPSHOT CREATED DATE
#
# input: ${SNAPSHOT_NAME}
#
getSnapshotCreatedDate()
{
local snapshot_datetime="$(gcloud compute snapshots describe $1 | grep "creationTimestamp" | cut -d " " -f 2 | tr -d \')"
# format date
echo -e "$(date -d ${snapshot_datetime%?????} +%Y%m%d)"
# Previous Method of formatting date, which caused issues with older Centos
#echo -e "$(date -d ${snapshot_datetime} +%Y%m%d)"
}
#
# RETURNS DELETION DATE FOR ALL SNAPSHOTS
#
# input: ${OLDER_THAN}
#
getSnapshotDeletionDate()
{
echo -e "$(date -d "-$1 days" +"%Y%m%d")"
}
#
# RETURNS ANSWER FOR WHETHER SNAPSHOT SHOULD BE DELETED
#
# input: ${DELETION_DATE}, ${SNAPSHOT_CREATED_DATE}
#
checkSnapshotDeletion()
{
if [ $1 -ge $2 ]
then
echo -e "1"
else
echo -e "2"
fi
}
#
# DELETES SNAPSHOT
#
# input: ${SNAPSHOT_NAME}
#
deleteSnapshot()
{
echo -e "$(gcloud compute snapshots delete $1 -q)"
}
logTime()
{
local datetime="$(date +"%Y-%m-%d %T")"
echo -e "$datetime: $1"
}
#######################
## ##
## WRAPPER FUNCTIONS ##
## ##
#######################
createSnapshotWrapper()
{
# log time
logTime "Start of createSnapshotWrapper"
# get date time
DATE_TIME="$(date "+%s")"
# get the instance name
INSTANCE_NAME=$(getInstanceName)
# get the device id
INSTANCE_ID=$(getInstanceId)
# get the instance zone
INSTANCE_ZONE=$(getInstanceZone)
# get a list of all the devices
DEVICE_LIST=$(getDeviceList ${INSTANCE_NAME})
# create the snapshots
echo "${DEVICE_LIST}" | while read DEVICE_NAME
do
# create snapshot name
SNAPSHOT_NAME=$(createSnapshotName ${DEVICE_NAME} ${INSTANCE_ID} ${DATE_TIME})
# create the snapshot
OUTPUT_SNAPSHOT_CREATION=$(createSnapshot ${DEVICE_NAME} ${SNAPSHOT_NAME} ${INSTANCE_ZONE})
done
}
deleteSnapshotsWrapper()
{
# log time
logTime "Start of deleteSnapshotsWrapper"
# get the deletion date for snapshots
DELETION_DATE=$(getSnapshotDeletionDate "${OLDER_THAN}")
# get list of snapshots for regex - saved in global array
getSnapshots "gcs-.*${INSTANCE_ID}-.*"
# loop through snapshots
for snapshot in "${SNAPSHOTS[@]}"
do
# get created date for snapshot
SNAPSHOT_CREATED_DATE=$(getSnapshotCreatedDate ${snapshot})
# check if snapshot needs to be deleted
DELETION_CHECK=$(checkSnapshotDeletion ${DELETION_DATE} ${SNAPSHOT_CREATED_DATE})
# delete snapshot
if [ "${DELETION_CHECK}" -eq "1" ]; then
OUTPUT_SNAPSHOT_DELETION=$(deleteSnapshot ${snapshot})
fi
done
}
##########################
## ##
## RUN SCRIPT FUNCTIONS ##
## ##
##########################
# log time
logTime "Start of Script"
# set options from script input / default value
setScriptOptions "$@"
# create snapshot
createSnapshotWrapper
# delete snapshots older than 'x' days
deleteSnapshotsWrapper
# log time
logTime "End of Script"