opskeleton 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e92301580b01d64a5808cde6aff9bed738e8636a
-  data.tar.gz: 13f78f354879a24e20afdcb1b83b57c3dc0e7a0f
+  metadata.gz: 010f9793ae61094386bd62cbcb6057adc43fe3cf
+  data.tar.gz: ef76043ada71b082876516f259ff04c33421920d
 SHA512:
-  metadata.gz: 18a912f6f0d0a3f2a0e879a9ffee8cdb7bb0969ed85bed0d21a8487e4ff1aacf324f81b6485dc7f4cc20130735b05254d815e5230c25cd00acf093abe3420c72
-  data.tar.gz: 782d5321bd5a211d63ddcf5f3fb23d4112160956837448c0bc4e3aaec69cf52f291d0bd2b81a51a9cb933fa33398a5ca6c736cedbe1c0ff8439a185ce681fb09
+  metadata.gz: 0bf99b01016136f1bbc83e619f0732d970e4705c3f4a6189e201cfbfb26469f8f376a2a6331a977cd91f234529408822f2fdf211dbf6af662afac2eef4f89068
+  data.tar.gz: 32d147a5964d0718b00c618fc6873845f973f5c55d628c55db27151ef11befa4ff22581d1916b7c5ba6ea48448bff1829d35be7c44760e5d2bcf2c3b2e089a13

data/README.md

@@ -4,24 +4,27 @@
 
 Opskelaton is an opinionated bootstrap tool for local Sandbox projects.
 
-Opsk aims to solve the following common issues:
+Opskeleton aims to solve the following common issues:
  * Devops develop Puppet modules on master machines which results with 'It works on my (machine) master' approach.
  * Implicit/Missing dependencies, like ruby version used, operating system, gems, third party puppet module
  * Manual steps in setting up puppet modules and local sandboxes (like installing third party code).
  * Non standard layout, projects missing README and LICENSE files, no clear separation between developed and dependant code.
  * No clear development guidelines, for example extracting general modules and exporting them.
  
