sunzi 0.3.0 → 0.4.0

data/README.md

@@ -27,7 +27,7 @@ Go to your project directory, then:
 
     $ sunzi create
 
-It generates a `sunzi` folder along with subdirectories and templates. Inside `sunzi`, there's `attributes.yml`, which defines dynamic attributes to be used from recipes. Also there's the `remote` folder, which will be transferred to the remote server, that contains recipes and dynamic variables compiled from `attributes.yml`.
+It generates a `sunzi` folder along with subdirectories and templates. Inside `sunzi`, there's `sunzi.yml`, which defines dynamic attributes to be used from recipes. Also there's the `remote` folder, which will be transferred to the remote server, that contains recipes and dynamic variables compiled from `sunzi.yml`.
 
 Go into the `sunzi` directory, then run the `sunzi deploy`:
 
@@ -38,7 +38,7 @@ Now, what it actually does is:
 
 1. SSH to `example.com` and login as `root`
 1. Transfer the content of the `remote` directory to the remote server and extract in `$HOME/sunzi`
-1. Run `install.sh` in the remote server
+1. Run `install.sh` on the remote server
 
 As you can see, what you need to do is edit `install.sh` and add some shell commands. That's it.
 
@@ -61,13 +61,13 @@ sunzi/
 How do you pass dynamic values to a recipe?
 -------------------------------------------
 
-In the compile phase, `attributes.yml` are split into multiple files, one per attribute. We use filesystem as a sort of key-value storage so that it's easy to use from shell scripts.
+In the compile phase, attributes defined in `sunzi.yml` are split into multiple files, one per attribute. We use filesystem as a sort of key-value storage so that it's easy to use from shell scripts.
 
 The convention for argument passing to a recipe is to use `$1`, `$2`, etc. and put a comment line for each argument.
 
 For instance, given a recipe `greeting.sh`:
 
-```
+```bash
 # Greeting
 # $1: Name for goodbye
 # $2: Name for hello
@@ -77,14 +77,14 @@ echo "Goodbye $1, Hello $2!"
 
 With `attributes.yml`:
 
-```
+```yaml
 goodbye: Chef
 hello: Sunzi
 ```
 
 Then, include the recipe in `install.sh`:
 
-```
+```bash
 source recipes/greeting.sh $(cat attributes/goodbye) $(cat attributes/hello)
 ```
 
@@ -97,16 +97,26 @@ Goodbye Chef, Hello Sunzi!
 Remote Recipes
 --------------
 
-Recipes can be retrieved remotely via HTTP. Put a URL in `recipes.yml`, and Sunzi automatically loads the content and put it into the `remote/recipes` folder.
+Recipes can be retrieved remotely via HTTP. Put a URL in the recipes section of `sunzi.yml`, and Sunzi will automatically load the content and put it into the `remote/recipes` folder in the compile phase.
 
-For instance, if you have the following line in `recipes.yml`,
+For instance, if you have the following line in `sunzi.yml`,
 
