baptize 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGRmM2Y4ZGE4YWM1NTNjNWFjYWY1Y2Q3YjBiZGQ5ZDczOTIxMGZlOA==
+    YjA0ODY3NjU4YjIzMzRkZjA1NjY5OTExY2YwZDFkZjFjYjI2NTU1NQ==
   data.tar.gz: !binary |-
-    NWZhZGI1NDQ1YjdmZjg5NDY3N2M4OGE5ODY0M2NmYmRjYmY5M2EzNg==
+    MjcxM2RiMjVhNzYwMDY1MDdiMjI5OWEzZTc3ZWUxOGQwMzVmOGU4OQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MzRhMTc5NzI1ODA5MWJkOGFmZmE4YjJhZTQzMWUzODM1OTdiYmE3OTk1ZTFh
-    MTRmYjE0OTRmOTY2Mjc2YjBjZDhkMmYyODcxNzMzYjE5ZTdjZGM1MzdkZmQ0
-    NWIwNzViNGIwM2E3MTZhOGEyMDBlN2I5Yjc2NWE3OGEzYTQ5ZmM=
+    ZmYxMmMyN2Q1ZDU2ZmM1OWViMzYxYWQ4NzhkZmNmYzc2NTcxMGZhYjVlMjg1
+    ODAyMjg4NWI4OGE1ZTUxZDFmYjA3OTM0N2EwMDFjYTNlNTYwYzY4MjY5MTQ3
+    MWU0YjMxYmEzNTExMDkxNjY1ODJmMzUyZmVlODMwOGNlY2E2NGI=
   data.tar.gz: !binary |-
-    MDU4NTc0ZmE3NDhjODY4YTk0ODU1MGZkYzIwZTQ4Yjc5OTM2Y2U4ZWE2ZWZh
-    MTNmODVjYjNiMzA1ZDIxNWM5YWE2ZWRlZDI1NDdjZTg3YzZiYzVlZTQ5ZWJl
-    NTQ4MTFhYzE1YTU1MzNmOWE4YzFiOTExNjNlYmM0Y2E1YmU3MWY=
+    NmEzZGEzZTFlMWYyMjU0ODI0ODgyMzhlYzgyNDBiZmYxMGNkNDc1MGE0Zjkx
+    ODM2ZmZjYTBiYTA1OTM0ZWEwYjRmYjRlMjNiZjYwNWIwM2FlZGFhYTZlYjU4
+    YWVlNTMzNjE3MWNjOWVjOWM0ODQzMTNjNDMwYWRiZTY5NmUwZGY=

data/README.markdown

@@ -1,26 +1,135 @@
 Baptize
