README.md in vagrant-rackspace-0.1.6 vs README.md in vagrant-rackspace-0.1.7

- old
+ new

@@ -34,11 +34,11 @@ The default configuration of the RHEL family of Linux distributions requires a tty in order to run sudo. Vagrant does not connect with a tty by default, so you may experience the error: > sudo: sorry, you must have a tty to run sudo The best way to take deal with this error is to upgrade to Vagrant 1.4 or later, and enable: -``` +```ruby config.ssh.pty = true ``` ## Quick Start @@ -53,19 +53,20 @@ ``` And then make a Vagrantfile that looks like the following, filling in your information where necessary. -``` +```ruby Vagrant.configure("2") do |config| config.vm.box = "dummy" config.vm.provider :rackspace do |rs| rs.username = "YOUR USERNAME" rs.api_key = "YOUR API KEY" - rs.flavor = /512MB/ + rs.flavor = /1 GB Performance/ rs.image = /Ubuntu/ + rs.metadata = {"key" => "value"} # optional end end ``` And then run `vagrant up --provider=rackspace`. @@ -76,10 +77,31 @@ Note that normally a lot of this boilerplate is encoded within the box file, but the box file used for the quick start, the "dummy" box, has no preconfigured defaults. +## Custom Commands + +The plugin includes several Rackspace-specific vagrant commands. You can get the +list of available commands with `vagrant rackspace -h`. + +If you want to know what images or flavors are available for a machine, you can use: + +``` +$ vagrant rackspace images +$ vagrant rackspace flavors +``` + +In a multi-machine Vagrantfile you can also query for a single machine: +``` +$ vagrant rackspace images <name> +$ vagrant rackspace flavors <name> +``` + +These command will connect to Rackspace using the settings associated with the machine, +and query the region to get the list of available images or flavors. + ## Box Format Every provider in Vagrant must introduce a custom box format. This provider introduces `rackspace` boxes. You can view an example box in the [example_box/ directory](https://github.com/mitchellh/vagrant-rackspace/tree/master/example_box). @@ -94,11 +116,11 @@ This provider exposes quite a few provider-specific configuration options: * `api_key` - The API key for accessing Rackspace. * `flavor` - The server flavor to boot. This can be a string matching the exact ID or name of the server, or this can be a regular expression - to partially match some server flavor. + to partially match some server flavor. Flavors are listed [here](#flavors). * `image` - The server image to boot. This can be a string matching the exact ID or name of the image, or this can be a regular expression to partially match some image. * `rackspace_region` - The region to hit. By default this is :dfw. Valid options are: :dfw, :ord, :lon, :iad, :syd. Users should preference using this setting over `rackspace_compute_url` setting. @@ -114,10 +136,12 @@ * `server_name` - The name of the server within RackSpace Cloud. This defaults to the name of the Vagrant machine (via `config.vm.define`), but can be overridden with this. * `username` - The username with which to access Rackspace. * `disk_config` - Disk Configuration 'AUTO' or 'MANUAL' +* `metadata` - A set of key pair values that will be passed to the instance + for configuration. These can be set like typical provider-specific configuration: ```ruby Vagrant.configure("2") do |config| @@ -127,9 +151,32 @@ rs.username = "mitchellh" rs.api_key = "foobarbaz" end end ``` + +### Flavors + +As of February 2, 2014, the available flavor names are: + +* 512MB Standard Instance +* 1GB Standard Instance +* 2GB Standard Instance +* 4GB Standard Instance +* 8GB Standard Instance +* 15GB Standard Instance +* 30GB Standard Instance +* 1 GB Performance +* 2 GB Performance +* 4 GB Performance +* 8 GB Performance +* 120 GB Performance +* 15 GB Performance +* 30 GB Performance +* 60 GB Performance +* 90 GB Performance + +Please note that the standard instances are deprecated in favor of our performance flavors. ## Networks Networking features in the form of `config.vm.network` are not supported with `vagrant-rackspace`, currently. If any of these are