+Opskeleton comes to solve these issues by introducing a decentralized development workflow with pre-defined layout, packaging and dependency management.
 
 See it in action [here](https://www.youtube.com/watch?v=LNlHC54Ej8c).
 
 [![Build Status](https://travis-ci.org/opskeleton/opskeleton.png)](https://travis-ci.org/opskeleton/opskeleton)
 
-Usage
-=========
+
+# Usage
+
+## Installation
 
 Perquisites (on Ubuntu):
 
-* Vagrant 1.4.x
+* Vagrant 1.6.x
 * RVM
 * Ruby 1.9.x
 
@@ -30,131 +33,9 @@ Perquisites (on Ubuntu):
  $ sudo gem install opskeleton
 ``` 
 
-Creating out first sandbox
-
-```bash
- $ rvm use system 
- # parameters include name vagrant-box
- $ opsk generate_puppet redis ubuntu-13.10
- $ cd redis-sandbox
- $ bundle install 
- $ librarian-puppet install 
- $ vagrant up 
-```
-
-## Layout
-
-Opskelaton creates the complete folder structure fine tuned to match best practices:
-
-Folder layout:
-
-<img src="https://raw.github.com/narkisr/vagrant-sketching-board/master/images/opsk-folders.png" width='30%' hight='50%'  alt="" />
-
-
-## Module lifecycle
-
-Opskelaton defines a simple module life cycle:
-
- 1. Internal non reusable modules (usually specific to a client site) go under static-modules
- 2. If we create a general reusable module which is ready for prime time we pull out to a new git repository.
- 3. The extracted module is added back as a third party (using [librarian-puppet](https://github.com/rodjek/librarian-puppet) module which resides under modules folder.
-
-Life cycle scheme:
-
-<img src="https://raw.github.com/narkisr/vagrant-sketching-board/master/images/module-lifecycle-black.png" width='30%' hight='50%'  alt="" />
-
-Creating new (static) modules is easy as:
-
-```bash
-$ opsk module foo
-```
-
-Each generated module will contain puppet-rspec with matching Rakefile (see [testing](https://github.com/opskeleton/opskeleton#testing)).
-
-## Testing
-
-Opskelaton supports two levels of testing:
-
-* Static module testing that includes rspec and linting.
-* Integration testing using [serverspec](http://serverspec.org/) and Vagrant.
-
-```bash
-# linting all static modules
-$ rake lint
-# rspecing 
-$ rake modspec
-# running serverspec
-$ rake spec
-```
-
-## Packaging 
-Opskelaton fully supports deployment and portable execution of sandboxes on non Vagrant environments:
-
-```bash
-$ opsk generate_puppet foo ubuntu-13.10
-$ cd foo-sandbox
-# The package version file
-$ cat opsk.yaml
---- 
-  version: '0.0.1'
-  name: foo
-
-# post bundle and gem install ..
-$ opsk package
-      create  pkg/foo-sandbox-0.0.1
-      create  pkg/foo-sandbox-0.0.1/scripts
-      create  pkg/foo-sandbox-0.0.1/scripts/lookup.rb
-       chmod  pkg/foo-sandbox-0.0.1/scripts/lookup.rb
-      create  pkg/foo-sandbox-0.0.1/scripts/run.sh
-       chmod  pkg/foo-sandbox-0.0.1/scripts/run.sh
-      create  pkg/foo-sandbox-0.0.1/manifests/site.pp
-       exist  pkg
-$ ls pkg
-foo-sandbox-0.0.1  foo-sandbox-0.0.1.tar.gz
-```
-The packaging process creates a portable tar file that can be run on any machine with puppet installed via the bundled run.sh:
-
-```bash 
-$ tar -xvzf foo-sandbox-0.0.1.tar.gz
-$ cd foo-sandbox-0.0.1 
-$ sudo ./run.sh
-```
-
-An external node classifier based runner is also available under scripts/run.sh, this runner expects to get a <hostname>.yaml input file with the required node classes.
-
-
-## Deployment
-
-The packaged tar files can be consumed using any tool and protocol however http is recommended, opsk has built in support for deploying public sandboxes into bintray:
-
-```bash 
-$ opsk package
-$ opsk deploy <bintray-repo>
-deployed foo-sandbox-0.0.1.tar.gz to http://dl.bintray.com/narkisr/<bintray-repo>/foo-sandbox-0.0.1.tar.gz
-```
-
-Make sure to  [configure](https://github.com/narkisr/bintray-deploy#usage) configure the bintray API key.
-
-## Updating
-Keeping you box up to date with latest opsk version is easy, just re-generate it again and resolve conflicts by answering y/n:
-```bash
-# Moving to latest opsk
-$ gem update opskeleton
-# foo box already exists
-$ opsk generate foo <vagrant-box>
- exist  foo-sandbox
-    conflict  foo-sandbox/Vagrantfile
-Overwrite /home/ronen/code/foo-sandbox/Vagrantfile? (enter "h" for help) [Ynaqdh]
-```
-
-## Vagrant
-Opskeleton generates a Vagrant file with couple of enhancements:
- 
-* VAGRANT_BRIDGE (default eth0) for setting up public bridge on the go.
-* PUPPET_ENV (default dev) for setting puppet environment.
-* Puppet options preset to match modules and hiera folders.
+Now Follow either [Chef](chef.md) or [Puppet](puppet.md).
 
-## Boxes
+# Boxes
 Opskeleton recommends the use of [box-cutter](https://github.com/box-cutter) in order to create Vagrant boxes in a consistent manner (as no free hosting solution currently exist):
 ```bash
 # make sure to have latest packer

data/chef.md

@@ -0,0 +1,136 @@
+# Intro
+
+Opskelaton fully supports chef based sandboxes with the same lifecycle semantics 
+
+it offers similar features to the Puppet based sandboxes with additional support for roles, environments and cookbooks.
+
+# Usage
+
+Creating out first sandbox
+
+```bash
+$ opsk generate_chef redis ubuntu-14.04
+$ cd redis-sandbox
+```
+
+## Layout
+
+Opskelaton creates the complete folder structure fine tuned to match best practices:
+
+Folder layout:
+
+<!-- <img src="https://raw.github.com/narkisr/vagrant&#45;sketching&#45;board/master/images/opsk&#45;folders.png" width='30%' hight='50%'  alt="" /> -->
+
+
+## Cookbook lifecycle
+
+Opskelaton defines a simple cookbook life cycle:
+
+ 1. Internal non reusable cookbooks (usually specific to a client site) go under static-cookbooks
+ 2. If we create a general reusable cookbook which is ready for prime time we pull out to a new git repository.
+ 3. The extracted cookbook is added back as a third party (using [librarian-chef](https://github.com/applicationsonline/librarian-chef) cookbook which resides under modules folder.
+
+Life cycle scheme:
+
+<img src="https://raw.github.com/narkisr/vagrant-sketching-board/master/images/module-lifecycle-black.png" width='30%' hight='50%'  alt="" />
+
+Creating new (cookbooks) modules is easy as:
+
+```bash
+$ opsk cookbook foo
+```
+
+## Testing
+
+Opskelaton supports testing/linting:
+
+* Static cookbook testing that includes rspec and food-critic. (TBD)
+* Integration testing using [serverspec](http://serverspec.org/) and Vagrant.
+
+```bash
+# running serverspec
+$ rake spec
+```
+
+## Packaging 
+Opskelaton fully supports deployment and portable execution of sandboxes on non Vagrant environments:
+
+```bash
+$ opsk generate_chef foo ubuntu-14.04.
+$ cd foo-sandbox
+# The package version file
+$ cat opsk.yaml
+
+--- 
+  version: '0.0.1'
+  name: redis
+  includes: 
+    - Cheffile
+    - cookbooks
+    - static-cookbooks
+    - dna.json
+    - environments
+    - Gemfile
+    - Gemfile.lock
+    - opsk.yaml
+    - roles
+    - LICENSE-2.0.txt
+    - run.sh
+    - boot.sh
+    - solo.rb
+
+# post bundle and gem install ..
+$ opsk package
+	create  pkg/foo-sandbox-0.0.1
+	create  pkg/foo-sandbox-0.0.1/scripts
+	create  pkg/foo-sandbox-0.0.1/scripts/lookup.rb
+	 chmod  pkg/foo-sandbox-0.0.1/scripts/lookup.rb
+	create  pkg/foo-sandbox-0.0.1/scripts/run.sh
+	 chmod  pkg/foo-sandbox-0.0.1/scripts/run.sh
+	 exist  pkg
+$ ls pkg
+foo-sandbox-0.0.1  foo-sandbox-0.0.1.tar.gz
+```
+The packaging process creates a portable tar file that can be run on any machine with chef-solo installed via the bundled run.sh:
+
+```bash 
+$ tar -xvzf foo-sandbox-0.0.1.tar.gz
+$ cd foo-sandbox-0.0.1 
+# expects to get the chef environment
+$ sudo ./run.sh dev
+```
+
+
+## Deployment
+
+The packaged tar files can be consumed using any tool and protocol however http is recommended, opsk has built in support for deploying public sandboxes into bintray:
+
+```bash 
+$ opsk package
+$ opsk deploy <bintray-repo>
+deployed foo-sandbox-0.0.1.tar.gz to http://dl.bintray.com/narkisr/<bintray-repo>/foo-sandbox-0.0.1.tar.gz
+```
+
+Make sure to  [configure](https://github.com/narkisr/bintray-deploy#usage) configure the bintray API key.
+
+## Updating
+
+Keeping you box up to date with latest opsk version is easy, just re-generate it again and resolve conflicts by answering y/n:
+```bash
+# Moving to latest opsk
+$ gem update opskeleton
+# foo box already exists
+$ opsk generate_chef foo <vagrant-box>
+ exist  foo-sandbox
+    conflict  foo-sandbox/Vagrantfile
+Overwrite /home/ronen/code/foo-sandbox/Vagrantfile? (enter "h" for help) [Ynaqdh]
+```
+
+## Vagrant
+Opskeleton generates a Vagrant file with couple of enhancements:
+ 
+* CHEF_ENV (default dev) for setting chef environment.
+* Default role (sandbox name) created under roles/{type}.rb
+* static-cookbooks/cookbooks roles/environments folders are set.
+
+

data/lib/opskeleton/generate_puppet.rb

@@ -24,7 +24,7 @@ module Opsk
     end
 
     def create_gemfile
-	copy_file('templates/gemfile', "#{path}/Gemfile")
+	copy_file('templates/puppet/gemfile', "#{path}/Gemfile")
     end
 
     def create_rakefile

data/lib/opskeleton/version.rb

@@ -1,3 +1,3 @@
 module Opskeleton
-  VERSION = '0.6.5'
+  VERSION = '0.6.6'
 end

data/puppet.md

@@ -0,0 +1,125 @@
+# Intro
+
+Opskelaton fully supports Puppet based sandboxes with the same lifecycle semantics as Chef.
+
+# Usage
+
+Creating out first sandbox
+
+```bash
+$ opsk generate_puppet redis ubuntu-14.04
+$ cd redis-sandbox
+```
+
+## Layout
+
+Opskelaton creates the complete folder structure fine tuned to match best practices:
+
+Folder layout:
+
+<img src="https://raw.github.com/narkisr/vagrant-sketching-board/master/images/opsk-folders.png" width='30%' hight='50%'  alt="" />
+
+
+## Module lifecycle
+
+Opskelaton defines a simple module life cycle:
+
+ 1. Internal non reusable modules (usually specific to a client site) go under static-modules
+ 2. If we create a general reusable module which is ready for prime time we pull out to a new git repository.
+ 3. The extracted module is added back as a third party (using [librarian-puppet](https://github.com/rodjek/librarian-puppet) module which resides under modules folder.
+
+Life cycle scheme:
+
+<img src="https://raw.github.com/narkisr/vagrant-sketching-board/master/images/module-lifecycle-black.png" width='30%' hight='50%'  alt="" />
+
+Creating new (static) modules is easy as:
+
+```bash
+$ opsk module foo
+```
+
+Each generated module will contain puppet-rspec with matching Rakefile (see [testing](https://github.com/opskeleton/opskeleton#testing)).
+
+## Testing
+
+Opskelaton supports two levels of testing:
+
+* Static module testing that includes rspec and linting.
+* Integration testing using [serverspec](http://serverspec.org/) and Vagrant.
+
+```bash
+# linting all static modules
+$ rake lint
+# rspecing 
+$ rake modspec
+# running serverspec
+$ rake spec
+```
+
+## Packaging 
+Opskelaton fully supports deployment and portable execution of sandboxes on non Vagrant environments:
+
+```bash
+$ opsk generate_puppet foo ubuntu-13.10
+$ cd foo-sandbox
+# The package version file
+$ cat opsk.yaml
+--- 
+  version: '0.0.1'
+  name: foo
+
+# post bundle and gem install ..
+$ opsk package
+      create  pkg/foo-sandbox-0.0.1
+      create  pkg/foo-sandbox-0.0.1/scripts
+      create  pkg/foo-sandbox-0.0.1/scripts/lookup.rb
+       chmod  pkg/foo-sandbox-0.0.1/scripts/lookup.rb
+      create  pkg/foo-sandbox-0.0.1/scripts/run.sh
+       chmod  pkg/foo-sandbox-0.0.1/scripts/run.sh
+      create  pkg/foo-sandbox-0.0.1/manifests/site.pp
+       exist  pkg
+$ ls pkg
+foo-sandbox-0.0.1  foo-sandbox-0.0.1.tar.gz
+```
+The packaging process creates a portable tar file that can be run on any machine with puppet installed via the bundled run.sh:
+
+```bash 
+$ tar -xvzf foo-sandbox-0.0.1.tar.gz
+$ cd foo-sandbox-0.0.1 
+$ sudo ./run.sh
+```
+
+An external node classifier based runner is also available under scripts/run.sh, this runner expects to get a <hostname>.yaml input file with the required node classes.
+
+
+## Deployment
+
+The packaged tar files can be consumed using any tool and protocol however http is recommended, opsk has built in support for deploying public sandboxes into bintray:
+
+```bash 
+$ opsk package
+$ opsk deploy <bintray-repo>
+deployed foo-sandbox-0.0.1.tar.gz to http://dl.bintray.com/narkisr/<bintray-repo>/foo-sandbox-0.0.1.tar.gz
+```
+
+Make sure to  [configure](https://github.com/narkisr/bintray-deploy#usage) configure the bintray API key.
+
+## Updating
+Keeping you box up to date with latest opsk version is easy, just re-generate it again and resolve conflicts by answering y/n:
+```bash
+# Moving to latest opsk
+$ gem update opskeleton
+# foo box already exists
+$ opsk generate foo <vagrant-box>
+ exist  foo-sandbox
+    conflict  foo-sandbox/Vagrantfile
+Overwrite /home/ronen/code/foo-sandbox/Vagrantfile? (enter "h" for help) [Ynaqdh]
+```
+
+## Vagrant
+Opskeleton generates a Vagrant file with couple of enhancements:
+ 
+* VAGRANT_BRIDGE (default eth0) for setting up public bridge on the go.
+* PUPPET_ENV (default dev) for setting puppet environment.
+* Puppet options preset to match modules and hiera folders.
+

data/templates/chef/gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gem 'chef'
 
 # testing
-gem 'serverspec'
+gem 'serverspec', '~> 1.14.0'
 gem 'test-kitchen'
 
 # build 

data/templates/chef/vagrant.erb

@@ -4,7 +4,7 @@ Vagrant.configure("2") do |config|
   config.vm.define :<%=name%> do |node|
     bridge = ENV['VAGRANT_BRIDGE']
     bridge ||= 'eth0'
-    env  = ENV['PUPPET_ENV']
+    env  = ENV['CHEF_ENV']
     env ||= 'dev'
 
     node.vm.box = '<%=box%>' <%if(options['box_url']) %>

data/templates/{gemfile → puppet/gemfile}

@@ -6,10 +6,10 @@ gem 'puppet'
 # testing
 gem 'rspec-puppet'
 gem 'puppetlabs_spec_helper', '>= 0.1.0'
+gem 'serverspec', '~> 1.14.0'
 
 # build 
 gem 'puppet-lint'
 gem 'rake'
 gem 'librarian-puppet'
 gem 'opskeleton'
-gem 'serverspec'

data/templates/puppet/opsk.yaml

@@ -4,6 +4,8 @@
   includes: 
     - Puppetfile
     - modules
+    - manifests
+    - hieradata
     - static-modules
     - Gemfile
     - Gemfile.lock

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opskeleton
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - narkisr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-24 00:00:00.000000000 Z
+date: 2014-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -130,6 +130,7 @@ files:
 - TODOS
 - autocomplete/opsk_bash_completion
 - bin/opsk
+- chef.md
 - lib/opskeleton.rb
 - lib/opskeleton/bump.rb
 - lib/opskeleton/clean.rb
@@ -142,6 +143,7 @@ files:
 - lib/opskeleton/thorable.rb
 - lib/opskeleton/version.rb
 - opskeleton.gemspec
+- puppet.md
 - templates/LICENSE-2.0.txt
 - templates/README.erb
 - templates/chef/Cheffile
@@ -158,7 +160,6 @@ files:
 - templates/chef/ubuntu_docker.erb
 - templates/chef/vagrant.erb
 - templates/clean.yaml
-- templates/gemfile
 - templates/gitignore
 - templates/hiera.yaml
 - templates/hiera_vagrant.yaml
@@ -170,6 +171,7 @@ files:
 - templates/puppet/Rakefile
 - templates/puppet/boot.sh
 - templates/puppet/default.erb
+- templates/puppet/gemfile
 - templates/puppet/opsk.yaml
 - templates/puppet/run.sh
 - templates/puppet/scripts/lookup.rb