Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 86 lines (50 sloc) 4.661 kb
9fe81b7 Dan DeLeo initial import of Knife Rackspace commands
danielsdeleo authored
1 = Knife Rackspace
2
12bdb5d Seth Chisamore fully fleshed out README
schisamo authored
3 = DESCRIPTION:
4
5 This is the official Opscode Knife plugin for Rackspace. This plugin gives knife the ability to create, bootstrap, and manage servers on the Rackspace Cloud.
6
7 = INSTALLATION:
8
9fe81b7 Dan DeLeo initial import of Knife Rackspace commands
danielsdeleo authored
9 This plugin is distributed as a Ruby Gem. To install it, run:
10
12bdb5d Seth Chisamore fully fleshed out README
schisamo authored
11 gem install knife-rackspace
12
13 Depending on your system's configuration, you may need to run this command with root privileges.
14
15 = CONFIGURATION:
16
17 In order to communicate with the Rackspace Cloud API you will have to tell Knife about your Username and API Key. The easiest way to accomplish this is to create some entries in your <tt>knife.rb</tt> file:
18
19 knife[:rackspace_api_key] = "Your Rackspace API Key"
20 knife[:rackspace_api_username] = "Your Rackspace API username"
46fed9f Dan DeLeo purge whitespaces
danielsdeleo authored
21
12bdb5d Seth Chisamore fully fleshed out README
schisamo authored
22 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:
23
24 knife[:rackspace_api_username] = "#{ENV['RACKSPACE_USERNAME']}"
25 knife[:rackspace_api_key] = "#{ENV['RACKSPACE_API_KEY']}"
26
27 You also have the option of passing your Rackspace API Username/Key into the individual knife subcommands using the <tt>-A</tt> (or <tt>--rackspace-api-username</tt>) <tt>-K</tt> (or <tt>--rackspace-api-key</tt>) command options
46fed9f Dan DeLeo purge whitespaces
danielsdeleo authored
28
12bdb5d Seth Chisamore fully fleshed out README
schisamo authored
29 # provision a new 1GB Ubuntu 10.04 webserver
30 knife rackspace server create 'role[webserver]' -i 49 -f 3 -A 'Your Rackspace API username' -K "Your Rackspace API Key"
31
28659fd Seth Chisamore CHEF-2067: support api auth url
schisamo authored
32 This plugin also has support for authenticating against an alternate API Auth URL. This is useful if you are a Rackspace Cloud UK user or OpenStack early adopter. Here is an example of configuring knife for Rackspace Cloud UK:
33
34 knife[:rackspace_api_auth_url] = "lon.auth.api.rackspacecloud.com"
35
c8d5283 Seth Chisamore image/flavor should be configuration via knife.rb
schisamo authored
36 Additionally the following options may be set in your `knife.rb`:
37
38 * flavor
39 * image
40 * distro
41 * template_file
42
12bdb5d Seth Chisamore fully fleshed out README
schisamo authored
43 = SUBCOMMANDS:
44
45 This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a <tt>--help</tt> flag
46
47 == knife rackspace server create
48
c8d5283 Seth Chisamore image/flavor should be configuration via knife.rb
schisamo authored
49 Provisions a new server in the Rackspace Cloud and then perform a Chef bootstrap (using the SSH protocol). The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server. The main assumption is a baseline OS installation exists (provided by the provisioning). It is primarily intended for Chef Client systems that talk to a Chef server. By default the server is bootstrapped using the {ubuntu10.04-gems}[https://github.com/opscode/chef/blob/master/chef/lib/chef/knife/bootstrap/ubuntu10.04-gems.erb] template. This can be overridden using the <tt>-d</tt> or <tt>--template-file</tt> command options.
12bdb5d Seth Chisamore fully fleshed out README
schisamo authored
50
51 == knife rackspace server delete
52
53 Deletes an existing server in the currently configured Rackspace Cloud account. Please note - this does not delete the associated node and client objects from the Chef server.
54
55 == knife rackspace server list
56
57 Outputs a list of all servers in the currently configured Rackspace Cloud account. Please note - this shows all instances associated with the account, some of which may not be currently managed by the Chef server.
58
59 == knife rackspace flavor list
60
61 Outputs a list of all available flavors (available hardware configuration for a server) available to the currently configured Rackspace Cloud account. Each flavor has a unique combination of disk space, memory capacity and priority for CPU time. This data can be useful when choosing a flavor id to pass to the <tt>knife rackspace server create</tt> subcommand.
62
63 == knife rackspace image list
64
65 Outputs a list of all available images available to the currently configured Rackspace Cloud account. An image is a collection of files used to create or rebuild a server. Rackspace provides a number of pre-built OS images by default. This data can be useful when choosing an image id to pass to the <tt>knife rackspace server create</tt> subcommand.
66
67
68 = LICENSE:
69
70 Author:: Adam Jacob (<adam@opscode.com>)
71 Author:: Seth Chisamore (<schisamo@opscode.com>)
72 Copyright:: Copyright (c) 2009-2011 Opscode, Inc.
73 License:: Apache License, Version 2.0
74
75 Licensed under the Apache License, Version 2.0 (the "License");
76 you may not use this file except in compliance with the License.
77 You may obtain a copy of the License at
9fe81b7 Dan DeLeo initial import of Knife Rackspace commands
danielsdeleo authored
78
12bdb5d Seth Chisamore fully fleshed out README
schisamo authored
79 http://www.apache.org/licenses/LICENSE-2.0
9fe81b7 Dan DeLeo initial import of Knife Rackspace commands
danielsdeleo authored
80
12bdb5d Seth Chisamore fully fleshed out README
schisamo authored
81 Unless required by applicable law or agreed to in writing, software
82 distributed under the License is distributed on an "AS IS" BASIS,
83 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
84 See the License for the specific language governing permissions and
46fed9f Dan DeLeo purge whitespaces
danielsdeleo authored
85 limitations under the License.
Something went wrong with that request. Please try again.