simple_provision 0.99.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b9054da4fdd261531b7c333a4e58768defe18e5
+  data.tar.gz: 4d15973d1f36b144cfa1be8df14b1fc447068e45
+SHA512:
+  metadata.gz: aa8c47134f34cce7813461ac5c768abd708382b9717ef6e8c503f72727cf4ecdd59dfa4c13d06b0ca48a6198475ce975804ac66c54fdc6dd66acdf20df86d84f
+  data.tar.gz: bb5e2fe6f4428809a95a0a57c399a029af5851126375ebcd623ad474e5c59b317ae6315e392539cd8e947b3d1180e52dfad7fd43f0f31efce19f271d09ab4dfa

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_provision.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Hilkert
+
+MIT License
+
+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,116 @@
+# Introduction
+This is based on the work that brandonhilkert initally carried to automate
+EC2 deployment with YAML and SHELL script. It tries to bring the good spirit: SIMPLE,
+and JUST WORK to the world of Digital Ocean. So you own a Digital Ocean?
+
+If you have suffer days of headache with Chef and Puppet, time for a new
+simple way of provision. Let's rock.
+
+### Recipes repo
+
+Don't forget to also checkout the recipes collection
+https://github.com/phuongnd08/simple_privision_recipes
+
+# How it works
+This gem carries the provision by uploading a set of scripts (and
+files) to the server and execute there.
+
+It's up to you to choose the language you want. I often use a mix of
+SHELL and RUBY scripts to accomplish the task. SHELL for some simple stuff
+like install a package on the server and RUBY when I need to complete
+some tricky part of the configuration.
+
+Just remember that you need to use a shell script to install ruby/python first,
+and then you can start use ruby/python. The install of ruby and python can be
+as simple as create a bash contains "yum install ruby(python) -y" and include
+it in the top of the `scripts` section in your server definition file.
+
+# Project Structure
+As simple as it could: One or few servers definition written in YAML + setup scripts written in
+SHELL, RUBY and PYTHON + text files as resource.
+It's up to you to use ERB, HAML or any kind of template processors.
+
+```
+./provisions
+├── files
+│   ├── keys
+│   │   └── deploy_key
+│   └── rails_config
+│       └── database.yml
+├── scripts
+│   ├── apt.sh
+│   ├── deploy_key.sh
+│   ├── git.sh
+│   ├── redis.rb
+│   ├── ruby2.sh
+│   ├── rubygems.sh
+│   ├── install_tornado.py
+│   ├── search_service_code.sh
+│   └── search_service_env.sh
+└── servers
+    ├── defaults.yml
+    └── search-service.yml
+```
+
+So: You put definition of each type of server in `servers/type.yml`.
+In `files` and `scripts` folder, you place files and scripts that will be
+uploaded to the Digital Ocean droplet and executed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_provision'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_provision
+
+## Servers Configuration
+
+### Server Definition
+To define a server type, create a yaml file in the `./servers` directory with the following format:
+
+`./servers/my-awesome-server.yml`
+
+```yaml
+files:
+  - files/credentials.yml
+scripts:
+  - scripts/git.sh
+  - scripts/ruby.sh
+  - scripts/rubygems.sh
+  - scripts/redis.sh
+env:
+  DBNAME: my_db_name
+  WEBROOT: /var/www/app
+```
+
+### Shared Definitions
+
+You can share definitions across server types with `./servers/defaults.yml`
+
+```yaml
+private_key_path: /Users/bhilkert/.ssh/pd-app-server
+```
+
+
+### Passing variables to scripts
+Variables defined in `env` will be exposed to scripts during execution.
+That way you can use the same scripts for different type of server and
+still be able to produce different outcomes.
+
+## Provision your Digital Ocean server:
+`simpro y-awesome-server --droplet-name YOUR_DROPLET_NAME`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+task :default => [:console]
+
+task :console do
+  exec "irb -r fss -I ./lib"
+end

