gearship 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8aeb3e4ca5216f7eed6e9cb8816bce3012c914ac
+  data.tar.gz: eb9caa170948c310dbab24a250e139edc2885761
+SHA512:
+  metadata.gz: bb2d7fab9e9c175ae7b07295723c317fda1fb878130f76efb2178851fcba6a7c9d2f2cb052673495d2f380d6219593da25d7425cc6fb52b9f1962a913b8d6b21
+  data.tar.gz: 47c33cf91042edf84b3b76f8400368e68f35c2ada3e2550213683d11308da1071bec810ebcfa64a82e55f71b49d2708bf26a57c584b11cc054d1ef05261919cf

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Leonas. 
+
+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,81 @@
+![](gearship.png)
+--------
+## `gearship` deploys dockerized projects to virtual machines.
+
+Created as a micro alternative to puppet, chef, capistrano, etc, for managing droplets on digital ocean.
+
+### Overview
+- `gem install gearship`
+- `gearship init`
+- update `gearship.yml` with server configuration
+- update `gearship.sh` with install configuration
+- `gearship go setup_host`
+- `gearship go deploy_app`
+- your app is live!
+
+----------
+
+## Quickstart
+
+Install Gem:
+
+```bash
+$ gem install gearship
+```
+
+`cd` into your project directory then create the `gearship` folder:
+
+```bash
+$ cd my_project
+$ gearship init
+```
+
+`cd` into the `gearship` folder and edit `gearship.yml` with your server configuration
+
+Run `gearship go setup_host` to install docker on a new server:
+
+```bash
+$ cd gearship
+$ gearship go setup_host
+```
+
+Ship your dockerized project to the docker host:
+
+```bash
+$ gearship go deploy_app
+```
+---------
+## gearship performs missions which are composed of actions.
+
+- Shell scripts under the `missions` directory, such as `setup_host.sh` or `deploy_app.sh`, are automatically recognized as a mission. 
+
+- The actions folder has reusable actions that can be called from any `mission_name.sh` with `source actions/action_name.sh`.
+
+- Actions can be retrieved remotely via HTTP. Put a URL in the actions section of `gearship.yml`, and gearship will automatically load the content and put it into the `compiled/actions` folder in the compile phase.
+ 
+- `gearship go install_app` is  equivalent to running `gearship.sh`, followed by `install_app.sh`.
+
+### What gearship does when `gearship go setup_app` is called
+
+1. Compile `gearship.yml` to generate attributes, retrieve remote actions, and copy files from `cargo` into the `compiled` directory. Append `setup_app.sh` file to a copy of `gearship.sh` in the `compiled` directory.
+2. SSH to the server specified in gearship.yml
+3. Transfer the content of the `compiled` directory to the remote server and extract in `$HOME/gearship`
+4. Run `gearship.sh` on the remote server.
+
+## Commands
+
+```bash
+$ gearship                                        # Show command help
+$ gearship init                                   # Install gearship into project
+$ gearship go [mission]                           # go docker project
+```
+
+
+## Passing setup variables to scripts during compilation
+
+#### Ruby
+Attributes defined in `gearship.yml` are accessible from any file with `<%= @attributes.attribute_name %>` when `eval_erb: true` is set in `gearship.yml`
+
+#### Bash
+Attributes defined in `gearship.yml` are split into individual files in `compiled/attributes`. 
+Refer to them by `$(cat attributes/attribute_name)` in the script.

data/bin/gearship

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Abort beautifully with ctrl+c.
+Signal.trap(:INT) { abort "\ngearship aborting." }
+
+# Load the main lib and invoke CLI.
+require 'gearship'
+Gearship::Cli.start

data/gearship.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gearship'
+  spec.version       = '0.1.3' # retrieve this value by: Gem.loaded_specs['gearship'].version.to_s
+  spec.authors       = ['Leonas']
+  spec.email         = ['leonas@leonas.io']
+  spec.homepage      = 'http://github.com/leonas/gearship'
+  spec.summary       = %q{Deploy dockerized projects to virtual machines.}
+  spec.description   = %q{Quickly set up a docker host and deploy your app with ease.}
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'rainbow'
+  spec.add_runtime_dependency 'net-ssh'
+end

data/lib/gearship/cli.rb

