README.md in kitchen-linode-0.10.0 vs README.md in kitchen-linode-0.11.0
- old
+ new
@@ -1,34 +1,44 @@
# <a name="title"></a> Kitchen::Linode
+[](https://rubygems.org/gems/kitchen-linode)
+[](https://rubygems.org/gems/kitchen-linode)
+[](https://rubygems.org/gems/kitchen-linode)
+[](https://codeclimate.com/github/ssplatt/kitchen-linode)
+[](https://codeclimate.com/github/ssplatt/kitchen-linode/coverage)
+[](https://travis-ci.org/ssplatt/kitchen-linode)
-A Test Kitchen Driver for Linode.
+A Test Kitchen Driver for [Linode](http://www.linode.com).
+[](https://asciinema.org/a/44348)
+
## <a name="requirements"></a> Requirements
-**TODO:** document any software or library prerequisites that are required to
-use this driver. Implement the `#verify_dependencies` method in your Driver
-class to enforce these requirements in code, if possible.
+Requires [Test Kitchen](http://kitchen-ci.org) and a [Linode](http://www.linode.com) account.
+```
+gem install test-kitchen
+```
## <a name="installation"></a> Installation and Setup
-Install the gem file:
+The gem file is hosted at [RubyGems](https://rubygems.org/gems/kitchen-linode). To install the gem file, run:
```
gem install kitchen-linode
```
+Or, install with bundler if you have a Gemfile
Please read the [Driver usage][driver_usage] page for more details.
## <a name="config"></a> Configuration
For many of these, you can specify an ID number, a full name, or a partial name that will try to match something in the list but may not match exactly what you want.
```
LINODE_API_KEY Linode API Key environment variable, default: nil
-:username ssh user name, default: 'root'
+:username ssh user name, default: "root"
:password password for user, default: randomly generated hash
-:image Linux distribution, default: "Debian 8.1"
+:image Linux distribution, default: "Debian 8"
:data_center data center, default: "Atlanta"
:flavor linode type/amount of RAM, default: "Linode 1024"
-:payment_terms if you happen to have legacy default: 1
+:payment_terms if you happen to have legacy, default: 1
:kernel Linux kernel, default: "Latest 64 bit"
:private_key_path Location of your private key file, default: "~/.ssh/id_rsa"
:public_key_path Location of your public key file, default: "~/.ssh/id_rsa.pub"
:ssh_timeout ssh timeout, default: 600 (seconds)
:sudo use sudo, default: True
@@ -63,11 +73,11 @@
```
then you're ready to run `kitchen test` or `kitchen converge`
```
$ kitchen test
```
-If you want to create a second yaml config; one for using Vagrant locally but a second to use the Linode driver when run on your CI server, create a config with a name like `.kitchen-ci.yml`:
+If you want to create a second yaml config; one for using Vagrant locally but another to use the Linode driver when run on your CI server, create a config with a name like `.kitchen-ci.yml`:
```
---
driver:
name: linode
@@ -87,39 +97,23 @@
```
Then you can run the second config by changing the KITCHEN_YAML environment variable:
```
$ KITCHEN_YAML="./.kitchen-ci.yml" kitchen test
```
-If you want to change any of the default settings, you can do it in the 'platforms' area:
+If you want to change any of the default settings, you can do so in the 'platforms' area:
```
-...
+...<snip>...
platforms:
- name: debian_jessie
driver:
flavor: 2048
data_center: Dallas
kernel: 4.0.2-x86_64-linode56
image: Debian 7
-...
+...<snip>...
```
-### <a name="config-require-chef-omnibus"></a> require\_chef\_omnibus
-
-Determines whether or not a Chef [Omnibus package][chef_omnibus_dl] will be
-installed. There are several different behaviors available:
-
-* `true` - the latest release will be installed. Subsequent converges
- will skip re-installing if chef is present.
-* `latest` - the latest release will be installed. Subsequent converges
- will always re-install even if chef is present.
-* `<VERSION_STRING>` (ex: `10.24.0`) - the desired version string will
- be passed the the install.sh script. Subsequent converges will skip if
- the installed version and the desired version match.
-* `false` or `nil` - no chef is installed.
-
-The default value is unset, or `nil`.
-
## <a name="development"></a> Development
* Source hosted at [GitHub][repo]
* Report issues/questions/feature requests on [GitHub Issues][issues]
@@ -145,6 +139,5 @@
[author]: https://github.com/ssplatt
[issues]: https://github.com/ssplatt/kitchen-linode/issues
[license]: https://github.com/ssplatt/kitchen-linode/blob/master/LICENSE
[repo]: https://github.com/ssplatt/kitchen-linode
[driver_usage]: http://docs.kitchen-ci.org/drivers/usage
-[chef_omnibus_dl]: http://www.getchef.com/chef/install/