+===
+
+Baptize is an extension for Capistrano, that allows for server provisioning. The API resembles [Sprinkle](https://github.com/sprinkle-tool/sprinkle), but the underlying implementation is quite different. Where Sprinkle tries to compile a static payload of commands and push to the server, Baptize is executed in runtime. It also reuses much more of Capistrano, than Sprinkle does. Basically, each Baptize package is a capistrano task - Baptize just adds some helpers and fancy dsl on top, to make it look declarative.
+
+Be warned that Baptize is less than a week old at the time of this writing, and it has no test coverage - so it's probably riddled with bugs. That said, I do eat my own dog food, so it's at least somewhat functional.
+
+Setup
+---
+
+At some point, I'll probably wrap this procedure in a generator, but for now you'll have to do so manually.
+
+To get started, create a `Gemfile`:
+
+```ruby
+source 'https://rubygems.org'
+gem 'capistrano'
+gem 'baptize'
+```
+
+And a `Capfile`:
+
+```ruby
+require 'bundler'
+require 'capistrano'
+require 'baptize'
+set :capistrano_path, "#{root_path}/capistrano"
+set :assets_path, "#{capistrano_path}/assets"
+load_configuration :roles
+
+Dir.glob("#{capistrano_path}/packages/**/*.rb").each do |package|
+  load(package)
+end
+
+Dir.glob("#{capistrano_path}/recipes/**/*.rb").each do |recipe|
+  load(recipe)
+end
+```
+
+And a couple of folders and files:
+
+    ./capistrano/
+    ./capistrano/config/
+    ./capistrano/config/roles.rb               # Globally applied configuration. Define roles here.
+    ./capistrano/config/baptize.rb             # Contains config files used by baptize packages. Define policies here.
+    ./capistrano/packages/                     # Put package definitions in here.
+    ./capistrano/recipes/                      # Put regular capistrano tasks in here.
+    ./capistrano/assets/                       # Place auxiliary files here.
+
+And Finally, run the following command:
+
+    bundle
+
+Sample configuration
 ---
 
-Entirely undocumented for the time being.
+First define some roles, by opening up `config/roles.rb` - This is just regular Capistrano stuff. For example:
+
+```ruby
+role :server, "192.168.1.1"
+```
+
+Next define a policy for the server. Open up `config/baptize.rb` and put this:
 
-To install, run:
+```ruby
+policy :server do
+  requires :system_update
+end
+```
 
-    rake install
+This defines that the role `:server` needs a package `system_update`.
 
-A sample `Capfile` to get you started:
+You probably should define which login credentials to use as well:
 
-    require 'bundler'
-    require 'capistrano'
-    require 'baptize'
-    set :capistrano_path, "#{root_path}/capistrano"
-    set :assets_path, "#{capistrano_path}/assets"
-    load_configuration :roles
+```ruby
+# ssh login user
+set :user, 'ubuntu'
+# ssh key location
+ssh_options[:keys] = '~/.ssh/aws-key.pem'
+# run commands through sudo
+set :use_sudo, true
+```
 
-    Dir.glob("#{capistrano_path}/packages/**/*.rb").each do |package|
-      load(package)
-    end
+Note that since this is defined inside `config/baptize.rb`, it won't apply to capistrano recipes outside of baptize. The roles, on the other hand, is globally loaded (That happens in the `Capfile`).
 
-    Dir.glob("#{capistrano_path}/recipes/**/*.rb").each do |recipe|
-      load(recipe)
-    end
+Better create that packages then. Open up `packages/system_update.rb`:
+
+```ruby
+package :system_update do
+  description "System Update"
+  install do
+    run 'apt-get update -y'
+    run 'apt-get upgrade -y'
+  end
+end
+```
+
+This defines a package, that will upgrade the apt package manager of the target system.
+
+Deploying policies
+---
+
+You can now run the following command:
+
+    cap baptize
+
+Which should make capistrano ssh in to the `:server` role and try to update apt. It'll probably fail, unless you actually have a server running at that IP.
+
+If you want to just configure a single role, you can do so by running:
+
+    cap baptize:policies:server
+
+Using Baptize alongside Capistrano
+---
+
+If you also want to use Capistrano for regular application deployment (what it's actually ment for), you might want to create a file in `config/deploy.rb` to hold settings for this. E.g.:
+
+```ruby
+set :application, "set your application name here"
+set :repository,  "set your repository location here"
+```
+
+And to make sure it is loaded, modify your `Capfile` to include:
+
+```ruby
+load 'deploy'
+load 'deploy/assets' # For using Rails' asset pipeline
+before 'deploy' do
+  load_configuration :deploy
+end
+```
+
+---
 
+TODO: There is more to Baptize, but that'll have to wait for now.

data/lib/baptize/dsl.rb

@@ -120,6 +120,7 @@ module Capistrano
             policy.instance_eval &block
             namespace :baptize do
               namespace :policies do
+                desc "Configures #{policy.role}"
                 task policy.role do
                   logger.info "Applying policy #{policy.role}"
                   old_env_roles = ENV['ROLES']

data/lib/baptize/install.rb

@@ -24,32 +24,29 @@ module Capistrano
             install
           end
 
-          desc "Configures all available roles"
+          desc "Configures all available policies"
           task :install do ; end
 
-          desc "List configured roles"
-          task :roles do
-            load_configuration
-            result = []
-            logger.info "Configured roles:"
-            top.roles.each do |name,r|
-              logger.info "#{name} [" + r.servers.join(", ") + "]"
-            end
-          end
-
           namespace :policies do
-            desc "List configured policies"
+            desc "List available policies"
             task :default do
               load_configuration
-              logger.info "Configured policies:"
+              logger.info "Available policies:"
               tasks.flatten.each do |x|
                 if x.kind_of?(Capistrano::TaskDefinition) && x.fully_qualified_name != "baptize:policies"
                   name = x.fully_qualified_name.gsub(/^baptize:policies:/, "")
                   policy = Capistrano::Baptize::DSL.policies[name.to_sym]
-                  logger.info "#{name} [" + policy.dependencies.join(", ") + "]"
+                  logger.info "#{name}:"
+                  logger.info "->  servers:"
+                  top.roles[name.to_sym].servers.each do |s|
+                    logger.info "->    #{s}"
+                  end
+                  logger.info "->  dependencies:"
+                  policy.dependencies.each do |d|
+                    logger.info "->    #{d}"
+                  end
                 end
               end
-              # logger.info "Policies have been defined for roles: " + policies.join(", ")
             end
           end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: baptize
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Troels Knak-Nielsen