README.md in knife-openstack-1.0.0 vs README.md in knife-openstack-1.1.0
- old
+ new
@@ -1,24 +1,26 @@
-[![Build Status](https://travis-ci.org/opscode/knife-openstack.png)](https://travis-ci.org/opscode/knife-openstack)
+[![Build Status](https://travis-ci.org/chef/knife-openstack.png)](https://travis-ci.org/chef/knife-openstack)
Knife OpenStack
===============
-This is the official Chef Knife plugin for OpenStack Compute (Nova). This plugin gives knife the ability to create, bootstrap and manage instances in OpenStack Compute clouds. It has been tested against the `Diablo` through `Icehouse` releases in configurations using Keystone against the OpenStack API (as opposed to the EC2 API).
+This is the official Chef Knife plugin for OpenStack Compute (Nova). This plugin gives knife the ability to create, bootstrap and manage instances in OpenStack Compute clouds. It has been tested against the `Diablo` through `Juno` releases in configurations using Keystone against the OpenStack API (as opposed to the EC2 API).
Please refer to the [CHANGELOG](CHANGELOG.md) for version history and known issues.
# Installation #
Be sure you are running the latest version Chef. Versions earlier than 0.10.0 don't support plugins:
- $ gem install chef
-
+ $ curl -L https://chef.io/chef/install.sh > /tmp/install.sh && sudo bash /tmp/install.sh
+
This plugin is distributed as a Ruby Gem. To install it, run:
+ $ chef gem install knife-openstack
+ $ # OR
$ gem install knife-openstack
-
+
Depending on your system's configuration, you may need to run this command with root privileges.
# Configuration #
In order to communicate with an OpenStack API you will need to tell Knife your OpenStack Auth API endpoint, your Dashboard username and password (tenant is optional). The easiest way to accomplish this is to create these entries in your `knife.rb` file:
@@ -26,17 +28,19 @@
### Note: If you are not proxying HTTPS to the OpenStack auth port, the scheme should be HTTP
knife[:openstack_auth_url] = "http://cloud.mycompany.com:5000/v2.0/tokens"
knife[:openstack_username] = "Your OpenStack Dashboard username"
knife[:openstack_password] = "Your OpenStack Dashboard password"
knife[:openstack_tenant] = "Your OpenStack tenant name"
+ knife[:openstack_region] = "Your OpenStack Region"
If your knife.rb file will be checked into a SCM system (ie readable by others) you may want to read the values from environment variables. For example, using the conventions of [OpenStack's RC file](http://docs.openstack.org/user-guide/content/cli_openrc.html) (note the `openstack_auth_url`):
knife[:openstack_auth_url] = "#{ENV['OS_AUTH_URL']}/tokens"
knife[:openstack_username] = "#{ENV['OS_USERNAME']}"
knife[:openstack_password] = "#{ENV['OS_PASSWORD']}"
knife[:openstack_tenant] = "#{ENV['OS_TENANT_NAME']}"
+ knife[:openstack_region] = "#{ENV['OS_region_NAME']}"
If your OpenStack deployment is over SSL, but does not have a valid certificate, you can add the following option to bypass SSL check:
knife[:openstack_insecure] = true
@@ -112,16 +116,16 @@
Lists the networks available to the currently configured OpenStack account. This data may be useful when choosing your networks to pass to the `knife openstack server create` subcommand. This command is only available with OpenStack deployments using the Neutron network service (not nova-network). Please see `knife openstack server create --help` for all of the supported options.
# License #
-Author:: Seth Chisamore (<schisamo@getchef.com>)
+Author:: Seth Chisamore (<schisamo@chef.io>)
-Author:: Matt Ray (<matt@getchef.com>)
+Author:: Matt Ray (<matt@chef.io>)
Author:: Chirag Jog (<chirag@clogeny.com>)
-Copyright:: Copyright (c) 2011-2014 Chef Software, Inc.
+Copyright:: Copyright (c) 2011-2015 Chef Software, Inc.
License:: Apache License, Version 2.0
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.