more docs == more planning kinda.

This commit is contained in:
Dan Ballard 2015-03-25 20:48:19 -07:00
parent 2b2e41d474
commit 373ddf66b9
1 changed files with 38 additions and 2 deletions

View File

@ -3,10 +3,46 @@ warren
Build, Deploy and Multiversion Run tool Build, Deploy and Multiversion Run tool
## Install Install
-------
```
go get github.com/dballard/warren/ go get github.com/dballard/warren/
cd $GOPATH/src/github.com/dballard/warren/ cd $GOPATH/src/github.com/dballard/warren/
make make
sudo make install sudo make install
```
Usage
-----
### Build
**`warren build`**
Build the current go package. Pretty much `go build` but with additional defines:
> * BuildGitBranch - from git
> * BuildGitHash - from git
> * BuildDate - from system time
### Deploy
**`waren deploy`**
Deploy the current package to ./deploy, which is registered with warrend. By default, assumed $DIRNAME is the name of the go pacakge and just deploys that binary to a subdirctory named after the date and githash
An optional warren.yaml manifest can be supplied to indicate additional files to be included in the deploy
### Running
**`warrend`** is the main tool that runs registered go services, but is managed via the `warren` command.
`warrend` stores registered deployment information in /etc/warrend.json. Don't edit it directly, use the command line interface.
`warrend` stores deployment specific config in the deployment's directory in warrend.json
* `warren list` lists registered deployments (directory, name)
* `warren reg [name] [directory]` registers a warren deployment directory with warrend for running
* `warren unreg [name]` unregisters a warren deployment
* `warren pool [name] [low high]` with no argument, displays the port range for a deployment, With arguments, sets the low and high and range of the pool. The first 2 ports of the pool are reserved for **stable** and **tail**
* `warren peg [name] [stable] [hash]`