data/bin/simpro

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/simple_provision'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: fss [options] type"
+
+  opts.on('--droplet-name NAME', 'An exiting Droplet Name' ) do |name|
+    options[:droplet_name] = name
+  end
+
+  opts.on('-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+
+  opts.on('-v', '--version', 'Show version' ) do
+    puts SimpleProvision::Version
+  end
+end.parse!
+
+options.merge!(type: ARGV.first)
+
+cli = SimpleProvision::CLI.new(options)
+cli.configure

data/lib/ext/fog.rb

@@ -0,0 +1,61 @@
+require 'fog'
+require 'fog/core/ssh'
+
+# Monkey-patch Fog 1.3.1 to stream SSH output
+# (in real time) to stdout.
+class Fog::SSH::Real
+  def run(commands)
+    commands = [*commands]
+    results  = []
+    begin
+      Net::SSH.start(@address, @username, @options) do |ssh|
+        commands.each do |command|
+          result = Fog::SSH::Result.new(command)
+          ssh.open_channel do |ssh_channel|
+            ssh_channel.request_pty
+            ssh_channel.exec(command) do |channel, success|
+              unless success
+                raise "Could not execute command: #{command.inspect}"
+              end
+
+              channel.on_data do |ch, data|
+                result.stdout << data
+                puts data
+              end
+
+              channel.on_extended_data do |ch, type, data|
+                next unless type == 1
+                result.stderr << data
+                puts data
+              end
+
+              channel.on_request('exit-status') do |ch, data|
+                result.status = data.read_long
+              end
+
+              channel.on_request('exit-signal') do |ch, data|
+                result.status = 255
+              end
+            end
+          end
+          ssh.loop
+          results << result
+        end
+      end
+    rescue Net::SSH::HostKeyMismatch => exception
+      exception.remember_host!
+      sleep 0.2
+      retry
+    end
+    results
+  end
+end
+
+require "fog/digitalocean/models/compute/server"
+
+# Monkey patch Digital Ocean to properly return public_ip_address to used in scp
+Fog::Compute::DigitalOcean::Server.class_eval do
+  def public_ip_address
+    ip_address
+  end
+end

data/lib/simple_provision/cli.rb

@@ -0,0 +1,30 @@
+module SimpleProvision
+  class CLI
+    def initialize(opts = {})
+      @opts = opts
+      @connection = SimpleProvision::Connection.new(options).connection
+    end
+
+    def bootstrap
+      server.bootstrap
+    end
+
+    def build
+      server.build
+    end
+
+    def configure
+      server.configure
+    end
+
+    private
+
+    def server
+      SimpleProvision::Server.new(@connection, options)
+    end
+
+    def options
+      @options ||= SimpleProvision::Configuration.new(@opts).options
+    end
+  end
+end

data/lib/simple_provision/configuration.rb

@@ -0,0 +1,49 @@
+require 'yaml'
+
+module SimpleProvision
+  class Configuration
+    MissingServerType = Class.new(StandardError)
+    MissingServerConfiguration = Class.new(StandardError)
+
+    attr_reader :options
+
+    def initialize(command_line_options = {})
+      @command_line_options = command_line_options
+
+      read_and_parse_server_options
+
+      raise MissingServerType, "Please specify a type of server you want to create using the --type option" unless options[:type]
+    end
+
+    private
+
+    def default_options
+      begin
+        YAML.load(File.read('servers/defaults.yml'))
+      rescue Errno::ENOENT
+        {}
+      end
+    end
+
+    def server_options
+      begin
+        YAML.load(File.read(server_file))
+      rescue Errno::ENOENT
+        raise MissingServerConfiguration, "Please create a configuration file './servers/#{type}.yml'"
+      end
+    end
+
+    def server_file
+      "servers/#{type}.yml"
+    end
+
+    def read_and_parse_server_options
+      options_string_hash = default_options.merge(server_options).merge(@command_line_options)
+      @options = Hash[options_string_hash.map{ |(k,v)| [k.to_sym, v] }]
+    end
+
+    def type
+      @command_line_options[:type]
+    end
+  end
+end

data/lib/simple_provision/connection.rb

@@ -0,0 +1,25 @@
+require 'fog'
+
+module SimpleProvision
+  class Connection
+    MissingDigitalOceanCredentials = Class.new(StandardError)
+
+    def initialize(opts)
+      @opts = opts
+
+      if ENV["DIGITAL_OCEAN_API_KEY"].nil? || ENV["DIGITAL_OCEAN_CLIENT_ID"].nil?
+        raise SimpleProvision::Connection::MissingDigitalOceanCredentials, "Make sure DIGITAL_OCEAN_API_KEY and DIGITAL_OCEAN_CLIENT_ID are environmental variables with your credentials"
+      end
+    end
+
+    def connection
+      @connection ||= begin
+        Fog::Compute.new(
+          provider: "DigitalOcean",
+          digitalocean_client_id: ENV["DIGITAL_OCEAN_CLIENT_ID"],
+          digitalocean_api_key: ENV["DIGITAL_OCEAN_API_KEY"]
+        )
+      end
+    end
+  end
+end

data/lib/simple_provision/scp.rb

@@ -0,0 +1,42 @@
+module SimpleProvision
+  class SCP
+    FILENAME = "fss.tar.gz"
+
+    def initialize(server, opts)
+      @server, @opts = server, opts
+    end
+
+    def to_server
+      create_local_archive
+      scp_files_to_server
+      extract_remote_archive
+      remove_local_archive
+    end
+
+    private
+
+    def create_local_archive
+      files = @opts[:files] || []
+      scripts = @opts[:scripts] || []
+      includes = files + scripts
+
+      if includes.empty?
+        raise "Both files and scripts are empty. You should provide some"
+      end
+
+      `tar -czf #{FILENAME} #{includes.join(" ")}`
+    end
+
+    def scp_files_to_server
+      @server.scp(FILENAME, ".")
+    end
+
+    def extract_remote_archive
+      @server.ssh("tar -xzf #{FILENAME}")
+    end
+
+    def remove_local_archive
+      `rm -f #{FILENAME}`
+    end
+  end
+end

data/lib/simple_provision/server.rb

@@ -0,0 +1,55 @@
+require 'shellwords'
+
+module SimpleProvision
+  class Server
+    ServerNotFound = Class.new(StandardError)
+    MissingDropletName = Class.new(StandardError)
+
+    attr_reader :server
+
+    def initialize(connection, options)
+      @connection, @options = connection, options
+    end
+
+    def configure
+      get(options[:droplet_name]) if server.nil?
+      raise ServerNotFound, "Unable to find server with Droplet name #{options[:droplet_name]}." if server.nil?
+
+      SimpleProvision::SCP.new(server, options).to_server
+      scripts = options.fetch(:scripts).map do |script|
+        "#{environment_exports} bash -c '#{script}'"
+      end
+      server.ssh(scripts)
+    end
+
+    def environment_exports
+      @environment_exports ||= begin
+                                 if options[:env].nil?
+                                   ""
+                                 else
+                                   options[:env].map { |k, v| [k, Shellwords.escape(v)].join("=") }.join(" ")
+                                 end
+                               end
+    end
+
+    private
+
+    attr_reader :options, :connection
+
+    def get(droplet_name)
+      if droplet_name.nil?
+        raise SimpleProvision::Server::MissingDropletName ,
+          "Please specify the Droplet Name using the --droplet-name option."
+      end
+      @server = connection.servers.detect { |server| server.name == droplet_name }
+      if options.has_key?(:private_key_path)
+        @server.private_key_path = options.fetch(:private_key_path)
+      end
+      @server
+    end
+
+    def name
+      "#{options.fetch(:name).downcase.sub(/ /, '-')}-#{Time.now.strftime("%y-%m-%d-%H-%M")}"
+    end
+  end
+end

data/lib/simple_provision/version.rb

@@ -0,0 +1,3 @@
+module SimpleProvision
+  VERSION = "0.99.2"
+end

data/lib/simple_provision.rb

@@ -0,0 +1,14 @@
+require "simple_provision/version"
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require_relative 'simple_provision/cli'
+require_relative 'simple_provision/configuration'
+require_relative 'simple_provision/connection'
+require_relative 'simple_provision/scp'
+require_relative 'simple_provision/server'
+
+require_relative 'ext/fog'

data/simple_provision.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_provision/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_provision"
+  spec.version       = SimpleProvision::VERSION
+  spec.authors       = ["Phuong Gia Su", "Brandon Hilkert"]
+  spec.email         = ["phuongnd08@gmail.com", "brandonhilkert@gmail.com"]
+  spec.description   = %q{The easiest, most common sense server provision tool.}
+  spec.summary       = %q{The easiest, most common sense server provision tool.}
+  spec.homepage      = "https://github.com/phuongnd08/simple_provision"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "fog", "~> 1.14.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: simple_provision
+version: !ruby/object:Gem::Version
+  version: 0.99.2
+platform: ruby
+authors:
+- Phuong Gia Su
+- Brandon Hilkert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+description: The easiest, most common sense server provision tool.
+email:
+- phuongnd08@gmail.com
+- brandonhilkert@gmail.com
+executables:
+- simpro
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/simpro
+- lib/ext/fog.rb
+- lib/simple_provision.rb
+- lib/simple_provision/cli.rb
+- lib/simple_provision/configuration.rb
+- lib/simple_provision/connection.rb
+- lib/simple_provision/scp.rb
+- lib/simple_provision/server.rb
+- lib/simple_provision/version.rb
+- simple_provision.gemspec
+homepage: https://github.com/phuongnd08/simple_provision
+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.0.3
+signing_key: 
+specification_version: 4
+summary: The easiest, most common sense server provision tool.
+test_files: []