hazetug 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6c00796640e6ece747e594b00ba9920a6eb274c
-  data.tar.gz: b4547334fbbf7886ec879ec28973741eda037ae0
+  metadata.gz: 5cd75f4fabfcaaeae0bd462bdbb4548bd75c5cc0
+  data.tar.gz: 4179c6ff8d922ca64274ff15a43d76ac595c7ad0
 SHA512:
-  metadata.gz: c2fb703a1956871aae50be4bc4e4d4c8482b1dca282a01b6693f157f01c8eae04194d95d3a0b829aaa3c590d9ca24cd7ac905325ce2e17880389b136393da865
-  data.tar.gz: 6cde17df0db9ceafc66365aaaec3872a8d03f90f9c17323b1a1198b64433c23559659f1af2c3500e8b126f1807e7a03893ae4f48b9dde163bbd39ef4950f378f
+  metadata.gz: 6cd3762608a28281c7403f9916097378b154ca75514b71ece5d228af8b776d3bdf8346705d06adfdd739cc2f03d96a0f1f436d3f5fcd260daadf394c4447d630
+  data.tar.gz: b47dda53a33e5260082d73de1133beb462c1ec540af8651d5d81e7afc1674195c5fc8e75eccc0a23caf6bfcbe850f809c36a8fcb13e187b167e767a35de7e20e

data/README.md

@@ -1,12 +1,22 @@
 # Hazetug
 
