twiri.js

twiri.js provides tools for building and pushing docker images as well as doing mesos/marathon deployments.

Usage

  Usage
    $ twiri.js [options]
  Options
    --help, -h                  Usage information
    --tag <name>                Tag to use for the image (either during build or push)
    --marathon-template <file>  Template file for marathon deployment
    --build                     Build docker container from current directory
    --push                      Pushes an image to hub.docker.com
    --deploy                    Deploys a docker image to twiri
 
  Examples
    $ twiri.js --build
    $ twiri.js --tag name --marathon-template marathon.json --build --push --deploy

Every entry in a marathon.json template file could be overriden by ENV vars which need to be prefixed by marathon_. For examepl to override the marathon application id set an ENV-var named marathon_id.

Installation

• Prerequisites

  • Install docker for your OS
  • Install node.js

• Install twiri.js

  • Either local npm install twiri.js -D as dependency to your project
  • Or global npm install twiri.js -g

Authentications

For authenticate against docker, run a docker login. twiri.js can consume the default docker credentials file.

For authentication against twiri create a ~/.twiri.json file containing:

{
  "auth": {
    "user": "username",
    "pass": "password"
  }
}

For the twiri credentials you can use your twiri API key. If your are logged into twiri, just click on your username in the upper right corner. Together with your email address and your API key you can log into twiri for automated deployments.

Example marathon.json

{
  "id": "/app/id",
  "instances": 3,
  "cpus": 2,
  "mem": 1024,
  "disk": 256,
  "constraints":[
    [
      "hostname",
      "GROUP_BY"
    ]
  ],
  "container": {
    "type": "DOCKER",
    "docker": {
      "image": "node:6-alpine",
      "forcePullImage": true,
      "network": "BRIDGE"
    }
  },
  "uris":[
    "file:///etc/docker.tar.gz"
  ],
  "upgradeStrategy": {
    "minimumHealthCapacity": 1
  }
}
 

Add available marathon options.

To override data in the template file specify environment variables like in the examples below:

This will override the defined docker container image:

$ marathon_container_docker_image="node:7-alpine" twiri.js --marathon-template marathon.json --deploy

This will override the instances to run:

$ marathon_instances="1" twiri.js --marathon-template marathon.json --deploy