docker-armada 2.0.53

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bc76cc4632cb663329bafd287254200a8c8cf44
+  data.tar.gz: 8858416bd0e9bf2fbac8fb54f564b586c45d3ba5
+SHA512:
+  metadata.gz: c0d905bc4873c50aa9678e31995a8895a17aefea9ae45466ebd3927e19e55a047282afbb584180a4e9eff44dea84241a9d655fd58ce1bb64e6316c8736fe41b0
+  data.tar.gz: 68b4fec515215b7656d4e7aaeb320a13fa7ad601b0b4e34703248201c0dd4f826425117e80aa3688f4688eb1490d6bcc6cc687baedd0e2cd5a531927006281f6

data/.gitignore

@@ -0,0 +1,12 @@
+.bundle
+.config
+coverage/
+*.gem
+pkg/
+*.rbc
+*.swp
+*.swo
+tmp/
+.DS_Store
+VERSION
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'geminabox'
+gem 'rspec_junit_formatter', group: "test"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Rally Software Development Corp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,293 @@
+[![TravisCI](https://travis-ci.org/RallySoftware/armada.svg)](https://travis-ci.org/RallySoftware/armada)
+
+
+## Description
+
+Armada is a docker deployment tool which we originally forked from the [NewRelic Centurion](https://github.com/newrelic/centurion) project. It has since seen a huge refactor occur where we started using the [swipely/docker-api](https://github.com/swipely/docker-api) gem for interacting with our docker hosts instead of the mix of docker-cli and api calls that Centurion makes. The DSL is largely unchanged as it works really well for our intended purposes.
+
+## Disclaimer
+This gem is used in production for deployments at Rally Software. We like the structure it gives us and the simplicity of the DSL. If you feel that we are missing something please open an issue and let's have a discussion about it. If you find a bug please submit an issue and if possible a reproducible test case. 
+
+## Installation
+
+```
+$ gem install armada
+```
+
+## Writing your service descriptor
+Descriptors are in the form of a Rake file that uses a built-in DSL to make them
+easy to write. Here's a sample config for a project called `myservice` that
+would go into `$CWD/myservice.rake`:
+
+**Armada will look in the current working directory for your service descriptor. We recommend placing this descriptor in your service's repository**
+
+```ruby
+namespace :environment do
+  task :common do
+    env_vars LOG_DIR: '/home/myservice/logs/myservice'
+    container_name 'myservice'
+    set :image, 'quay.io/rallysoftware/myservice'
+    set :health_check_endpoint, '/metrics/healthcheck'
+    set :health_check_port, 3000
+    host_port 3000, container_port: 3000
+  end
+
+  desc 'Boulder environment'
+  task :bld => :common do
+    set_current_environment(:bld)
+    host 'bld-myservice-01:3534'
+    host 'bld-myservice-02:3534'
+    host 'bld-myservice-03:3534'
+  end
+
+  desc 'Production Environment'
+  task :prod => :common do
+    set_current_environment(:prod)
+    host 'prod-myservice-01:3534'
+    host 'prod-myservice-02:3534'
+    host 'prod-myservice-03:3534'
+  end
+
+end
+```
+
+### Common Task
+The `common` task is used to DRY up your descriptor file. It will always be loaded first allowing you to specify common elements of your deployment here and not repeat them throughout the rest of the file. You could also specify common elements here and then override them in later tasks if you need.
+
+### Tasks
+Each task should represent a logical unit of seperation from the rest. For instance, in the above descriptor we are describing each of the environments where the `myservice` project can reside.
+
+### Armada DSL
+Armada provides a few convenience methods for adding items such as host and environment variables to a list.
+
+#### host_port - Exposing container ports to the host system
+The `host_port` method takes 2 parameters - the `port` on the host system and a map of options. The map of options has 3 values that can be set:
+* `host_ip` - The ip address of the host interface. This way you can bind your host port to a particular ip address. Default is `0.0.0.0`
+* `container_port` - The exposed port you are trying to map. **REQUIRED**
+* `type` - The type of port you are exposing. Default is `tcp`.
+
+**You can call this method multiple times to specify multiple exposed ports.**
+**If your container exposes a port and you do not want to map it to a static port on the host, Armada will make sure docker dynamically assigns it a port.**
+
+Examples:
+
+```ruby
+host_port 3000, container_port: 3000
+host_port 8282, container_port: 8080, type: 'udp'
+host_port 5991, host_ip: '123.456.789' container_port: 7001, type: 'udp'
+```
+
+#### host_volume - Mapping container volumes to host volumes
+The `host_volume` method takes two parameters - the host volume and a map of options. The map of options has 1 value that can be set.
+* `container_volume` - The container volume to map to.
+
+**You can call this method multiple times to specify multiple volumes**
+
+Examples:
+```ruby
+host_volume '/var/log', container_volume: '/var/log:rw'
+host_volume '/var/log', container_volume: '/var/log:ro'
+```
+
+#### env_vars - Key value pairs that are passed in as environment variables
+The `env_vars` method take 1 parameter - a map of key value pairs.
+
+Examples:
+```ruby
+env_vars JAVA_OPTS: '-Xmx2g -server -XX:+UseConcMarkSweepGC'
+env_vars DB_USER: 'someuser'
+```
+
+**You can call this method multiple times to specify multiple environment variables**
+
+#### host - Specifies a host for a given task to interact with
+The `host` method takes 1 parameter which is a string containing the `host` and `port` of the docker api you would like to interact with.
+
+Examples:
+```ruby
+host 'bld-docker-01:4243'
+```
+
+**You can call this method multiple times to specify multiple hosts**
+
+#### container_name - Override the container name
+The `container_name` method takes 1 parameter which is a string to name the container when it is created on the host. Currently this is how we identify which container to shutdown during a rolling deploy.
+
+Examples:
+```ruby
+container_name 'myservice'
+```
+
+#### Docker Restart Policy
+You can add your own Docker Restart policy, see the [API documentation](https://docs.docker.com/reference/api/docker_remote_api_v1.15/#create-a-container)
+
+```ruby
+restart_policy { "Name" => "always" }
+restart_policy { "Name" => "on-failure", "MaximumRetryCount" => 5 }
+```
+
+#### Setting other descriptor values
+Some configuration options are not set using a DSL method. Instead you must call the `set` method. The current list of these options are:
+
+```ruby
+set :image, 'quay.io/myorg/myservice'
+set :tag, '0.1.0'
+set :health_check_endpoint, '/_metrics/healthcheck'
+set :health_check_port, 3100
+set :health_check_retries, 60 #number of times to check if the container is up and healthy
+set :health_check_delay, 1 #number of seconds to wait between each retry
+```
+**health_check_port will work even if you do not specify a contianer -> host port mapping. Armada will determine the dynamically assigned port to the expected container health check port and use that when performing the health check.**
+
+#### Raw Container Config
+If you want to use a docker feature not yet exposed through the armadafile, you can include a raw container config, and the rest of the armadafile will be applied on top of it.
+
+```ruby
+container_config { "Cmd" => [ "date" ] }
+container_config { "Privileged" => false }
+```
+
+## CLI
+The CLI is written using [Thor](http://whatisthor.com/). Below is current commands that can be executed using the Armada gem.
+
+### Help
+Examples:
+```bash
+aramda help -- print the main help menu
+armada deploy help parallel -- print the help menu for the parallel subcommand
+armada deploy help
+```
+
+### Deploy
+The following tasks can be used when deploying a container to a set of docker hosts.
+
+#### Parallel
+Deploys a project to all hosts in parallel. The following steps are run within their own thread. This means that some steps may complete on some hosts faster than other. Also means that all machines will be down at roughly the same time.
+
+Command:
+```bash
+armada deploy parallel <project> <environment> <options>
+```
+
+Steps performed by this task:
+ 1. Pull the version of the image you wish to deploy. If `--no-pull` is specified this will not occur.
+ 1. Stop all running container(s) with the name you are wishing to use.
+ 1. Start the new container(s)
+ 1. Wait for the container(s) to come up
+ 1. If you used the `--health-check` option it will then wait until the health check passes
+
+Options:
+* `hosts` - This will override the hosts defined in the descriptor
+* `image` - This will override the image defined in the descriptor
+* `tag` - This will override the tag defined in the descriptor
+* `username` - The username for the private registry of your image, if specified you must also specify `password`
+* `password` - The password for the private registry of your image, if specified you must also specify `username`
+* `health-check` - Default is true. You can specify `--no-health-check` to not perform a health check during a rolling deploy.
+* `env-vars` - This allows for new or overriding env vars to be passed in from the command line. This option can only be specified once, but may take mulitple values.
+* `ssh-gateway` - This allows you to perform commands against a remote docker host(s) using a gateway.
+* `ssh-gateway-user` - The user opening the gateway
+* `pull` - Allows you to specify whether to pull the specified image or not. Defaults to true.
+* `dockercfg` - This is the path to the .dockercfg file which can be used instead of specifying the username and password for the registry. Defaults to `~/.dockercfg`
+
+Examples:
+```bash
+armada deploy parallel foo prod --hosts my-prod-host:5555 --username username --password secretsauce --health-check
+armada deploy parallel foo prod --env-vars PORT:4343 DB_USER:"FOO"
+```
+
+#### Rolling
+This will deploy the project in a rolling fashion. Meaning it will only act on 1 host at a time.
+
+Command:
+```bash
+armada deploy rolling <project> <environment> <options>
+```
+
+Steps performed by this task:
+ 1. Pull the version of the image you wish to deploy. If `--no-pull` is specified this will not occur.
+ 1. Stop all running container(s) with the name you are wishing to use.
+ 1. Start the new container(s)
+ 1. Wait for the container(s) to come up
+ 1. Perform a health check. You can specify the `--no-health-check` option to skip this step.
+ 1. Move to next host (if applicable), sequentially repeating the steps above until all hosts are complete.
+
+Options:
+* `hosts` - This will override the hosts defined in the descriptor
+* `image` - This will override the image defined in the descriptor
+* `tag` - This will override the tag defined in the descriptor
+* `username` - The username for the private registry of your image, if specified you must also specify `password`
+* `password` - The password for the private registry of your image, if specified you must also specify `username`
+* `health-check` - Default is true. You can specify `--no-health-check` to not perform a health check during a rolling deploy.
+* `env-vars` - This allows for new or overriding env vars to be passed in from the command line. This option can only be specified once, but may take mulitple values.
+* `ssh-gateway` - This allows you to perform commands against a remote docker host(s) using a gateway.
+* `ssh-gateway-user` - The user opening the gateway
+* `pull` - Allows you to specify whether to pull the specified image or not. Defaults to true.
+* `dockercfg` - This is the path to the .dockercfg file which can be used instead of specifying the username and password for the registry. Defaults to `~/.dockercfg`
+
+Examples:
+```bash
+armada deploy rolling foo prod --hosts my-prod-host:5555 --username username --password secretsauce --no-health-check
+armada deploy rolling foo prod --env-vars PORT:4343 DB_USER:"FOO"
+```
+
+### Clean
+The clean commands offer a way to clean up stale images or old containers from a host or set of hosts. You can issue these commands through a gateway if you like.
+
+#### Containers
+This will remove all containers that are not running or paused.
+
+Options:
+* `hosts` - The list of hosts you wish to perform this action against
+* `ssh-gateway` - This allows you to perform commands against a remote docker host(s) using a gateway.
+* `ssh-gateway-user` - The user opening the gateway
+* `force` - Force the action to take place. ** If this option is not specified it will perform a dry run**
+
+Examples:
+```bash
+armada clean containers --hosts my-docker-host-01:3435
+```
+
+#### Images
+This will remove all images that are considered "orphaned". This means they are tagged as <none> if you run the `docker images` command. You will notice that this command will print out an error like the following:
+
+```bash
+bld-docker-01 -- unable to remove image 9d535e81db1e because of the following error - Expected([200, 201, 202, 203, 204, 304]) <=> Actual(409 Conflict)
+```
+This is because it is not the parent image. We are working to resolve this problem. You may also have to run this command a few times to get all the images cleaned up. 
+
+Options:
+* `hosts` - The list of hosts you wish to perform this action against
+* `ssh-gateway` - This allows you to perform commands against a remote docker host(s) using a gateway.
+* `ssh-gateway-user` - The user opening the gateway
+* `force` - Force the action to take place. ** If this option is not specified it will perform a dry run**
+
+Examples:
+```bash
+armada clean images --hosts my-docker-host-01:3435
+```
+
+## Maintainers
+[Jonathan Chauncey (jchauncey)](https://github.com/jchauncey)  
+[Darrell Hamilton (zeroem)](https://github.com/zeroem)
+
+## License
+Copyright (c) 2014 Rally Software Development Corp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/Thorfile

@@ -0,0 +1 @@
+require 'thor/scmversion'

data/armada.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'armada/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'docker-armada'
+  spec.version       = Armada::VERSION
+  spec.authors       = ['Jonathan Chauncey', 'Matt Farrar', 'Darrell Hamilton']
+  spec.summary       = 'Deploy utility for docker containers'
+  spec.description   = 'Deploy utility for docker containers'
+  spec.homepage      = 'https://github.com/RallySoftware/armada'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'excon', '~> 0.33'
+  spec.add_dependency 'net-ssh'
+  spec.add_dependency 'net-ssh-gateway'
+  spec.add_dependency 'docker-api', '~> 1.13'
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'awesome_print'
+  spec.add_dependency 'table_print'
+  spec.add_dependency 'conjur-cli'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14.0'
+  spec.add_development_dependency 'thor-scmversion', '< 1.6.0'
+  spec.add_development_dependency 'geminabox', '~> 0.10'
+  spec.add_development_dependency 'webmock'
+
+  spec.required_ruby_version = '>= 1.9.3'
+end

data/bin/armada

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path("../../lib", __FILE__)
+require 'armada'
+
+Armada::Cli.start

data/lib/armada.rb

@@ -0,0 +1,37 @@
+require 'thor'
+require 'net/ssh/gateway'
+require 'awesome_print'
+require 'table_print'
+
+require_relative 'armada/cli'
+require_relative 'armada/clean'
+require_relative 'armada/configuration'
+require_relative 'armada/connection'
+require_relative 'armada/deploy'
+require_relative 'armada/docker'
+require_relative 'armada/deploy_dsl'
+require_relative 'armada/ui'
+require_relative 'armada/utils'
+require_relative 'armada/thor'
+
+module Armada
+  Thor::Base.shell.send(:include, Armada::UI)
+
+  class << self
+    def root
+      @root ||= Pathname.new(File.expand_path('../', File.dirname(__FILE__)))
+    end
+
+    def executable_name
+      File.basename($PROGRAM_NAME)
+    end
+
+    def ui
+      @ui ||= Thor::Base.shell.new
+    end
+  end
+end
+
+Excon.defaults[:connect_timeout] = 120
+Excon.defaults[:read_timeout]    = 120
+Excon.defaults[:write_timeout]   = 120