-```
-rvm: https://raw.github.com/kenn/sunzi-recipes/master/ruby/rvm.sh
+```yaml
+recipes:
+  rvm: https://raw.github.com/kenn/sunzi-recipes/master/ruby/rvm.sh
 ```
 
 `rvm.sh` will be available and you can refer to that recipe by `source recipes/rvm.sh`.
 
+Cloud Support
+-------------
+
+You can setup a new VM / teardown an existing VM interactively. Use `sunzi setup` and `sunzi teardown` for that.
+
+The following screenshot says it all.
+
+![Sunzi for Linode](http://farm8.staticflickr.com/7210/6783789868_ab89010d5c.jpg)
+
 Vagrant
 -------
 
@@ -124,7 +134,7 @@ end
 
 with `chpasswd.sh`:
 
-```
+```bash
 #!/bin/bash
 
 sudo echo 'root:vagrant' | /usr/sbin/chpasswd

data/bin/sunzi

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+Signal.trap(:INT) { abort "\nAborting." }
 require File.expand_path('../../lib/sunzi',__FILE__)
 Sunzi::Cli.start

data/lib/sunzi.rb

@@ -1,7 +1,16 @@
 LIB_PATH = File.join(File.dirname(__FILE__), 'sunzi')
 
+require 'thor'
+require 'yaml'
+
 module Sunzi
-  autoload :Base,       File.join(LIB_PATH, 'base')
   autoload :Cli,        File.join(LIB_PATH, 'cli')
+  autoload :Dependency, File.join(LIB_PATH, 'dependency')
   autoload :Version,    File.join(LIB_PATH, 'version')
+
+  module Cloud
+    autoload :Base,     File.join(LIB_PATH, 'cloud', 'base')
+    autoload :Linode,   File.join(LIB_PATH, 'cloud', 'linode')
+    autoload :EC2,      File.join(LIB_PATH, 'cloud', 'ec2')
+  end
 end

data/lib/sunzi/cli.rb

@@ -1,6 +1,3 @@
-require 'thor'
-require 'yaml'
-require 'fileutils'
 require 'open3'
 
 module Sunzi
@@ -23,9 +20,9 @@ module Sunzi
       empty_directory project
       empty_directory "#{project}/remote"
       empty_directory "#{project}/remote/recipes"
-      template "templates/sunzi.yml",                 "#{project}/sunzi.yml"
-      template "templates/remote/install.sh",         "#{project}/remote/install.sh"
-      template "templates/remote/recipes/ssh_key.sh", "#{project}/remote/recipes/ssh_key.sh"
+      template "templates/create/sunzi.yml",                 "#{project}/sunzi.yml"
+      template "templates/create/remote/install.sh",         "#{project}/remote/install.sh"
+      template "templates/create/remote/recipes/ssh_key.sh", "#{project}/remote/recipes/ssh_key.sh"
     end
 
     desc "deploy example.com (or user@example.com:2222)", "Deploy sunzi project"
@@ -87,6 +84,16 @@ module Sunzi
       end
     end
 
+    desc "setup [linode|ec2]", "Setup a new VM"
+    def setup(target)
+      Cloud::Base.choose(target).setup
+    end
+
+    desc "teardown [linode|ec2] [name]", "Teardown an existing VM"
+    def teardown(target, name)
+      Cloud::Base.choose(target).teardown(name)
+    end
+
     no_tasks do
       def parse_target(target)
         target.match(/(.*@)?(.*?)(:.*)?$/)

data/lib/sunzi/cloud/base.rb

@@ -0,0 +1,38 @@
+Sunzi::Dependency.load('highline')
+
+module Sunzi
+  module Cloud
+    class Base < Thor
+      include Thor::Actions
+
+      class << self
+        def source_root
+          File.expand_path('../../../',__FILE__)
+        end
+
+        def choose(target)
+          case target
+          when 'linode'
+            Cloud::Linode.new
+          when 'ec2'
+            Cloud::EC2.new
+          else
+            say shell.set_color("#{target} is not valid!", :red, true)
+            abort
+          end
+        end
+      end
+
+      def initialize(*args)
+        @ui = HighLine.new
+        super
+      end
+
+      no_tasks do
+        def ask(question, answer_type, &details)
+          @ui.ask(@ui.color(question, :green, :bold), answer_type, &details)
+        end
+      end
+    end
+  end
+end

data/lib/sunzi/cloud/ec2.rb

@@ -0,0 +1,15 @@
+module Sunzi
+  module Cloud
+    class EC2 < Base
+      no_tasks do
+        def setup
+          say shell.set_color('EC2 is not implemented yet!', :red, true)
+        end
+
+        def teardown(target)
+          say shell.set_color('EC2 is not implemented yet!', :red, true)
+        end
+      end
+    end
+  end
+end

data/lib/sunzi/cloud/linode.rb

@@ -0,0 +1,248 @@
+Sunzi::Dependency.load('linode')
+
+# Workaround the bug: https://github.com/rick/linode/issues/12
+YAML::ENGINE.yamler = 'syck'
+
+module Sunzi
+  module Cloud
+    class Linode < Base
+      no_tasks do
+
+        def setup
+          # Only run for the first time
+          unless File.exist? 'linode/linode.yml'
+            empty_directory 'linode'
+            empty_directory 'linode/instances'
+            template 'templates/setup/linode/linode.yml', 'linode/linode.yml'
+            say shell.set_color('Now go ahead and edit linode.yml, then run this command again!', :green, true)
+            abort
+          end
+
+          @config = YAML.load(File.read('linode/linode.yml'))
+
+          if @config['fqdn']['zone'] == 'example.com'
+            say shell.set_color('You must have your own settings in linode.yml', :red, true)
+            abort
+          end
+
+          # When route53 is specified for DNS, check if it's properly configured and if not, fail earlier.
+          setup_route53 if @config['dns'] == 'route53'
+
+          @ui = HighLine.new
+
+          @sshkey = File.read(File.expand_path(@config['root_sshkey_path'])).chomp
+          if @sshkey.match(/\n/)
+            say shell.set_color("RootSSHKey #{@sshkey.inspect} must not be multi-line! Check inside \"#{@config['root_sshkey_path']}\"", :red, true)
+            abort
+          end
+
+          # Ask environment and hostname
+          @env = ask("environment? (#{@config['environments'].join(' / ')}): ", String) {|q| q.in = @config['environments'] }.to_s
+          @host = ask('hostname? (only the last part of subdomain): ', String).to_s
+
+          @fqdn = @config['fqdn'][@env].gsub(/%{host}/, @host)
+          @label = @config['label'][@env].gsub(/%{host}/, @host)
+          @group = @config['group'][@env]
+          @api = ::Linode.new(:api_key => @config['api_key'])
+
+          # Choose a plan
+          result = @api.avail.linodeplans
+          result.each{|i| say "#{i.planid}: #{i.ram}MB, $#{i.price}" }
+          @planid = ask('which plan?: ', Integer) {|q| q.in = result.map(&:planid); q.default = result.first.planid }
+          @plan_label = result.find{|i| i.planid == @planid }.label
+
+          # Choose a datacenter
+          result = @api.avail.datacenters
+          result.each{|i| say "#{i.datacenterid}: #{i.location}" }
+          @datacenterid = ask('which datacenter?: ', Integer) {|q| q.in = result.map(&:datacenterid); q.default = result.first.datacenterid }
+          @datacenter_location = result.find{|i| i.datacenterid == @datacenterid }.location
+
+          # Choose a distribution
+          result = @api.avail.distributions
+          if @config['distributions_filter']
+            result = result.select{|i| i.label.match Regexp.new(@config['distributions_filter'], Regexp::IGNORECASE) }
+          end
+          result.each{|i| say "#{i.distributionid}: #{i.label}" }
+          @distributionid = ask('which distribution?: ', Integer) {|q| q.in = result.map(&:distributionid); q.default = result.first.distributionid }
+          @distribution_label = result.find{|i| i.distributionid == @distributionid }.label
+
+          # Choose a kernel
+          result = @api.avail.kernels
+          if @config['kernels_filter']
+            result = result.select{|i| i.label.match Regexp.new(@config['kernels_filter'], Regexp::IGNORECASE) }
+          end
+          result.each{|i| say "#{i.kernelid}: #{i.label}" }
+          @kernelid = ask('which kernel?: ', Integer) {|q| q.in = result.map(&:kernelid); q.default = result.first.kernelid }
+          @kernel_label = result.find{|i| i.kernelid == @kernelid }.label
+
+          # Choose swap size
+          @swap_size = ask('swap size in MB? (default: 256MB): ', Integer) { |q| q.default = 256 }
+
+          # Go ahead?
+          moveon = ask("Are you sure to go ahead and create #{@fqdn}? (y/n) ", String) {|q| q.in = ['y','n']}
+          exit unless moveon == 'y'
+
+          # Create
+          say "creating a new linode..."
+          result = @api.linode.create(:DatacenterID => @datacenterid, :PlanID => @planid, :PaymentTerm => @config['payment_term'])
+          @linodeid = result.linodeid
+          say "created a new instance: linodeid = #{@linodeid}"
+
+          result = @api.linode.list.select{|i| i.linodeid == @linodeid }.first
+          @totalhd = result.totalhd
+
+          # Update settings
+          say "Updating settings..."
+          result = @api.linode.update(
+            :LinodeID => @linodeid,
+            :Label => @label,
+            :lpm_displayGroup => @group,
+            # :Alert_cpu_threshold => 90,
+            # :Alert_diskio_threshold => 1000,
+            # :Alert_bwin_threshold => 5,
+            # :Alert_bwout_threshold => 5,
+            # :Alert_bwquota_threshold => 80,
+          )
+
+          # Create a root disk
+          say "Creating a root disk..."
+          result = @api.linode.disk.createfromdistribution(
+            :LinodeID => @linodeid,
+            :DistributionID => @distributionid,
+            :Label => "#{@distribution_label} Image",
+            :Size => @totalhd - @swap_size,
+            :rootPass => @config['root_pass'],
+            :rootSSHKey => @sshkey
+          )
+          @root_diskid = result.diskid
+
+          # Create a swap disk
+          say "Creating a swap disk..."
+          result = @api.linode.disk.create(
+            :LinodeID => @linodeid,
+            :Label => "#{@swap_size}MB Swap Image",
+            :Type => 'swap',
+            :Size => @swap_size
+          )
+          @swap_diskid = result.diskid
+
+          # Create a config profiile
+          say "Creating a config profile..."
+          result = @api.linode.config.create(
+            :LinodeID => @linodeid,
+            :KernelID => @kernelid,
+            :Label => "#{@distribution_label} Profile",
+            :DiskList => [ @root_diskid, @swap_diskid ].join(',')
+          )
+          @config_id = result.configid
+
+          # Add a private IP
+          say "Adding a private IP..."
+          result = @api.linode.ip.list(:LinodeID => @linodeid)
+          @public_ip = result.first.ipaddress
+          result = @api.linode.ip.addprivate(:LinodeID => @linodeid)
+          result = @api.linode.ip.list(:LinodeID => @linodeid).find{|i| i.ispublic == 0 }
+          @private_ip = result.ipaddress
+
+          # Register IP to DNS
+          case @config['dns']
+          when 'linode'
+            # Set the public IP to Linode DNS Manager
+            say "Setting the public IP to Linode DNS Manager..."
+            @domainid = @api.domain.list.find{|i| i.domain == @config['fqdn']['zone'] }.domainid
+            @api.domain.resource.create(:DomainID => @domainid, :Type => 'A', :Name => @fqdn, :Target => @public_ip)
+          when 'route53'
+            # Set the public IP to AWS Route 53
+            say "Setting the public IP to AWS Route 53..."
+            Route53::DNSRecord.new(@fqdn, "A", "300", [@public_ip], @route53_zone).create
+          end
+
+          # Boot
+          say shell.set_color("Done. Booting...", :green, true)
+          @api.linode.boot(:LinodeID => @linodeid)
+
+          hash = {
+            :linode_id => @linodeid,
+            :env => @env,
+            :host => @host,
+            :fqdn => @fqdn,
+            :label => @label,
+            :group => @group,
+            :plan_id => @planid,
+            :datacenter_id => @datacenterid,
+            :datacenter_location => @datacenter_location,
+            :distribution_id => @distributionid,
+            :distribution_label => @distribution_label,
+            :kernel_id => @kernelid,
+            :kernel_label => @kernel_label,
+            :swap_size => @swap_size,
+            :totalhd => @totalhd,
+            :root_diskid => @root_diskid,
+            :swap_diskid => @swap_diskid,
+            :config_id => @config_id,
+            :public_ip => @public_ip,
+            :private_ip => @private_ip,
+          }
+
+          File.open("linode/instances/#{@label}.yml",'w') do |file|
+            file.write YAML.dump(hash)
+          end
+        end
+
+        def teardown(name)
+          unless File.exist?("linode/instances/#{name}.yml")
+            say shell.set_color("#{name}.yml was not found in the instances directory.", :red, true)
+            abort
+          end
+          @config = YAML.load(File.read('linode/linode.yml'))
+          setup_route53 if @config['dns'] == 'route53'
+
+          @instance = YAML.load(File.read("linode/instances/#{name}.yml"))
+          @api = ::Linode.new(:api_key => @config['api_key'])
+
+          # Shutdown first or disk deletion will fail
+          say shell.set_color("shutting down...", :green, true)
+          @api.linode.shutdown(:LinodeID => @instance[:linode_id])
+          sleep 10
+
+          # Delete the disks. It is required - http://www.linode.com/api/linode/linode%2Edelete
+          say shell.set_color("deleting root disk...", :green, true)
+          @api.linode.disk.delete(:LinodeID => @instance[:linode_id], :DiskID => @instance[:root_diskid]) rescue nil
+          say shell.set_color("deleting swap disk...", :green, true)
+          @api.linode.disk.delete(:LinodeID => @instance[:linode_id], :DiskID => @instance[:swap_diskid]) rescue nil
+          sleep 5
+
+          # Delete the instance
+          say shell.set_color("deleting linode...", :green, true)
+          @api.linode.delete(:LinodeID => @instance[:linode_id])
+
+          # Delete DNS record
+          case @config['dns']
+          when 'linode'
+            # Set the public IP to Linode DNS Manager
+            say "deleting the public IP to Linode DNS Manager..."
+            @domainid = @api.domain.list.find{|i| i.domain == @config['fqdn']['zone'] }.domainid
+            @resource = @api.domain.resource.list(:DomainID => @domainid).find{|i| i.target == @instance[:public_ip] }
+            @api.domain.resource.delete(:DomainID => @domainid, :ResourceID => @resource.resourceid)
+          when 'route53'
+            # Set the public IP to AWS Route 53
+            say "deleting the public IP to AWS Route 53..."
+            @record = @route53_zone.get_records.find{|i| i.values.first == @instance[:public_ip] }
+            @record.delete
+          end
+
+          # Remove the instance config file
+          remove_file "linode/instances/#{name}.yml"
+
+          say shell.set_color("Done.", :green, true)
+        end
+
+        def setup_route53
+          Sunzi::Dependency.load('route53')
+          route53 = Route53::Connection.new(@config['route53']['key'], @config['route53']['secret'])
+          @route53_zone = route53.get_zones.find{|i| i.name.sub(/\.$/,'') == @config['fqdn']['zone'] }
+        end
+      end
+    end
+  end
+end

data/lib/sunzi/dependency.rb

@@ -0,0 +1,38 @@
+module Sunzi
+  class Dependency
+    def self.all
+      {
+        'linode' => {
+          :require => 'linode',
+          :version => '>= 0.7.7',
+        },
+        'highline' => {
+          :require => 'highline',
+          :version => '>= 1.6.11',
+        },
+        'route53' => {
+          :require => 'route53',
+          :version => '>= 0.2.1',
+        },
+      }
+    end
+
+    def self.load(name)
+      begin
+        gem(name, all[name][:version])
+        require(all[name][:require])
+      rescue LoadError
+        puts <<-EOS
+Dependency missing: #{name}
+To install the gem, issue the following command:
+
+    gem install #{name} -v '#{all[name][:version]}'
+
+Please try again after installing the missing dependency.
+        EOS
+        exit 1
+      end
+    end
+
+  end
+end

data/lib/sunzi/version.rb

@@ -1,3 +1,3 @@
 module Sunzi
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/templates/setup/linode/linode.yml

@@ -0,0 +1,34 @@
+---
+api_key: your_api_key
+root_pass: your_root_password
+root_sshkey_path: ~/.ssh/id_rsa.pub
+
+# payment_term must be 1, 12 or 24
+payment_term: 1
+
+# Add / remove environments
+environments:
+  - production
+  - staging
+fqdn:
+  zone: example.com
+  production: %{host}.example.com
+  staging: %{host}.staging.example.com
+label:
+  production: example-%{host}
+  staging: example-staging-%{host}
+group:
+  production: example
+  staging: example-staging
+
+# Filter out large lists by keyword
+distributions_filter: debian
+kernels_filter: latest
+
+# dns takes either "linode" or "route53"
+dns: linode
+
+# only used when route53 is chosen for DNS
+route53:
+  key: your_aws_key
+  secret: your_aws_secret

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunzi
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-25 00:00:00.000000000 Z
+date: 2012-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2152751900 !ruby/object:Gem::Requirement
+  requirement: &2156460860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152751900
+  version_requirements: *2156460860
 description: Server provisioning utility for minimalists
 email:
 - kenn.ejima@gmail.com
@@ -36,12 +36,16 @@ files:
 - Rakefile
 - bin/sunzi
 - lib/sunzi.rb
-- lib/sunzi/base.rb
 - lib/sunzi/cli.rb
+- lib/sunzi/cloud/base.rb
+- lib/sunzi/cloud/ec2.rb
+- lib/sunzi/cloud/linode.rb
+- lib/sunzi/dependency.rb
 - lib/sunzi/version.rb
-- lib/templates/remote/install.sh
-- lib/templates/remote/recipes/ssh_key.sh
-- lib/templates/sunzi.yml
+- lib/templates/create/remote/install.sh
+- lib/templates/create/remote/recipes/ssh_key.sh
+- lib/templates/create/sunzi.yml
+- lib/templates/setup/linode/linode.yml
 - sunzi.gemspec
 - test/test_cli.rb
 homepage: http://github.com/kenn/sunzi

data/lib/sunzi/base.rb

@@ -1,9 +0,0 @@
-require 'yaml'
-
-module Sunzi
-  class Base
-    def initialize(project)
-      # Do something
-    end
-  end
-end