@@ -0,0 +1,146 @@
+require 'open3'
+require 'ostruct'
+require 'net/ssh'
+
+module Gearship
+  class Cli < Thor
+    include Thor::Actions
+
+    desc 'init', 'Initialize gearship project'
+    def init(project = 'gearship')
+      do_init(project)
+    end
+
+    desc 'go [mission] [--sudo]', 'Send gearship on a mission'
+    method_options :sudo => false
+    def go(target, *args)
+      do_go(target, *args)
+    end
+
+    desc 'compile', 'Compile gearship project for debugging'
+    def compile(mission = nil)
+      do_compile(mission)
+    end
+
+    desc 'version', 'Show gearship version'
+    def version
+      puts Gem.loaded_specs['gearship'].version.to_s
+    end
+
+    no_tasks do
+      include Gearship::Utility
+
+      def self.source_root
+        File.expand_path('../../',__FILE__)
+      end
+
+      def do_init(project)
+        copy_file 'templates/.gitignore',                            "#{project}/.gitignore"
+        copy_file 'templates/gearship.yml',                          "#{project}/gearship.yml"
+        copy_file 'templates/gearship.sh',                             "#{project}/gearship.sh"
+        
+        copy_file 'templates/actions/configure_firewall.sh',         "#{project}/actions/configure_firewall.sh"
+        copy_file 'templates/actions/install_basics.sh',             "#{project}/actions/install_basics.sh"
+        copy_file 'templates/actions/install_digitalocean_agent.sh', "#{project}/actions/install_digitalocean_agent.sh"
+        copy_file 'templates/actions/install_docker.sh',             "#{project}/actions/install_docker.sh"
+        copy_file 'templates/actions/start_app.sh',                  "#{project}/actions/start_app.sh"
+        
+        copy_file 'templates/missions/install_app.sh',               "#{project}/missions/install_app.sh"
+        copy_file 'templates/missions/setup_host.sh',                "#{project}/missions/setup_host.sh"
+        copy_file 'templates/missions/update_app.sh',                "#{project}/missions/update_app.sh"
+        
+        copy_file 'templates/cargo/sample.conf',                     "#{project}/cargo/sample.conf"
+        copy_file 'templates/notes/sample.md',                       "#{project}/notes/sample.md"
+      end
+
+      def do_go(*args)
+        mission = args[0]
+        
+        do_compile(mission)
+        
+        sudo = 'sudo ' if options.sudo?
+        user, host, port = parse_target(@config['attributes']['ssh_target'])
+        endpoint = "#{user}@#{host}"
+
+        # Remove server key from known hosts to avoid mismatch errors when VMs change.
+        `ssh-keygen -R #{host} 2> /dev/null`
+
+        remote_commands = <<-EOS
+        rm -rf ~/gearship &&
+        mkdir ~/gearship &&
+        cd ~/gearship &&
+        tar xz &&
+        #{sudo}bash gearship.sh
+        EOS
+
+        remote_commands.strip! << ' && rm -rf ~/gearship' if @config['preferences'] and @config['preferences']['erase_remote_folder']
+
+        local_commands = <<-EOS
+        cd compiled
+        tar cz . | ssh -o 'StrictHostKeyChecking no' #{endpoint} -p #{port} '#{remote_commands}'
+        EOS
+
+        Open3.popen3(local_commands) do |stdin, stdout, stderr|
+          stdin.close
+          t = Thread.new do
+            while (line = stderr.gets)
+              print line.color(:red)
+            end
+          end
+          while (line = stdout.gets)
+            print line.color(:green)
+          end
+          t.join
+        end
+      end
+
+      def do_compile(mission)
+        abort_with 'You must be in the gearship folder' unless File.exists?('gearship.yml')
+        abort_with "#{mission} doesn't exist!" if mission and !File.exists?("missions/#{mission}.sh")
+
+        @config = YAML.load(File.read('gearship.yml'))
+
+        @config['attributes'] ||= {}
+        @config['attributes'].update(Hash[@instance_attributes.map{|k,v| [k.to_s, v] }]) if @instance_attributes
+
+        (@config['attributes'] || {}).each {|key, value| create_file "compiled/attributes/#{key}", value }
+
+        cache_remote_actions = @config['preferences'] && @config['preferences']['cache_remote_actions']
+        (@config['actions'] || []).each do |key, value|
+          next if cache_remote_actions and File.exists?("compiled/actions/#{key}.sh")
+          get value, "compiled/actions/#{key}.sh"
+        end
+
+        copy_or_template = (@config['preferences'] && @config['preferences']['eval_erb']) ? :template : :copy_file
+        copy_local_files(@config, copy_or_template)
+
+        if mission
+          if copy_or_template == :template
+            template File.expand_path('gearship.sh'), 'compiled/_gearship.sh'
+            create_file 'compiled/gearship.sh', File.binread('compiled/_gearship.sh') << "\n" << File.binread("compiled/missions/#{mission}.sh")
+          else
+            create_file 'compiled/gearship.sh', File.binread('gearship.sh') << "\n" << File.binread("missions/#{mission}.sh")
+          end
+        else
+          send copy_or_template, File.expand_path('gearship.sh'), 'compiled/gearship.sh'
+        end
+      end
+
+      def parse_target(target)
+        target.match(/(.*@)?(.*?)(:.*)?$/)
+        config = Net::SSH::Config.for($2)
+        [ ($1 && $1.delete('@') || config[:user] || 'root'), 
+          config[:host_name] || $2, 
+          ($3 && $3.delete(':') || config[:port] && config[:port].to_s || '22') ]
+      end
+
+      def copy_local_files(config, copy_or_template)
+        @attributes = OpenStruct.new(config['attributes'])
+        files = Dir['{actions,missions,cargo}/**/*'].select { |file| File.file?(file) }
+        files.each { |file| send copy_or_template, File.expand_path(file), File.expand_path("compiled/#{file}") }
+
+        (config['files'] || []).each {|file| send copy_or_template, File.expand_path(file), "compiled/cargo/#{File.basename(file)}" }
+      end
+    end
+  end
+end

