Go Shell HCL
Clone or download

README.md

Dropship wercker status Download Join the chat at https://gitter.im/ChrisMcKenzie/dropship

Dropship is a simple tool for installing and updating artifacts from a CDN.

Features

  • Automatically performs md5sum checks of artifact that is on server and remote and will download automatically
  • Distributed sequential updates
  • Multiple Artifact Repository Support

Installation

To install on ubuntu do the following:

echo "deb http://dl.bintray.com/chrismckenzie/deb trusty main" >> /etc/apt/sources.list
sudo apt-get update
sudo apt-get install dropship

Configuration

To setup dropship you will need to add/update the following files.

First you will need to tell dropship how to connect to your artifact repository so you will need to uncomment out the desired repo and fill in its options.

/etc/dropship.d/dropship.hcl

# vim: set ft=hcl :
# Location that service config will be read from
service_path = "/etc/dropship.d/services"

# Rackspace Repo Config
# =====================
repo "rackspace" {
  user = "<your-rackspace-user>"
  key = "<your-rackspace-key>"
  region = "<rackspace-region>"
}

repo "s3" {
  accessKey = "<your-s3-key>"
  secret = "<your-s3-secret>"
  name = "us-west-1"
  endpoint = "https://s3-us-west-1.amazonaws.com"
}

You will then have to create a file in the services directory of dropship. this will tell dropship how to check and install you artifact. You can have multiple service definitions in one file or multiple files.

/etc/dropship.d/services/my-service.hcl

# vim: set ft=hcl :
service "my-service" {
  # Use a semaphore to update one machine at a time
  sequentialUpdates = true

  # Check for updates every 10s
  checkInterval = "10s"

  # Run this command before update starts
  before "script" {
    command = "initctl my-service stop"
  }

  # Artifact defines what repository to use (rackspace) and where 
  # your artifact live on that repository
  artifact "rackspace" {
    bucket = "my-container"
    path = "my-service.tar.gz"
    destination = "./test/dest"
  }

  # After successful update send an event to graphite
  # this allows you to show deploy annotations in tools like grafana
  # 
  # The graphite hook will automatically add this services name into the 
  # graphite tags. You also have access to all of the services meta data
  # like Name, "current hash", hostname.
  after "graphite-event" {
    host = "http://<my-graphite-server>"
    tags = "deployment"
    what = "deployed to {{.Name}} on {{.Hostname}}"
    data = "{{.Hash}}"
  }

  # Run this command after the update finishes
  after "script" {
    command = "initctl my-service start"
  }
}

Building

  • install go 1.5.1
  • clone repo
  • run go get ./...
  • run go build -o dropship main.go

Roadmap

  • Hooks
  • Support for Amazon S3
  • Support for different file types docker (currently only tar.gz, and simple files)
  • Reporting system
  • Redis, etcd for semaphore