-Cloud provisioner and bootstrapper for DigitalOcean and Linode.
-Hazetug uses [fog cloud library](http://fog.io) to be able to easily append other cloud computes and *tugs* (bootstraps) hosts using:
+Cloud provisioner and bootstraper which simplifies node creation and configuration deployment. Hazetug uses simple YAML task file which describes the configuration to setup.
 
-* Knife bootstrap for chef-client.
-* Knife bootstrap for chef-solo.
+Provisioning is handled by *haze* core which is based on [fog cloud library](http://fog.io). A plenty of different cloud computes available in fog (*AWS*, *Rackspace*, *BareMetalCloud* and many more) helps to extend hazetug with the new *"hazes"* quite simple.
 
-## Options
+Bootstrapping is done by *"tugs"*, hazetug supports only a few tugs just for Chef now.
+
+## Supported cloud computes
+
+- Linode
+- DigitalOcean
+
+## Supported bootstrap methods
+
+- **knife** - chef knife bootstrap method.
+- **solo**  - same as *knife* bootstrap, but it also uses [berkshelf](http://berkshelf.com) to package and upload cookbooks to a provisioned node, thus makes it possible usage of *chef-solo*.
+
+## Task file options
 
 ### Cloud Computes specific options
 
@@ -21,7 +31,7 @@ Hazetug uses [fog cloud library](http://fog.io) to be able to easily append othe
     </tr>
     <tr>
         <td><b><i>location</i></b></td>
-        <td>Location in the cloud compute, namely data center.</td>
+        <td>Location in a cloud compute, namely data center.</td>
     </tr>
     <tr>
         <td><b><i>flavor</i></b></td>
@@ -43,7 +53,7 @@ Hazetug uses [fog cloud library](http://fog.io) to be able to easily append othe
     </tr>
     <tr>
         <td><b><i>ssh_user</i></b></td>
-        <td>User used to during provisioning and for connecting via ssh.</td>
+        <td>User used during provisioning and bootstrapping for connecting via ssh.</td>
         <td><i>root</i><td>
     </tr>
     <tr>
@@ -96,6 +106,11 @@ Hazetug uses [fog cloud library](http://fog.io) to be able to easily append othe
         <td><b>Description</b></td>
         <td><b>Default value</b></td>
     </tr>
+    <tr>
+        <td><b><i>chef_environment</i></b></td>
+        <td>Chef Environment used during bootstrap</td>
+        <td></td>
+    </tr>
     <tr>
         <td><b><i>attributes</i></b></td>
         <td>Hash of attributes prepared for chef-solo run. (It's merged with the run_list).</td>
@@ -104,16 +119,29 @@ Hazetug uses [fog cloud library](http://fog.io) to be able to easily append othe
     <tr>
         <td><b><i>berksfile</i></b></td>
         <td>Path to Berksfile.</td>
-        <td></td>
+        <td><i>./Berksfile</i></td>
     </tr>
 </table>
 
+## Configuration
+
+### Variables priority
+
+Hazetug uses 3-level priority for flexible variable choosing. Priority in the ascending order is the following: variable from the global section -> variable set via command option -> variable in the bootstrap list entity.
+All variables are merged using this 3-level priority.
+
+### Tug bootstrap templates
+
+*Knife* and *solo* tugs use ruby ERB bootstrap template file which is basically a shell script performing initial bootstrap phase. Namely performing OS update and system package installation, bootstrapping ruby and chef.
+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
     gem 'hazetug'
+    # use master until version grater than 1.23.0 is released
+    gem 'fog', git: 'https://github.com/fog/fog.git'
 
 And then execute:
 
@@ -125,7 +153,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Configuration file
+### 1. Create ~/.hazetug configuration file
 
 Create *~/.hazetug* configuration file, with the content like:
 
@@ -140,9 +168,12 @@ default:
     - ~/.ssh/digitalocean.pem (Change with your path)
 ```
 
-### Tasks
+### 2. Define task
 
-Hazetug bootstrap task file is yaml file as well, it consists of two sections **global** and **bootstrap**. Global section sets default variables used by hazetug, each bootstraped host from bootstrap list sets variables specific to it thus redefining global defaults. Let's have a look at a sample task file:
+Hazetug YAML task file consists of two sections **global** and **bootstrap**. Global section sets default variables used by hazetug and bootstrap section is basically a list of nodes to be provisioned and to be bootstrapped.
+Each bootstrap entity includes *haze specification* (name, location, flavor  and image) as well as it defines node specific variables.
+
+Let's have a look at a sample task file:
 
 ```
 chef_server_url: 'https://mychefserver.uri'
@@ -159,78 +190,83 @@ bootstrap:
     run_list: ["role[api]"]
 ```
 
-From the example above we can see various variables used by hazetug they are common for all bootstrapped nodes, that's why it's reasonable to locate them in the global. However each variable has three layer hierarchy more details look into the [Variables Priority](README.md#variables-priority) section.
+This simple configuration is supposed to bring 6 nodes in the Cloud and bootstrap the with *knife* tug.
 
-### Variables priority
+Also it's worth mentioning the variables priority look into the [Variables Priority](README.md#variables-priority) section.
 
-Hazetug uses 3-level priority for flexible variable choosing. Priority in the ascending order is the following: variable from the global section -> variable set via command option -> variable in the bootstrap list entity.
-All variables are merged using this 3-level priority.
+### 3. Create bootstrap template file
+
+Use one of the bootstrap templates provided in the *examples* directory or create yours.
 
+### 4. Run hazetug
 
-### Command Line and Invocation
+`bundle exec hazetug digitalocean bootstrap knife -b bootstrap.erb task.yaml`
 
-### Bootstrap using knife
+## Command line and invocation
 
-Help for the linode compute is given bellow:
+### Tug with chef-client and chef-solo (knife bootstrap)
+
+Let's first have a look at command line help, issue the following command: `hazetug help digitalocean bootstrap knife`, and this will show you:
 
 ```
 NAME
-    knife - Bootstraps server using Knife
+    bootstrap - Provisions and bootstraps server
 
 SYNOPSIS
-    hazetug.rb [global options] linode bootstrap knife [command options] task.yaml
+    hazetug [global options] digitalocean bootstrap [command options] knife <task.yaml>
+    hazetug [global options] digitalocean bootstrap [command options] solo <task.yaml>
 
 COMMAND OPTIONS
     -v, --variables=arg   - Set variable or comma-seperated list of variables (var1_1=hello) (default: none)
     -n, --number=arg      - Set number of created nodes, value from yaml is honored (default: 1)
     -c, --concurrency=arg - Set concurrency value, i.e. number of hosts bootstraped simultaneously (default: 1)
     -b, --bootstrap=arg   - Set path to knife bootstrap.erb file (default: bootstrap.erb)
+
+COMMANDS
+    knife - Bootstraps server using Knife in client mode
+    solo  - Bootstraps server using Knife in solo mode
 ```
 
-All variables are passed to the bootstrap template and are available using the hazetug hash like - `hazetug[:variable_name]`. Amongst variables described here in the options sections, hazetug also passes useful variables such as ***compute_name***, ***public_ip_address***, ***private_ip_address*** if those are available.
+Concurrency and number are used to control hazetug provision and bootstrap flow. When we create 20 identical nodes we might want to process say it 4 nodes simultaneously, so we will use `-n 20 -c 4` on the command line. 
+
+Variables are useful to define some parameter for hazetug, providing a variable on command line will redefine the corresponding variable in global section. So it's useful to specify something like: `-v chef_version=11.16.0.rc.0,ruby_version=2.1.2`.
+
+#### Variables available in bootstrap template
 
-#### Client and Solo modes
+Variables are merged and passed by tug into bootstrap template, use *hasetug[:variable]* to look up a value. For a example to get *chef_version* or *node location* it will be easy as this:
 
-It's possible to use *chef-client* or *chef-solo* to bootstrap a node. The **solo** mode is almost identical with the **client** mode, but with the only difference that it uses **berkshelf** to assist during the bootstrap process. Cookbooks are packaged and uploaded to the remote node and can be used by chef
+```
+<%= hazetug[:chef_version] %>
+<%= hazetug[:location] %>
+```
 
-You can initiate bootstrap in the solo mode, like the following:
-<pre>
-hazetug digitalocean bootstrap solo -b bootstrap.erb solo-task.yaml
-</pre>
+While all the variables you've specified on command line and inside YAML task file are being merged and are available there are other dynamic values which might be useful as well:
 
-Solo bootstrap also uses bootstrap.erb, but there's no need to start client or use any data like **validation_key** or **start_chef** helper.
+- compute_name
+- public_ip_address
+- private_ip_address
+- ssh_password
 
-When defining a task, there additional options **berksfile** and **attributes**
 
-```yaml
-...
-...
-bootstrap:
-  - name: solo-box
-    location: london
-    flavor:   1gb
-    image:    ubuntu-14.04-x64
-    run_list: ["role[api]"]
-    attributes: {
-      "mycookbook": {
-        "settings": {}
-      }
-    }
-```
+#### knife and solo tugs difference
+
+They both use knife bootstrap, but *knife* is supposed to run chef-client while *solo* to run chef-solo. Also they use a little bit different options look at the [Task file options](README.md#task-file-options) section.
+For more information on the bootstrap process have a look into *examples* directory.
 
-Merged *attributes* with the *run_list* form the input data for running **chef-solo** they are available inside bootstrap.erb as `hazetug[:attributes_json]`. Berksfile can be set specifically  in the bootstrap task list or if it's not set local *Berksfile* is tried by default.
+More details about *solo* tug should be also given here. An important difference that *solo* tug is assisted by berkshelf to create and upload cookbooks package that makes possible **chef-solo** invocation. In the *examples* there's the line starting chef-solo:
+`chef-solo -j /etc/chef/first-boot.json -r <%= hazetug[:cookbooks_file] %>`
 
-Another important option which is also available in the *bootstrap.erb* file is `hazetug[:cookbooks_path]` which is path to an archive of cookbooks packaged by Berkshelf.
+Another note is about *run_list* and *attributes*, just mention that *run_list* is merged into *attributes* and available as `hazetug[:attributes_json]` inside the bootstrap template.
 
-#### Examples
+#### Invocation examples
 
 * Provisioning and bootstrapping 5 nodes, each 3 of them will be processed simultaneously:
   
-  `hazetug digitalocean bootstrap knife -n 5 -c 3 -b api.erb api-task.yaml`
+  `bundle exec hazetug digitalocean bootstrap knife -n 5 -c 3 -b api.erb api-task.yaml`
   
 * Redefining validation_key and chef_version:
   
-  `hazetug digitalocean bootstrap knife -v validation_key=/tmp/validation.pem,chef_version=11.12.4 api.erb api-task.yaml`
+  `bundle hazetug digitalocean bootstrap knife -v validation_key=/tmp/validation.pem,chef_version=11.12.4 api.erb api-task.yaml`
 
 ## Contributing
 

data/lib/hazetug/tug/knife.rb

@@ -6,7 +6,7 @@ class Hazetug
   class Tug
     class Knife < KnifeBase
 
-      def initialize(config={}, haze=nil)
+      def initialize(config={})
         super
         [ :chef_server_url,
           :validation_key

data/lib/hazetug/version.rb

@@ -1,3 +1,3 @@
 class Hazetug
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hazetug
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Denis Barishev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler