README.md in opskeleton-0.0.2 vs README.md in opskeleton-0.0.4

- old
+ new

@@ -1,20 +1,47 @@ -Intro -========== -Opskelaton is an opinionated bootstrap tool for local sandboxes project that uses/creates: +<img src="https://raw.github.com/narkisr/vagrant-sketching-board/master/images/opskeleton.png" width='100%' hight='100%' alt="" /> - * A vagrant file matching OS - * RVM (creates an .rvmrc with a matching gemset) - * bundler (with dependencies defined) - * librarian-puppet for puppet module depdency managment - * basic folder strucuture ( - * static-module for currently developed modules and modules for imported ones - * run.sh (for simple running of puppet within the sandbox) - * License and README +# Intro +Opskelaton is an opinionated bootstrap tool for local Sandbox projects. + +Opsk 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 seperation between developed and depdendant code. + * No clear development guidelines, for example extracting general modules and exporting them. + + +See it in action [here](https://www.youtube.com/watch?v=LNlHC54Ej8c). + Usage ========= ```bash $ opsk generate name box-type ``` + + +## 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="" /> + + +## 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 reside under module 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="" /> + +