data/lib/gearship/logger.rb

@@ -0,0 +1,17 @@
+module Gearship
+  module Logger
+    class << self
+      def info(text)
+        puts text.bright
+      end
+
+      def success(text)
+        puts text.color(:green).bright
+      end
+
+      def error(text)
+        puts text.color(:red).bright
+      end
+    end
+  end
+end

data/lib/gearship/utility.rb

@@ -0,0 +1,17 @@
+module Gearship
+  module Utility
+    def abort_with(text)
+      Logger.error text
+      abort
+    end
+
+    def exit_with(text)
+      Logger.success text
+      exit
+    end
+
+    def say(text)
+      Logger.info text
+    end
+  end
+end

data/lib/gearship.rb

@@ -0,0 +1,12 @@
+require 'thor'
+require 'rainbow'
+require 'yaml'
+
+require 'rainbow/version'
+require 'rainbow/ext/string' unless Rainbow::VERSION < '2.0.0'
+
+module Gearship
+  autoload :Cli,        'gearship/cli'
+  autoload :Logger,     'gearship/logger'
+  autoload :Utility,    'gearship/utility'
+end

data/lib/templates/.gitignore

@@ -0,0 +1 @@
+/compiled

data/lib/templates/actions/configure_firewall.sh

@@ -0,0 +1,19 @@
+# install if not already present
+if gearship.install "ufw"; then
+    apt-get -y install ufw
+fi
+
+# configure ufw
+if ufw status | grep -q 'Status: active'; then
+  echo "ufw already configured, skipping."
+else
+  
+  # make sure ssh connection is not dropped
+  ufw allow ssh       
+  
+  # enable firewall
+  ufw --force enable
+  ufw allow ssh
+  ufw allow http
+  ufw allow https
+fi

data/lib/templates/actions/install_basics.sh

@@ -0,0 +1,6 @@
+# Update apt catalog and upgrade installed packages
+gearship.mute "apt-get update"
+gearship.mute "apt-get -y upgrade"
+
+# install most important packages
+apt-get -y install git ntp curl

data/lib/templates/actions/install_digitalocean_agent.sh

@@ -0,0 +1 @@
+curl -sSL https://agent.digitalocean.com/install.sh | sh

data/lib/templates/actions/install_docker.sh

@@ -0,0 +1,12 @@
+if gearship.install "docker-ce"; then
+    sudo apt-get install -y linux-image-extra-$(uname -r) linux-image-extra-virtual
+    
+    sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common
+    
+    curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+    
+    sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
+   
+    sudo apt-get update
+    sudo apt-get install -y docker-ce
+fi

data/lib/templates/actions/start_app.sh

@@ -0,0 +1,3 @@
+docker login -u="<%= @attributes.docker_username %>" -p="<%= @attributes.docker_password %>"
+docker pull <%= @attributes.docker_repo %>
+docker run -d -p <%= @attributes.app_port_map %> --name=<%= @attributes.app_name %> --restart=always -d <%= @attributes.app_repo %>

data/lib/templates/cargo/sample.conf

