[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/jacksegal/google-compute-snapshot/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","jacksegal","reponame","google-compute-snapshot","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2019-01-05T14:22:53.364428Z","description","Automatically snapshot all Google Compute Engine disks in a Google cloud project","is_private","last_updated","2019-07-06T20:41:28.575623Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",1146,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Automatic Snapshots for Google (gcloud) Compute Engine\n\nBash script for Automatic Snapshots and Cleanup on Google Compute Engine. \n\n**Requires no user input!**\n\n_Inspiration (and the installation instructions) taken from AWS script [aws-ec2-ebs-automatic-snapshot-bash](https://github.com/CaseyLabs/aws-ec2-ebs-automatic-snapshot-bash)_\n\n## How it works\ngcloud-snapshot.sh will:\n\n- Determine the Instance ID of the Google Compute Engine server on which the script runs\n- Get all the Disk IDs attached to that instance\n- Take a snapshot of each Disk\n- The script will then delete all associated snapshots taken by the script for the Instance that are older than 7 days \n\nThe script has a number of **optional** usage options - for example you can:\n\n- Retain snapshots for as long as you'd like [(-d)](#snapshot-retention)\n- Backup remote instances too [(-r)](#backing-up-remote-instances)\n- Only backup certain disks [(-f)](#matching-on-specific-disks)\n\n## Prerequisites\n* `cURL` must be installed\n* The VM must have the sufficient gcloud permissions, including \"compute\" set to \"enabled\": [\thttp://stackoverflow.com/questions/31905966/gcloud-compute-list-networks-error-some-requests-did-not-succeed-insufficie#31928399](http://stackoverflow.com/questions/31905966/gcloud-compute-list-networks-error-some-requests-did-not-succeed-insufficie#31928399)\n* The version of gcloud is up to date: `gcloud components update` \n\n\n## Installation\n\nssh on to the server you wish to have backed up\n\n**Install Script**: Download the latest version of the snapshot script and make it executable:\n```\ncd ~\nwget https://raw.githubusercontent.com/jacksegal/google-compute-snapshot/master/gcloud-snapshot.sh\nchmod +x gcloud-snapshot.sh\nsudo mkdir -p /opt/google-compute-snapshot\nsudo mv gcloud-snapshot.sh /opt/google-compute-snapshot/\nsudo gcloud auth login\n```\n\n**To manually test the script:**\n```\nsudo /opt/google-compute-snapshot/gcloud-snapshot.sh\n```\n\n## Automation\n\n**Setup CRON**: You should setup a cron job in order to schedule a daily backup. Example cron for Debian based Linux:\n\n- Edit the system crontab:\n```\nsudo nano /etc/crontab\n```\n\n- Add the following line:\n```\n0 5 * * * root /opt/google-compute-snapshot/gcloud-snapshot.sh > /dev/null 2>&1\n```\n\n- Reload cron:\n`sudo service cron reload`\n\nIf you'd like to save the output of the script to a log, see [Saving output to Log](#saving-output-to-log)\n\n## Usage Options\n\n```\nUsage:\n\n./gcloud-snapshot.sh [-d ] [-r ] [-f ] [-p ] [-a ] [-n ]\n\nOptions:\n\n -d Number of days to keep snapshots. Snapshots older than this number deleted.\n Default if not set: 7 [OPTIONAL]\n -r Backup remote instances - takes snapshots of all disks calling instance has\n access to [OPTIONAL].\n -f gcloud filter expression to query disk selection [OPTIONAL]\n -g Guest Flush (VSS only for Windows VMs) [OPTIONAL]\n -c Copy disk labels to snapshot labels [OPTIONAL]\n -p Prefix to be used for naming snapshots.\n Max character length: 20\n Default if not set: 'gcs' [OPTIONAL]\n -a Service Account to use. \n Blank if not set [OPTIONAL]\n -j Project ID to use.\n Blank if not set [OPTIONAL]\n -l Snapshot storage location.\n Uses default storage location if not set [OPTIONAL]\n -n Dry run: causes script to print debug variables and doesn't execute any\n create / delete commands [OPTIONAL]\n```\n\n## Docker Support\n\nThis project has a `Dockerfile` and can therefore be run as a container in a VM, or in a Kubernetes cluster.\nIn this context, it will be run with the `-r` option to back up all disks the container has access to. The\nintended usage is to run the container periodically as a Kubernetes cron task.\n\nHowever it is also possible to set the environment variables `DAEMON` which will make the container run\ncontinually and take snapshots at intervals. By default the interval is 21600 seconds (6 hours) but can\nbe overridden by setting the environment variable `SLEEP`.\n\nYou set environment variable `FILTER` to set a filter condition as documented in\n[Matching on specific disks](#matching-on-specific-disks). Otherwise all disks are snapshotted.\n\nAt the time of writing, this image is available on [Docker Hub](https://hub.docker.com/r/jacksegal/google-compute-snapshot/)\nas `jacksegal/google-compute-snapshot`.\n\n## Usage Examples\n\n### Snapshot Retention\nBy default snapshots will be kept for 7 days, however they can be kept for longer / shorter, by using the the -d flag:\n\n Usage: ./snapshot.sh [-d ]\n \n Options:\n \n -d Number of days to keep snapshots. Snapshots older than this number deleted.\n Default if not set: 7 [OPTIONAL]\n\nFor example if you wanted to keep your snapshots for a year, you could run:\n\n ./gcloud-snapshot.sh -d 365\n\n### Backing up Remote Instances\nBy default the script will only backup disks attached to the calling Instance, however you can backup all remote disks that the instance has access to, by using the -r flag:\n\n Usage: ./snapshot.sh [-r ]\n \n Options:\n \n -r Backup remote instances - takes snapshots of all disks calling instance has\n access to [OPTIONAL].\n\nFor example:\n\n ./gcloud-snapshot.sh -r\n\n### Matching on specific disks\nBy default snapshots will be created for all attached disks. To only snapshot specific disks, pass in [gcloud filter expressions](https://cloud.google.com/sdk/gcloud/reference/topic/filters) using the -f flag:\n\n Usage: ./gcloud-snapshot.sh [-f ]\n \n Options:\n \n -f gcloud filter expression to query disk selection\n\nUsing Labels: You could add a label of `auto_snapshot=true` to all disks that you wanted backed up and then run:\n\n ./gcloud-compute-snapshot.sh -f \"labels.auto_snapshot=true\"\n\nBackup specific zone: If you wanted to only backup disks in a specific zone you could run:\n\n ./gcloud-compute-snapshot.sh -f \"zone: us-central1-c\"\n\n### Guest Flush (VSS for Windows)\nGoogle supports Guest Flush (Volume Shadow Copy quiesce) for Windows Instances's. See [Googles Documentation](https://cloud.google.com/compute/docs/instances/windows/creating-windows-persistent-disk-snapshot#create-snapshot) for limitations. It's recommended that it's only used for secondary data disks, and not for boot volumes.\n\nIt will only work with a Windows Instance, and will not work with Linux instances. If you attempt it on an instance that doesn't support guest flush, the snapshot WILL fail.\n\n Usage: ./gcloud-snapshot.sh [-g]\n\n Options:\n\n -g Guest Flush (VSS only for Windows VMs) [OPTIONAL]\n\n\n### Copy Disk Labels to Snapshots\nDisks can have labels, but snapshots don't automatically get the same labels. To copy labels from source disk to the snapshots use the -c flag. This can be useful if you wish to filter snapshots based on the original disks labels:\n\n Usage: ./gcloud-snapshot.sh [-c]\n\n Options:\n\n -c Copy disk labels to snapshot labels [OPTIONAL]\n\n### Snapshot prefix\nBy default snapshots are created with a prefix of `gcs`. To give a custom prefix use the -p flag:\n\n Usage: ./gcloud-snapshot.sh [-p ]\n \n Options:\n \n -p Prefix to be used for naming snapshots.\n Max character length: 20\n Default if not set: 'gcs' [OPTIONAL]\n\nFor example:\n\n ./gcloud-snapshot.sh -p \"my-snap\"\n\n (Note: Snapshot prefixes are limited to 20 characters)\n\n### Service Account\nBy default snapshots are created with the default gcloud service account. To use a custom service account use the -a flag:\n\n Usage: ./gcloud-snapshot.sh [-a ]\n \n Options:\n \n -a Service Account to use.\n Blank if not set [OPTIONAL]\n\nFor example:\n\n ./gcloud-snapshot.sh -a \"my-service-account@test9q.iam.gserviceaccount.com\"\n\n### Project ID\nBy default snapshots are created with the default gcloud project id. To use a custom project id use the -j flag:\n\n Usage: ./gcloud-snapshot.sh [-j ]\n \n Options:\n \n -j Project ID to use.\n Blank if not set [OPTIONAL]\n\nFor example:\n\n ./gcloud-snapshot.sh -j \"my-test-project\"\n\n### Snapshot Storage Location\nThe storage location for your snapshots (regional/multi-regional). If you do not specify a storage location, your snapshot is stored in the multi-region that is geographically closest to the location of your persistent disk. (https://cloud.google.com/compute/docs/disks/create-snapshots#default_location) This may incur network costs\nTo use a custom storage location use the -l flag:\n\n Usage: ./gcloud-snapshot.sh [-l ]\n\n Options:\n\n -l Snapshot storage location.\n Uses default storage location if not set [OPTIONAL]\n\n For example:\n\n ./gcloud-snapshot.sh -l \"asia-east1\"\n\n### Dry Run\nThe script can be run in dry run mode, which doesn't execute any create / delete commands, and prints out debug information.\n\n Usage: ./gcloud-snapshot.sh [-n ]\n \n Options:\n \n -n Dry run: causes script to print debug variables and doesn't execute any\n create / delete commands [OPTIONAL]\n\nFor example if you wanted to a test a gcloud filter expression against remote instances:\n\n ./gcloud-snapshot.sh -n -r -f \"labels.auto_snapshot=true\"\n\nIt would output something like:\n\n [2018-11-13 21:04:27]: Start of google-compute-snapshot\n [DEBUG]: OLDER_THAN=7\n [DEBUG]: REMOTE_CLAUSE=true\n [DEBUG]: PREFIX=gcs\n [DEBUG]: OPT_ACCOUNT=\n [DEBUG]: DRY_RUN=true\n [DEBUG]: DELETION_DATE=20181111\n [DEBUG]: INSTANCE_NAME=\n [2018-11-13 21:04:28]: Handling Snapshots for disk-1\n [DEBUG]: gcloud compute disks snapshot disk-1 --snapshot-names gcs-disk-1-1542143067 --zone us-central1-c\n [2018-11-13 21:04:29]: Handling Snapshots for instance-1\n [DEBUG]: gcloud compute disks snapshot instance-1 --snapshot-names gcs-instance-1-1542143067 --zone us-central1-c\n [2018-11-13 21:04:29]: End of google-compute-snapshot\n\n## Saving output to Log\n\nYou can easily store the output from this command in a separate CRON log. Example cron for Debian based Linux:\n```\n0 5 * * * root /opt/google-compute-snapshot/gcloud-snapshot.sh >> /var/log/cron/snapshot.log 2>&1\n```\n\nThe above command sends the output to a log file: `/var/log/cron/snapshot.log` - instructions for creating & managing the log file are below.\n\n**Manage CRON Output**: You should then create a directory for all cron outputs and add it to logrotate:\n\n- Create the folder, log file, and update the permissions:\n``` \nsudo mkdir /var/log/cron \nsudo touch /var/log/cron/snapshot.log\nsudo chgrp adm /var/log/cron/snapshot.log\nsudo chmod 664 /var/log/cron/snapshot.log\n```\n- Create new entry in logrotate so cron files don't get too big :\n```\nsudo nano /etc/logrotate.d/cron\n```\n- Add the following text to the above file:\n```\n/var/log/cron/*.log {\n daily\n missingok\n rotate 14\n compress\n notifempty\n create 664 root adm\n sharedscripts\n}\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2018 Jack Segal\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",5561775104,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",5027096,"full_size",730920743,"id",43558289,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:ebd4f1dc006fd9a218ad055e173f4ac6dc11a20766e134fd48b4f2d06141154d","features","","last_pulled","2026-10-15T05:00:03.900942851Z","last_pushed","2019-07-06T20:41:29Z","os","linux","os_features","os_version","size","variant","2019-07-06T20:41:28.230873Z","last_updater","last_updater_username","media_type","latest","repository",6508932,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

jacksegal/google-compute-snapshot

Tags for jacksegal/google-compute-snapshot