Recently i came across a client who wanted to take weekly snapshots of his DigitalOcean droplet.
Before i used to do everything through the Python module build by Lorenzo Setale ( you should really check out everything this guy ever made ) but then i decided i wanted to give the new 2.0 API a go.
most of the times when i read code nobody cares about the imports. I do, so lets start with that
|
1 2 3 4 5 6 |
from __future__ import print_function import requests import json import time import sys import datetime |
i’m using python 2.7.6 for this so i’m importing the print command implented in python 3.x
also i’m using requests. so so so much easier then urllib.
now for some VARS:
|
1 2 3 4 5 6 |
apikey = "APIKEY"; # Your accout API KEY did = 1234567 # The droplet in question headers = { "Authorization": "Bearer "+ apikey , "Content-Type" : "application/json" } shutdown = False errorlog = "/var/log/snapshot_error.log" today = datetime.date.today() |
I’m setting up the script with the API key giving by DigitalOcean for my account and also specifying the droplet id that i want to take a snapshot from.
The headers of the request will list my api key and the fact the i want my responses in json.
I’m also setting a boolean var named shutdown. you will see why later.
And now to the Main code:
|
1 2 3 4 5 6 7 8 9 |
if __name__ == '__main__': api_post = "https://api.digitalocean.com/v2/droplets/%d/actions" % did; #shutdown r = requests.post(api_post,data=json.dumps({"type" : "power_off"}), headers=headers) Loop(r.json()) shutdown = True #snapshot r = requests.post(api_post,data=json.dumps({"type" : "snapshot"}), headers=headers) Loop(r.json()) |
I start by initializing a URI for my post requests with the droplet id i created before.
Now all i have to do is call the API twice:
1. Shutdown the server.
2. Take the snapshot.
The server will automatically start up when the snapshot is over so no need to post a power up request.
After i finish i’m using requests internal function called ‘json’ to marshal the response and send it to my loop function.
|
1 2 3 4 5 6 7 8 |
def Loop(j): Errors(j) # check for errors in the response while j["action"]["status"] == "in-progress": time.sleep(60) j = Status(j["action"]["id"]) if j["action"]["status"] is "errored": print (today.strftime("[%d, %b %Y] something went wrong during " + j["action"]["type"]) + "\r\n", file=open(errorlog,'w')) PowerUp() |
The loop function gets a json object and sends it to the Errors()function for evaluation.
If for some reason the post action was not commited this function will take care of the errors.
|
1 2 3 4 |
def Errors(j): if "message" in j: print (today.strftime("[%d, %b %Y] ") + j["message"] + "\r\n", file=open(errorlog,'w')) PowerUp() |
next if the action is in progress we’ll start a while loop checking the state of the action in progress.
there are 3 states to consider: in-progress, errored and completed.
If the action is still running ( in-progress ) the script will hold for 1 minute before trying the API again.
the get request for the state of the action is read by the function Status():
|
1 2 3 |
def Status(aid): r = requests.get("https://api.digitalocean.com/v2/droplets/%d/actions/%d" % (did,aid),headers=headers) return r.json() |
if for some reason the state is errored the script will go to the termination function called PowerUp()
|
1 2 3 4 |
def PowerUp(): if shutdown: r = requests.post(api_post,data=json.dumps({"type" : "power_on"}), headers=headers) sys.exit() |
this functions checks if the droplet was shutdown and send the power_on action to wake it up.
in any case the script will quit.
That’s about it! the script is ready to be used with crontab or whatever you feel like!
The full version looks like this:
|
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 |
from __future__ import print_function import requests import json import time import sys import datetime apikey = "APIKEY"; # Your accout API KEY did = 1234567 # The droplet in question headers = { "Authorization": "Bearer "+ apikey , "Content-Type" : "application/json" } shutdown = False errorlog = "/var/log/snapshot_error.log" today = datetime.date.today() def Status(aid): r = requests.get("https://api.digitalocean.com/v2/droplets/%d/actions/%d" % (did,aid),headers=headers) return r.json() def Loop(j): Errors(j) # check for errors in the response while j["action"]["status"] == "in-progress": time.sleep(60) j = Status(j["action"]["id"]) if j["action"]["status"] is "errored": print (today.strftime("[%d, %b %Y] something went wrong during " + j["action"]["type"]) + "\r\n", file=open(errorlog,'w')) PowerUp() def Errors(j): if "message" in j: print (today.strftime("[%d, %b %Y] ") + j["message"] + "\r\n", file=open(errorlog,'w')) PowerUp() def PowerUp(): if shutdown: r = requests.post(api_post,data=json.dumps({"type" : "power_on"}), headers=headers) sys.exit() #MAIN if __name__ == '__main__': api_post = "https://api.digitalocean.com/v2/droplets/%d/actions" % did; #shutdown r = requests.post(api_post,data=json.dumps({"type" : "power_off"}), headers=headers) Loop(r.json()) shutdown = True #snapshot r = requests.post(api_post,data=json.dumps({"type" : "snapshot"}), headers=headers) Loop(r.json()) |