README.md in testlab-0.9.1 vs README.md in testlab-1.0.0

- old
+ new

@@ -2,15 +2,21 @@ [![Dependency Status](https://gemnasium.com/zpatten/testlab.png)](https://gemnasium.com/zpatten/testlab) [![Build Status](https://secure.travis-ci.org/zpatten/testlab.png)](http://travis-ci.org/zpatten/testlab) [![Coverage Status](https://coveralls.io/repos/zpatten/testlab/badge.png?branch=master)](https://coveralls.io/r/zpatten/testlab) [![Code Climate](https://codeclimate.com/github/zpatten/testlab.png)](https://codeclimate.com/github/zpatten/testlab) +# A Quick Note on Versioning + +I attempt to keep TestLab in line with Semantic Versioning when incrementing version numbers. I am human so I may screw this up on, hopefully rare, occasion. Semantic Versioning is delicious and everyone should be following this schema, especially when it comes to Ruby Gems which have a habit of pushing your projects into "dependency hell". + +* http://semver.org/ + # TestLab A toolkit for building virtual computer labs. -What is TestLab? TestLab lets you iterate virtual infrastructure quickly. Using a `Labfile` you can define how you want your virtual infrastructure laid out. You can define multiple network segments and containers (i.e. boxen). TestLab will then setup and tear down this virtual infrastructure as you have dictated in the `Labfile`. +What is TestLab? TestLab lets you iterate virtual infrastructure quickly. Using a `Labfile` you can define how you want your virtual infrastructure laid out. You can define multiple network segments and containers (i.e. boxen). TestLab will then build and demolish this virtual infrastructure as you have dictated in the `Labfile`. TestLab can also import and export containers, making it easy to share them. TestLab supports the latest LXC versions, allowing for ephemeral cloning operations, furthering your ability to iterate quickly. TestLab can be used for many other applications, including infrastructure unit and integration testing, allowing for vastly more complex configurations and more effective resource sharing than traditional VM solutions. TestLab can be run via the command-line or can be interfaced with directly via Ruby code. @@ -24,35 +30,35 @@ SYNOPSIS tl [global options] command [command options] [arguments...] VERSION - 0.8.1 + 0.9.1 GLOBAL OPTIONS -l, --labfile=path/to/file - Path to Labfile: ${REPO}/Labfile (default: none) - -r, --repo=path/to/directory - Path to Repository directory: ${PWD} (default: /home/zpatten/code/personal/testlab-repo) + -r, --repo=path/to/directory - Path to Repository directory: ${PWD} (default: /home/zpatten/code/chef-repo) -c, --config=path/to/directory - Path to Configuration directory: ${REPO}/.testlab-$(hostname -s) (default: none) --version - Display the program version -v, --[no-]verbose - Show verbose output -q, --[no-]quiet - Quiet mode --help - Show this message COMMANDS - help - Shows a list of commands or help for one command - container - Manage lab containers - network - Manage lab networks - node - Manage lab nodes - create - Create the lab components - destroy - Destroy the lab components - up - On-line the lab components - down - Off-line the lab components - setup - Provision the lab components - teardown - De-provision the lab components - build - Build the lab - demolish - Demolish the lab - status - Display the lab status + help - Shows a list of commands or help for one command + container - Manage lab containers + network - Manage lab networks + node - Manage lab nodes + create - Create the lab components + destroy - Destroy the lab components + up - On-line the lab components + down - Off-line the lab components + provision - Provision the lab components + deprovision - De-provision the lab components + build - Build the lab + demolish - Demolish the lab + status - Display the lab status You stand up your lab with the following command: tl build @@ -105,12 +111,12 @@ You can individually online, offline, create or destroy containers: tl container down -n server-www-1 tl container up -n server-www-1 - tl container setup -n server-www-1 - tl container teardown -n server-www-1 + tl container provision -n server-www-1 + tl container deprovision -n server-www-1 You can recycle a container, effectively destroying then creating it again, provisioning it back to a "pristine" condition. tl container recycle -n server-www-1 @@ -157,12 +163,12 @@ We can even recycle it while it is in a cloned state: $ tl container recycle -n server-www-1 -We can run setup against a clone as well (note: running `build`, calls `up`, which would revert us back to a non-cloned container and we would not want this to happen): +We can run provision against a clone as well (note: running `build`, calls `up`, which would revert us back to a non-cloned container and we would not want this to happen): - $ tl container setup -n server-www-1 + $ tl container provision -n server-www-1 ## Network Routes TestLab will add network routes for any networks defined in the `Labfile` witch have the `TestLab::Provisioner::Route` provisioner class specified for them. This will allow you to directly interact with containers over the network. Here is an example of the routes added with the multi-network `Labfile`.