How to automate docker deployment based on GitHub webhook? - node.js

Question

So I have inherited an application, and am not too happy with the current deployment workflow. There is a docker instance running on an ec2 server, and developers have been merging their local work like this:
rsync -arhvz --progress ./ ubuntu#52.12.345.67:/home/ubuntu/app --exclude node_modules
And then going into the server itself and running a deploy.sh script. I would simply like a push event to the master branch to trigger this sync and deploy. How is it possible? As far as I know we don't pay for a Docker hub account - we don’t have private docker registry.

Answer 1

Some solutions :
use a git pre-push hook script which will execute the script before each local push to remote
create a bare git repo on your server, push your change to this git remote and checkout the last change using post-receive hook
track push events on Github with Github webhook, you will need to have your server listen to a port in order to receive the webhook events
pre-push hook
In your local repository, edit/create .git/hooks/pre-push file :
#!/bin/bash
rsync -arhvz --progress ./ ubuntu#52.12.345.67:/home/ubuntu/app --exclude node_modules
ssh ubuntu#52.12.345.67 "/home/ubuntu/deploy.sh"
This way, your modification will sync before each local push to remote. The deploy.sh is also triggered
setup a git repo on your server and deploy to it using git
You can create a bare git repo on your server and create a post-receive hook script that will use git to checkout your server repo. From this guide :
#!/bin/bash
while read oldrev newrev ref
do
# only checking out the master (or whatever branch you would like to deploy)
if [[ $ref =~ .*/master$ ]];
then
echo "Master ref received. Deploying master branch to production..."
git --work-tree=/home/ubuntu/app/deploy-folder/ --git-dir=/home/ubuntu/app/project.git/ checkout -f
else
echo "Ref $ref successfully received. Doing nothing: only the master branch may be deployed on this server."
fi
done
Note that this solution only uses git
Github Webhook
You can use this docker-hook project which is a Python server listening for a POST on your webhook uri. It was originally used for Docker Hub webhook but also works for Github webhook (though not parsing the events).
Webhook
On your server :
download docker-hook python script
curl https://raw.githubusercontent.com/schickling/docker-hook/master/docker-hook > /usr/local/bin/docker-hook; chmod +x /usr/local/bin/docker-hook
start it with a token (generated with uuidgen for example) :
docker-hook -t 3ea4e9d8-8fff-47e5-a704-65ab21de6963 -c /path/to/deploy.sh
In Github, go to your repo settings, create the webhook with the token as path :
Check that the webhook is working (in Recent Deliveries tab)
Deploy key
Now, as you want to trigger a git pull on your server, you will need to generate a Deploy Key which is a ssh key used to deploy (read-only), you will need, on server side :
install git if not already installed
generate a key
copy this key in your repo/settings/Deploy key tab
See this post for a complete tutorial
Now you need to edit your deploy.sh script to perform a git pull or a fresh git clone to the location of your choice