kibo 0.1.2 → 0.3.0

data/man/kibo.1.html

@@ -63,8 +63,10 @@
     <a href="#SYNOPSIS">SYNOPSIS</a>
     <a href="#DESCRIPTION">DESCRIPTION</a>
     <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#INSTANCE-PROVISIONING">INSTANCE PROVISIONING</a>
     <a href="#GLOBAL-OPTIONS">GLOBAL OPTIONS</a>
     <a href="#Kibofile">Kibofile</a>
+    <a href="#Example-session">Example session</a>
     <a href="#COPYRIGHT">COPYRIGHT</a>
   </div>
 
@@ -85,41 +87,83 @@
 <code>kibo [options] deploy</code><br />
 <code>kibo [options] spinup</code><br />
 <code>kibo [options] spindown</code><br />
-<code>kibo [options] reconfigure</code></p>
+<code>kibo [options] reconfigure</code><br />
+<code>kibo [options] generate</code></p>
 
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
 
-<p>kibo is an awesome program that does something very, very important.</p>
+<p>kibo manages multiple application roles on single heroku dynos.</p>
 
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
 
-<p>Foreman is a manager for Procfile-based applications. Its aim is to
-abstract away the details of the Procfile format, and allow you to either run
-your application directly or export it to some other process management
-format.</p>
+<p>Kibo is a perfect addition to Procfile based deployment on heroku.com.
+While heroku itself provides adequate tools to manage a single application
+on multiple dynos, Kibo adds tools to manage multiple application roles
+on single dynos with automatic instance provisioning.</p>
+
+<p>The application roles are read from the Procfile (see <span class="man-ref">foreman<span class="s">(1)</span></span>).
+The concurrency options - i.e. the number of applications to run
+each role - is read from the Kibofile.</p>
+
+<h2 id="INSTANCE-PROVISIONING">INSTANCE PROVISIONING</h2>
+
+<p>Each instance gets automatically configured using `heroku config. kibo
+sets the environment variables INSTANCE, RAILS_ENV and RACK_ENV to reflect
+instance role and number and runtime environment.</p>
+
+<pre><code>INSTANCE="kibo-staging-web1"
+RAILS_ENV="staging"
+RACK_ENV="staging"
+</code></pre>
 
 <h2 id="GLOBAL-OPTIONS">GLOBAL OPTIONS</h2>
 
 <p>The following options control how kibo is run:</p>
 
 <dl>
-<dt><code>-e</code>, <code>--environment</code></dt><dd><p>Set the target environment.</p></dd>
-<dt><code>-k</code>, <code>--kibofile</code></dt><dd><p>Specify the Kibofile to use.</p></dd>
-<dt><code>-p</code>, <code>--procfile</code></dt><dd><p>Specify an alternate Procfile to load.</p></dd>
+<dt><code>-e</code>, <code>--environment</code></dt><dd><p>Set the target environment. Defaults to "staging"</p></dd>
+<dt><code>-k</code>, <code>--kibofile</code></dt><dd><p>Specify an alternate Kibofile to use.</p></dd>
+<dt><code>-p</code>, <code>--procfile</code></dt><dd><p>Specify an alternate Procfile to use.</p></dd>
 </dl>
 
 
 <h2 id="Kibofile">Kibofile</h2>
 
-<p>An example Kibofile is this:</p>
-
-<pre><code>defaults:
-    procfile: Procfile
-    namespace: radiospiel
-staging:
-    twirl: 1
+<p>A Kibofile scaffold can be generated via <code>kibo generate</code>. The following is an example:</p>
+
+<pre><code>kibo:
+  # The email of the heroku account to create app instances on heroku.
+  heroku: user@domain.com
+  # You instances will be called 'kiboex-staging-web0', 'kiboex-production-worker0', etc.
+  namespace: kibo
+defaults:
+  procfile: Procfile.other
+  web: 1
+  worker: 1
 production:
-    twirl: 2
+  web: 1
+  worker: 2
+</code></pre>
+
+<p>This defines the roles "web" and "worker", which are running at one resp. two instances in
+the "production" environment.</p>
+
+<h2 id="Example-session">Example session</h2>
+
+<p>This is a session using the example Kibofile from above:</p>
+
+<pre><code># creates the heroku applications "kibo-production-web1",  
+# "kibo-production-worker1", and "kibo-production-worker2". 
+kibo -e production create 
+
+# deploy all applications.
+kibo -e production deploy 
+
+# start all instances
+kibo -e production spinup
+
+# stop all instances
+kibo -e production spindown 
 </code></pre>
 
 <h2 id="COPYRIGHT">COPYRIGHT</h2>
@@ -128,8 +172,8 @@ production:
 
 
   <ol class='man-decor man-foot man foot'>
-    <li class='tl'>Kibo 0.1.2</li>
-    <li class='tc'>August 2012</li>
+    <li class='tl'>Kibo 0.3.0</li>
+    <li class='tc'>September 2012</li>
     <li class='tr'>kibo(1)</li>
   </ol>
 

data/man/kibo.1.markdown

@@ -7,46 +7,84 @@ kibo(1) -- manage heroku applications
 `kibo [options] deploy`<br>
 `kibo [options] spinup`<br>
 `kibo [options] spindown`<br>
-`kibo [options] reconfigure`
+`kibo [options] reconfigure`<br>
+`kibo [options] generate`
 
 ## DESCRIPTION
 
-kibo is an awesome program that does something very, very important.
+kibo manages multiple application roles on single heroku dynos.
 
 ## DESCRIPTION
 
-Foreman is a manager for Procfile-based applications. Its aim is to
-abstract away the details of the Procfile format, and allow you to either run
-your application directly or export it to some other process management
-format.
+Kibo is a perfect addition to Procfile based deployment on heroku.com.
+While heroku itself provides adequate tools to manage a single application
+on multiple dynos, Kibo adds tools to manage multiple application roles 
+on single dynos with automatic instance provisioning.
 
-## GLOBAL OPTIONS
+The application roles are read from the Procfile (see foreman(1)). 
+The concurrency options - i.e. the number of applications to run
+each role - is read from the Kibofile.
+
+## INSTANCE PROVISIONING
+
+Each instance gets automatically configured using `heroku config. kibo
+sets the environment variables INSTANCE, RAILS_ENV and RACK_ENV to reflect
+instance role and number and runtime environment.
 
