Name: dreadnot
Owner: racker
Description: deploy without dread
Created: 2011-12-08 01:03:44.0
Updated: 2018-03-24 06:38:32.0
Pushed: 2018-03-07 13:52:54.0
Size: 4815
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Dreadnot is a 'one click' deploy tool written in Node.js.
Dreadnot was heavily inspired by Etsy's Deployinator.
Dreadnot loads its configuration from a javascript file:
rts.config = {
The name of this Dreadnot instance, used for display
me: 'Example Dreadnot',
Each Dreadnot instance supports one environment such as 'dev', 'staging'
or 'production'
v: 'staging',
The data root Dreadnot will use
ta_root: '/var/dreadnot',
Base URL to access dreadnot (used in IRC, email, Hipchat)
fault_url: 'http://example.com',
Dreadnot uses an htpasswd file (with support for bcrypt, md5 and sha1) for auth
passwd_file: '/etc/dreadnot/htpasswd',
Each stack represents a code base that should be deployed to one or more regions
acks: {
// For a stack named 'webapp', there should be a 'webapp.js' file in the
// stacks directory
webapp: {
// What branch to look in for the latest revision of the code base
tip: 'master',
// How long to cache the latest revision of the code base
tip_ttl: 120 * 1000,
// What regions this stack should be deployed to
regions: ['ord1'],
// Stacks should implement dryrun for testing
dryrun: true
}
The GitHub organization you provide is used to build URLs for your stacks
thub: {
organization: 'racker'
Plugins provide optional functionality such as notifications. Any plugins
that are not configured won't be used.
ugins: {
// An IRC notification plugin
irc: {
nick: 'staging-dreadnot',
channels: {'irc.freenode.net': ['#public-channel', '#private-channel pass']}
},
// An email notification plugin
email: {
server: {
user: 'staging-dreadnot@example.com',
password: '',
host: 'smtp.example.com',
ssl: true
},
to: 'systems@example.com',
from: 'staging-dreadnot@example.com'
},
// A Hipchat notification plugin
hipchat: {
name: 'Dreadnot',
apiKey: '123456789abcdefg',
rooms: [
1234,
5678
]
}
Dreadnot looks in a directory (by default ./stacks
, but this can be changed
from the command line) for “stack files”. A stack file is simply a javascript
file that exports
get_deployedRevision
function which takes an object containing
environment
and region
fields, and a callback taking (err,
deployed_revision)
.targets
hash that maps target names to lists of task names. Currently,
the only supported targets are deploy
, which defaults to
['task_preDeploy', 'task_deploy', 'task_postDeploy']
, and finally
which
does not have a default value. You should use the finally
target if there are
any tasks you would like to run every time, regardless of the success or failure
of the tasks in deploy
(i.e. re-enable monitoring alerts). The tasks in the finally
target itself are each dependent on the success of the last task in the target, so
an error in one will prevent the rest from running.task_
. Each
task function takes:stackConfig
which contains the config for this particular stack, and config
which
contains the global config.log
field
with methods such as debug
, info
, and error
that can be used to
log output to deployment log and web view.dryrun
, environment
, region
, revision
and
user
, each of which is a string.In the configuration used by Rackspace Cloud Monitoring, a deployment looks something like:
Imporantly, Dreadnot knows nothing about the hosts to which it is deploying - if it did, we would have to modify our Dreadnot configuration every time we added or removed a machine from our environment. Instead, we rely on chef (although anything that knows about your servers will work) to give us an up-to-date list of all hosts in a given region. In smaller deployments it might be suitable to hardcode a list of hosts.
Does Dreadnot support SVN?
Dreadnot supports Node.js - you can use any technology or topology that suits you, as long as you can find a library for it.
To create a development environment, you'll need Vagrant and Virtualbox. Once installed, run:
vagrant up
Then visit http://localhost:8000
Log into the VM by running and running common commands:
vagrant ssh
sudo cat /var/log/upstart/dreadnot.log
npm install dreadnot -g
Alternatively, when developing, you can find a compiled dreadnot binary in the bin folder.
Dreadnot takes a number of options on the command line. The defaults are:
eadnot -c ./local_settings.js -s ./stacks -p 8000
This will start dreadnot with the specified config file and stack directories, listening on port 8000.