sunzi 0.1.0 → 0.2.0

data/README.md

@@ -11,9 +11,10 @@ Sunzi assumes that Linux distributions have (mostly) sane defaults.
 
 Its design goals are:
 
-* A big-bang overwriting with loads of custom configurations makes it difficult to know **what you are actually doing** - instead, Sunzi let you keep track of as little diff from default as possible.
-* No mysterious Ruby DSL involved. Sunzi recipes are written in a plain shell script. Why? Because, most of the information about server configuration you get on the web is written in a set of shell commands. Why should you translate it into a proprietary DSL, rather than just copy-paste?
-* No configuration server. No dependency. You don't even need a Ruby runtime on the remote server.
+* **Single shell script.** A big-bang overwriting with loads of custom configurations makes it difficult to know **what you are actually doing** - instead, Sunzi let you keep track of as little diff from default as possible.
+* **No mysterious Ruby DSL involved.** Sunzi recipes are written in a plain shell script. Why? Because, most of the information about server configuration you get on the web is written in a set of shell commands. Why should you translate it into a proprietary DSL, rather than just copy-paste?
+* **Minimum dependencies.** No configuration server required. You don't even need a Ruby runtime on the remote server.
+* **Always use the root user.** Think twice before blindly assuming you need a regular user - it doesn't add any security benefit for server provisioning, it just adds extra verbosity for nothing. However, it doesn't mean that you shouldn't create regular users with Sunzi - feel free to write your own recipes.
 
 Quickstart
 ----------
@@ -41,16 +42,17 @@ Now, what it actually does is:
 
 As you can see, what you need to do is edit `install.sh` and add some shell commands. That's it.
 
-Tutorial
---------
+Directory structure
+-------------------
 
 Here's the directory structure that `sunzi create` automatically generates:
 
 ```
 sunzi/
-  attributes.yml    ---- add custom variables here
+  attributes.yml    ---- add custom attributes here
+  recipes.yml       ---- add remote recipes here
   remote/           ---- everything under this folder will be transferred to the remote server
-    attributes/     ---- compiled from attributes.yml at deploy
+    attributes/     ---- compiled attributes from attributes.yml at deploy (do not edit directly)
       env
       ssh_key
     recipes/        ---- put commonly used scripts here, referred from install.sh
@@ -58,12 +60,23 @@ sunzi/
     install.sh      ---- main scripts that gets run on the remote server
 ```
 
+Remote Recipes
+--------------
+
+Recipes can be retrieved remotely via HTTP. Put the URL in `recipes.yml`, and Sunzi automatically loads the content and put it into the `remote/recipes` folder.
+
+For instance, if you have the following line in `recipes.yml`,
+
+```
+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`.
+
 Vagrant
 -------
 
-If you're using Sunzi with [Vagrant](http://vagrantup.com/), make sure you allowed SSH access for root.
-
-Since it uses port 2222 for SSH, you need to specify the port number:
+If you're using Sunzi with [Vagrant](http://vagrantup.com/), you need to specify the port number 2222.
 
     $ vagrant up
     $ sunzi deploy root@localhost 2222

data/lib/sunzi/cli.rb

@@ -15,36 +15,28 @@ module Sunzi
       end
     end
 
-    map "c" => :create
-    map "d" => :deploy
+    # map "cr" => :create
+    # map "d" => :deploy
 
-    desc "create [PROJECT]", "Create sunzi project (Shortcut: c)"
+    desc "create [PROJECT]", "Create sunzi project"
     def create(project = 'sunzi')
       empty_directory project
       empty_directory "#{project}/remote"
       empty_directory "#{project}/remote/recipes"
       template "templates/attributes.yml",            "#{project}/attributes.yml"
+      template "templates/recipes.yml",               "#{project}/recipes.yml"
       template "templates/remote/install.sh",         "#{project}/remote/install.sh"
       template "templates/remote/recipes/ssh_key.sh", "#{project}/remote/recipes/ssh_key.sh"
     end
 
-    desc "deploy [USER@HOST] [PORT]", "Deploy sunzi project (Shortcut: d)"
+    desc "deploy [USER@HOST] [PORT]", "Deploy sunzi project"
     def deploy(*target)
       if target.empty? or !target.first.match(/@/)
-        puts "Usage: sunzi deploy root@example.com"
+        say shell.set_color("Usage: sunzi deploy root@example.com", :red, true)
         abort
       end
 
-      # Compile attributes.yml
-      unless File.exists?('attributes.yml')
-        puts "You must be in the sunzi folder"
-        abort
-      end
-      hash = YAML.load(File.read('attributes.yml'))
-      FileUtils.mkdir_p('remote/attributes')
-      hash.each do |key, value|
-        File.open("remote/attributes/#{key}", 'w'){|file| file.write(value) }
-      end
+      compile
 
       host, port = target
       port ||= 22
@@ -75,5 +67,27 @@ module Sunzi
       end
     end
 
+    desc "compile", "Compile sunzi project"
+    def compile
+      # Check if you're in the sunzi directory
+      unless File.exists?('attributes.yml')
+        say shell.set_color("You must be in the sunzi folder", :red, true)
+        abort
+      end
+
+      # Compile attributes.yml
+      hash = YAML.load(File.read('attributes.yml'))
+      empty_directory 'remote/attributes'
+      hash.each do |key, value|
+        File.open("remote/attributes/#{key}", 'w'){|file| file.write(value) }
+      end
+
+      # Compile recipes.yml
+      hash = YAML.load(File.read('recipes.yml'))
+      empty_directory 'remote/recipes'
+      hash.each do |key, value|
+        get value, "remote/recipes/#{key}.sh"
+      end
+    end
   end
 end

data/lib/sunzi/version.rb

@@ -1,3 +1,3 @@
 module Sunzi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/sunzi.rb

@@ -3,6 +3,5 @@ LIB_PATH = File.join(File.dirname(__FILE__), 'sunzi')
 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')
 end

data/lib/templates/recipes.yml

@@ -0,0 +1,2 @@
+--- # Remote recipes here will be loaded to individual files in remote/recipes.
+rvm: https://raw.github.com/kenn/sunzi-recipes/master/ruby/rvm.sh

data/lib/templates/remote/install.sh

@@ -6,3 +6,6 @@ source recipes/ssh_key.sh $(cat attributes/ssh_key)
 # Update apt catalog
 aptitude update
 aptitude -y safe-upgrade
+
+# Install RVM - rvm.sh will be retrieved from Github in the compile phase
+source recipes/rvm.sh

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunzi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2160735500 !ruby/object:Gem::Requirement
+  requirement: &2156394360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160735500
+  version_requirements: *2156394360
 description: Server provisioning tool for minimalists
 email:
 - kenn.ejima@gmail.com
@@ -40,6 +40,7 @@ files:
 - lib/sunzi/cli.rb
 - lib/sunzi/version.rb
 - lib/templates/attributes.yml
+- lib/templates/recipes.yml
 - lib/templates/remote/install.sh
 - lib/templates/remote/recipes/ssh_key.sh
 - sunzi.gemspec