README.md in knife-joyent-0.2.2 vs README.md in knife-joyent-0.3.0

- old
+ new

@@ -1,9 +1,9 @@ Knife Joyent === -This is a [Knife](http://wiki.opscode.com/display/chef/Knife) plugin for Joyent CloudAPI. This plugin gives knife +This is a [Knife](http://wiki.opscode.com/display/chef/Knife) plug-in for Joyent CloudAPI. This plug-in gives knife the ability to create, bootstrap, and manage servers on the [Joyent Public Cloud](http://www.joyentcloud.com/) as well as Cloud providers powered by Joyent's [SmartDataCenter](http://www.joyent.com/products/smartdatacenter/) product offering. For more information on Joyent CloudAPI, see: [CloudAPI Documentation](http://api.joyentcloud.com/docs) ## Installation @@ -23,10 +23,11 @@ knife joyent flavor list <options> knife joyent image list <options> knife joyent key add -f <keyfile> -k <name> knife joyent key delete <name> knife joyent key list + knife joyent network list knife joyent server create (options) knife joyent server delete <server_id> knife joyent server list <options> knife joyent server reboot <server_id> knife joyent server resize <server_id> -f <flavor> @@ -61,51 +62,70 @@ #### Required You can authenticate against CloudAPI using either: -a username and password +an ssh key (recommended) knife[:joyent_username] = "Your Joyent CloudAPI username" - knife[:joyent_password] = "Your Joyent CloudAPI password" + knife[:joyent_keyname] = "Name of key stored on Joyent" + knife[:joyent_keyfile] = "/path/to/your/private/key" -or, your ssh key + # Optional / not-recommended -- defaults to using ssh-agent + knife[:joyent_keyphrase] = "mypassphrase" +or username and password + knife[:joyent_username] = "Your Joyent CloudAPI username" - knife[:joyent_keyname] = "Name of key stored on Joyent" - knife[:joyent_keyfile] = "/path/to/your/private/key" + knife[:joyent_password] = "Your Joyent CloudAPI password" -#### Optional +When authenticating with your ssh key (which we highly recommend), knife-joyent will +attempt to use ssh-agent to sign the request using the key configured with +``knife[:joyent_keyname]``. If no ssh-agent is present or if the specified identity +isn't found in the agent, you may be prompted for a pass-phrase. If you do not want +to use an ``ssh-agent``, you may optionally configure ``knife[:joyent_passphrase]`` +to automatically unlock the key for authentication. -**joyent_api_url** +#### Optional Configuration +**``joyent_api_url``** + Specify a custom API endpoint, this is required if you want to specify where you want to provision your machines, or if you are using knife with a provider powered by [SmartDataCenter](http://www.joyent.com/products/smartdatacenter/). # Defaults to https://us-west-1.api.joyentcloud.com/ knife[:joyent_api_url] = "https://us-sw-1.api.joyentcloud.com/" -**joyent_metadata** +**``joyent_metadata``** Metadata to apply to each provisioned machine via the Metadata API. This should take the form of a hash with a single level of nesting. See the [Metadata API](http://wiki.joyent.com/wiki/display/sdc/Using+the+Metadata+API) for more info. knife[:joyent_metadata] = { "some_data" => "value" } -**provisioner** +**``joyent_version``** +By default, knife-joyent will use the version of the Joyent Cloud API that fog prefers. This +can be overridden in knife.rb as follows: + + knife[:joyent_version] = "~7.0" + +Some command line options to knife-joyent subcommands may depend on the Joyent API version set. + +**``provisioner``** + Machines provisioned will be tagged with key ``provisioner`` containing the value specified. This is useful for tracking source of provisions for accounts where machines are provisioned by/from different sources / users. ## Contributors - [Sean Omera](https://github.com/someara) - Opscode - - [Eric Saxby](https://github.com/sax) - ModCloth + - [Eric Saxby](https://github.com/sax) - Wanelo - [Stephen Lauck](https://github.com/stephenlauck) - ModCloth ## Bootstrap template for smartos To bootstrap chef on SmartOS, use the script provided at the [Joyent Wiki] (http://wiki.joyent.com/wiki/display/jpc2/Joyent+ChefServer+SmartMachine#JoyentChefServerSmartMachine-BootstrappingaBareImagedSmartMachinetoyourChefServer)