@@ -0,0 +1 @@
+# All files in this folder get transferred to remote server.

data/lib/templates/gearship.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+
+# Main install script. mission scripts get appended to this when executing
+# bundle exec gearship setup_host
+
+# Exit immediately if a pipeline returns a non-zero status.
+# (unless part of the test in an if statement)
+set -e
+
+export DEBIAN_FRONTEND=noninteractive
+ 
+# Mute STDOUT and STDERR
+function gearship.mute() {
+  echo "Running \"$@\""
+  `$@ >/dev/null 2>&1`
+  return $?
+}
+
+function gearship.installed() {
+  dpkg -s $@ >/dev/null 2>&1
+  return $?
+}
+
+function gearship.install() {
+  if gearship.installed "$@"; then
+    echo "$@ already installed"
+    return 1
+  else
+    echo "No packages found matching $@. Installing..."
+    gearship.mute "apt-get -y install $@"
+    return 0
+  fi
+}
+
+echo "
+       ___                      _     _       
+      / __| ___  __ _  _ _  ___| |_  (_) _ __ 
+     | (_ |/ -_)/ _\` || '_|(_-<| ' \ | || '_ \\
+      \___|\___|\__,_||_|  /__/|_||_||_|| .__/
+                                        |_|   
+                                              
+                ___  _ _    __ _              
+               / _ \| ' \  / _\` |             
+               \___/|_||_| \__,_|             
+                                              
+                _          _             _    
+         _ __  (_) ___ ___(_) ___  _ _  | |   
+        | '  \ | |(_-<(_-<| |/ _ \| ' \ |_|   
+        |_|_|_||_|/__//__/|_|\___/|_||_|(_)   
+                                              
+
+"

data/lib/templates/gearship.yml

@@ -0,0 +1,25 @@
+---
+# variables here will be compiled to individual files in compiled/attributes.
+attributes:
+  ssh_target: user@target:port
+  docker_username: docker_user
+  docker_password: docker_password
+  app_name: app_name
+  app_repo: username/repository
+  app_port_map: "4000:4000"
+  
+# Remote actions here will be downloaded to compiled/actions.
+actions:
+  # install_newrelic: https://github.com/leonas/gearship-actions/install_newrelic.sh
+
+# Listed files will be copied to compiled/files.
+# files:
+#   - ~/.ssh/id_rsa.pub
+
+preferences:
+  # Erase the generated folder on the server after deploy.
+  erase_remote_folder: true
+  cache_remote_actions: false
+
+  # Use variables like <%= @attributes.environment %> in actions, roles, files and install.sh.
+  eval_erb: true

data/lib/templates/missions/install_app.sh

@@ -0,0 +1 @@
+source actions/start_app.sh

data/lib/templates/missions/setup_host.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+
+
+source actions/install_basics.sh
+source actions/install_docker.sh
+source actions/configure_firewall.sh
+
+# https://github.com/v2tec/watchtower
+# Use watchtower to keep docker files auto updated

data/lib/templates/missions/update_app.sh

@@ -0,0 +1,2 @@
+docker stop <%= @attributes.app_name %>
+source actions/start_app.sh

data/lib/templates/notes/sample.md

@@ -0,0 +1,5 @@
+Notes folder:
+- unfinished action and mission scripts here so they don't cause errors when compiling.
+- ideas and to do's for what to automate next using gearship
+
+Feel free to delete this file and/or folder.

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: gearship
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Leonas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Quickly set up a docker host and deploy your app with ease.
+email:
+- leonas@leonas.io
+executables:
+- gearship
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- bin/gearship
+- gearship.gemspec
+- gearship.png
+- lib/gearship.rb
+- lib/gearship/cli.rb
+- lib/gearship/logger.rb
+- lib/gearship/utility.rb
+- lib/templates/.gitignore
+- lib/templates/actions/configure_firewall.sh
+- lib/templates/actions/install_basics.sh
+- lib/templates/actions/install_digitalocean_agent.sh
+- lib/templates/actions/install_docker.sh
+- lib/templates/actions/start_app.sh
+- lib/templates/cargo/sample.conf
+- lib/templates/gearship.sh
+- lib/templates/gearship.yml
+- lib/templates/missions/install_app.sh
+- lib/templates/missions/setup_host.sh
+- lib/templates/missions/update_app.sh
+- lib/templates/notes/sample.md
+homepage: http://github.com/leonas/gearship
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Deploy dockerized projects to virtual machines.
+test_files: []