+    INSTANCE="kibo-staging-web1"
+    RAILS_ENV="staging"
+    RACK_ENV="staging"
+
+## GLOBAL OPTIONS
 
 The following options control how kibo is run:
 
   * `-e`, `--environment`:
-    Set the target environment.
+    Set the target environment. Defaults to "staging"
 
   * `-k`, `--kibofile`:
-    Specify the Kibofile to use.
+    Specify an alternate Kibofile to use.
 
   * `-p`, `--procfile`:
-    Specify an alternate Procfile to load.
-
+    Specify an alternate Procfile to use.
 
 ## Kibofile
 
-An example Kibofile is this:
+A Kibofile scaffold can be generated via `kibo generate`. The following is an example:
 
+    kibo:
+      # The email of the heroku account to create app instances on heroku.
+      heroku: user@domain.com
+      # You instances will be called 'kiboex-staging-web0', 'kiboex-production-worker0', etc.
+      namespace: kibo
     defaults:
-        procfile: Procfile
-        namespace: radiospiel
-    staging:
-        twirl: 1
+      procfile: Procfile.other
+      web: 1
+      worker: 1
     production:
-        twirl: 2
+      web: 1
+      worker: 2
+
+This defines the roles "web" and "worker", which are running at one resp. two instances in
+the "production" environment.  
+
+## Example session
+
+This is a session using the example Kibofile from above:
+
+    # creates the heroku applications "kibo-production-web1",  
+    # "kibo-production-worker1", and "kibo-production-worker2". 
+    kibo -e production create 
+
+    # deploy all applications.
+    kibo -e production deploy 
 
+    # start all instances
+    kibo -e production spinup
+    
+    # stop all instances
+    kibo -e production spindown 
+    
 ## COPYRIGHT
 
 Kibo is Copyright (C) 2012 Enrico Thierbach <http://radiospiel.org>
