Updated docs and added a short -p for pool

README.md

@@ -1,27 +1,26 @@
 [![Build Status](https://travis-ci.org/chef/knife-openstack.png)](https://travis-ci.org/chef/knife-openstack)
 
-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 `Kilo` 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 #
+## Installation
 
 Be sure you are running the latest version Chef. Versions earlier than 0.10.0 don't support plugins:
 
     $ curl -L https://chef.io/chef/install.sh | sudo bash
-  
+
 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 #
+## 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:
 
@@ -60,11 +59,11 @@ Additionally the following options may be set in your `knife.rb`:
 * openstack_ssh_key_id
 * template_file
 
-# Working with Floating IPs #
+## Working with Floating IPs
 
 To use a floating IP address while bootstrapping nodes, use the `-a` or `--openstack-floating-ip` option.
 
-# Working with Windows Images #
+## Working with Windows Images
 
 Provisioning and bootstrapping for Windows 2003 and later images is now supported. The Windows images need to have WinRM enabled with Basic Authentication configured. Current support does not support Kerberos Authentication.
 
@@ -77,51 +76,47 @@ NOTE:
 * Administrator Username (`--winrm-user` or `-x`) and Password (`-P`) are required parameters.
 * If the Template File (`--template`) is not specified it defaults to a Linux distro (most likely Ubuntu).
 
-# Subcommands #
+## Subcommands
 
 This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a `--help` option.
 
-knife openstack server create
------------------------------
+### knife openstack server create
 
 Provisions a new server in an OpenStack Compute 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 [chef-full](https://github.com/opscode/chef/blob/master/chef/lib/chef/knife/bootstrap/chef-full.erb) template (default since the 10.10 release). This may be overridden using the `-d` or `--template-file` command options. If you do not have public IP addresses, use the `--openstack-private-network` option to use the private IP address for bootstrapping.  In addition, you can use the `--bootstrap-network NAME` option to specify an alternate network for either a private or public network. If a network name isn't specified, the default name will be `'public'` for a public network and `'private'` for a private network e.g. when the `--openstack-private-network` option is specified.  Please see `knife openstack server create --help` for all of the supported options.
 
-knife openstack server delete
------------------------------
+### knife openstack server delete
 
 Deletes an existing server in the currently configured OpenStack account. If a floating IP address has been assigned to the node, it is disassociated automatically by the OpenStack server. <b>PLEASE NOTE</b> - this does not delete the associated node and client objects from the Chef server without using the `-P` option to purge the client.
 
-knife openstack server list
----------------------------
+### knife openstack server list
 
 Outputs a list of all servers in the currently configured OpenStack account. <b>PLEASE NOTE</b> - this shows all instances associated with the account, some of which may not be currently managed by the Chef server.
 
-knife openstack flavor list
----------------------------
+### knife openstack flavor list
 
 Provides a list of all available flavors (available "hardware" configurations for a server) available to the currently configured OpenStack account. Each flavor has a unique combination of virtual cpus, disk space and memory capacity. This data may be useful when choosing a flavor to pass to the `knife openstack server create` subcommand.
 
-knife openstack volume list
----------------------------
+### knife openstack volume list
 
 Provides a list of all volumes in the currently configured OpenStack account. Each volume shows its size and its availibility to be attached to server. This data may be useful when choosing a volume to pass to the `knife openstack server create` subcommand.
 
-knife openstack image list
---------------------------
+### knife openstack image list
 
 Lists all available images and snapshots available to the currently configured OpenStack account. An image is a collection of files used to create or rebuild a server. The retuned list filters out image names ending in 'initrd', 'kernel', 'loader', 'virtual' or 'vmlinuz' (this may be disabled with `--disable-filter`). This data may be useful when choosing an image to pass to the `knife openstack server create` subcommand.
 
-knife openstack group list
---------------------
+### knife openstack group list
 
 Provides a list of the security groups available to the currently configured OpenStack account. Each group may have multiple rules. This data may be useful when choosing your security group(s) to pass to the `knife openstack server create` subcommand.
 
-knife openstack network list
---------------------
+### knife openstack network list
 
 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 #
+### knife openstack floating_ip list
+
+Lists all of the available `floating-ips` you have associated with your account. You can ask for more via: `knife openstack floating_ip allocate --pool POOL` if you have run out. You can also `knife openstack floating_ip associate FLOATING_IP --instance-id INSTANCE_ID` and too. If you need to remove the `floating-ip` you can `disassociate` with the same command. If you would like to give back the `floating-ip` you can `knife openstack floating_ip release FLOATING_IP_ID`
+
+# License
 
 Author:: Seth Chisamore (<schisamo@chef.io>)
 

lib/chef/knife/openstack_floating_ip_allocate.rb

@@ -14,8 +14,9 @@ class OpenstackFloatingIpAllocate < Command
         banner 'knife openstack floating_ip allocate (options)'
 
         option :pool,
+          :short => '-p POOL',
           :long => '--pool POOL',
-          :description => 'Floating ip pool.',
+          :description => 'Floating IP pool to allocate from.',
           :proc => Proc.new { |key| Chef::Config[:knife][:pool] = key }
 
         def execute_command