@@ -55,8 +93,10 @@ Kibo is Copyright (C) 2012 Enrico Thierbach <http://radiospiel.org>
 [SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
 [DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
 [DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
+[INSTANCE PROVISIONING]: #INSTANCE-PROVISIONING "INSTANCE PROVISIONING"
 [GLOBAL OPTIONS]: #GLOBAL-OPTIONS "GLOBAL OPTIONS"
 [Kibofile]: #Kibofile "Kibofile"
+[Example session]: #Example-session "Example session"
 [COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
 
 

data/man/kibo.1.ronn

@@ -7,46 +7,84 @@ kibo(1) -- manage heroku applications
 `kibo [options] deploy`<br>
 `kibo [options] spinup`<br>
 `kibo [options] spindown`<br>
-`kibo [options] reconfigure`
+`kibo [options] reconfigure`<br>
+`kibo [options] generate`
 
 ## DESCRIPTION
 
-kibo is an awesome program that does something very, very important.
+kibo manages multiple application roles on single heroku dynos.
 
 ## DESCRIPTION
 
-Foreman is a manager for Procfile-based applications. Its aim is to
-abstract away the details of the Procfile format, and allow you to either run
-your application directly or export it to some other process management
-format.
+Kibo is a perfect addition to Procfile based deployment on heroku.com.
+While heroku itself provides adequate tools to manage a single application
+on multiple dynos, Kibo adds tools to manage multiple application roles 
+on single dynos with automatic instance provisioning.
 
-## GLOBAL OPTIONS
+The application roles are read from the Procfile (see foreman(1)). 
+The concurrency options - i.e. the number of applications to run
+each role - is read from the Kibofile.
+
+## INSTANCE PROVISIONING
+
+Each instance gets automatically configured using `heroku config. kibo
+sets the environment variables INSTANCE, RAILS_ENV and RACK_ENV to reflect
+instance role and number and runtime environment.
 
+    INSTANCE="kibo-staging-web1"
+    RAILS_ENV="staging"
+    RACK_ENV="staging"
+
+## GLOBAL OPTIONS
 
 The following options control how kibo is run:
 
   * `-e`, `--environment`:
-    Set the target environment.
+    Set the target environment. Defaults to "staging"
 
   * `-k`, `--kibofile`:
-    Specify the Kibofile to use.
+    Specify an alternate Kibofile to use.
 
   * `-p`, `--procfile`:
-    Specify an alternate Procfile to load.
-
+    Specify an alternate Procfile to use.
 
 ## Kibofile
 
-An example Kibofile is this:
+A Kibofile scaffold can be generated via `kibo generate`. The following is an example:
 
+    kibo:
+      # The email of the heroku account to create app instances on heroku.
+      heroku: user@domain.com
+      # You instances will be called 'kiboex-staging-web0', 'kiboex-production-worker0', etc.
+      namespace: kibo
     defaults:
-        procfile: Procfile
-        namespace: radiospiel
-    staging:
-        twirl: 1
+      procfile: Procfile.other
+      web: 1
+      worker: 1
     production:
-        twirl: 2
+      web: 1
+      worker: 2
+
+This defines the roles "web" and "worker", which are running at one resp. two instances in
+the "production" environment.  
+
+## Example session
+
+This is a session using the example Kibofile from above:
+
+    # creates the heroku applications "kibo-production-web1",  
+    # "kibo-production-worker1", and "kibo-production-worker2". 
+    kibo -e production create 
+
+    # deploy all applications.
+    kibo -e production deploy 
 
+    # start all instances
+    kibo -e production spinup
+    
+    # stop all instances
+    kibo -e production spindown 
+    
 ## COPYRIGHT
 
 Kibo is Copyright (C) 2012 Enrico Thierbach <http://radiospiel.org>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kibo
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: heroku
+  name: trollop
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: trollop
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: heroku
   requirement: !ruby/object:Gem::Requirement
@@ -85,13 +101,26 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - bin/kibo
 - kibo.gemspec
 - lib/kibo.rb
+- lib/kibo/bin/yuicompressor-2.4.7.jar
 - lib/kibo/commandline.rb
+- lib/kibo/commands.rb
+- lib/kibo/commands/compress.rb
+- lib/kibo/commands/create.rb
+- lib/kibo/commands/deploy.rb
+- lib/kibo/commands/generate.rb
+- lib/kibo/commands/info.rb
+- lib/kibo/commands/reconfigure.rb
+- lib/kibo/commands/spin.rb
 - lib/kibo/config.rb
+- lib/kibo/helpers.rb
+- lib/kibo/helpers/heroku.rb
+- lib/kibo/helpers/info.rb
 - lib/kibo/log.rb
 - lib/kibo/system.rb
 - lib/kibo/version.rb
@@ -114,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1679562379441555646
+      hash: -678042025039138496
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: