knife-cosmic 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd5dbfbc2b0c84f32febd5ef2a8b44d1fd5075bd
+  data.tar.gz: fd7321a56f2f2887ad63797c45cb74029b005655
+SHA512:
+  metadata.gz: 1d2e0e81f8752262df52f1689f047784bd2668fc752fd6677975b9f5dbac45629782c7db1f5d6784a87a6dc95ab3b16a05d210d0c5b554fe95766a2531f1cf7e
+  data.tar.gz: 33eba13bc1cb02cf693a4355d68e5c412dd69c3c16519fc1caf033223451de07be718e5a854e327ee74ce61b198a6ac255161edb70e05cbfaaa71bc18cf29fdd

data/CHANGES.rdoc

@@ -0,0 +1,186 @@
+= Changes
+== 2016-03-18 (0.1.0)
+* Added subcommand: <tt>cosmic volume attach</tt> (David Bruce 3 Jul 2015)
+* Added subcommand: <tt>cosmic volume detach</tt> (David Bruce 3 Jul 2015)
+* Removed gem depedency (Fred Neubauer 18 Mar 2016)
+
+== 2015-04-24 (0.0.20)
+* Added support for expunge option for <tt>cosmic server destroy</tt> (Anton Opgenoort 24 Mar 2015)
+* Added support for Chef 12 Client (Sander Botman 24 Apr 2015)
+
+== 2015-03-19 (0.0.19)
+* Added support for --boostrap-proxy for <tt>cosmic server create</tt> (Rutger Te Nijenhuis 19 Feb 2015)
+* Bugfix: no implicit conversion of String into Integer error, if no Nic present (Frank Louwers 19 Mar 2015)
+
+== 2014-12-29 (0.0.18)
+* Chef 12 has been released and installation of the plugin fails on certain components while it tries to install the latest chef-gem.
+  We are pinning this version on chef 11.0 and we will make the new version 0.1.0 chef 12 compatible.
+  If you have a urgent need for this, please drop us a line. (Sander Botman 29 Dec 2014)
+* Added support for --bootstrap-wget-options for <tt>cosmic server create</tt> (Deepak Sihag 25 Sep 2014)
+* Added subcommand: <tt>cosmic volume delete</tt> (Muga Nishizawa 7 May 2014)
+* Bugfix: within the README (Warren Bain 15 Apr 2014)
+* Added support for --size for <tt>cosmic server create</tt> (Muga Nishizawa 14 Apr 2014)
+* Bugfix: list_object method calls by invalid typed parameters (Muga Nishizawa 11 Apr 2014)
+* Bugfix: flexibility around ssh port configuration (Warren Bain 9 Apr 2014)
+* Bugfix: cosmetic fix to options indenting (Warren Bain 9 Apr 2014)
+* Bugfix: remove fqdn from node name when deleting server (Warren Bain 9 Apr 2014)
+* Bugfix: fix whitespace (Warren Bain 9 Apr 2014)
+
+== 2014-03-04 (0.0.17)
+* Added support for --isdynamicallyscalable for <tt>cosmic template register</tt> (Sander Botman, 3 Apr 2014)
+* Added support for --anti-affinity-groups for <tt>cosmic server create</tt> (John E. Vincent, 2 Apr 2014)
+* Bugfix: on winrm bootstrap (Sander van Harmelen, 26 Mar 2014)
+* Added support for --expunge for destroying server (Ian Southam, 19 Mar 2014)
+* Bugfix: cosmetic changes on error output (Sander Botman, 5 Mar 2014)
+
+== 2014-02-12 (0.0.16)
+* Added support for --no-public-ip for <tt>cosmic server list</tt> (Sander Botman, 12 Feb 2014)
+* Added support for secret and secret_file in <tt>cosmic server create</tt> (Jeremy Baumont, 10 Feb 2014)
+* Bugfix: correction in isextractable on <tt>cosmic template register</tt> (Etharin, 30 Jan 2014
+* Added support for private-ip in <tt>cosmic server create</tt> (Joaquim Dos Santos, 26 Jan 2014)
+* Bugfix: Keypair support on stack create (Ben Langfeld, 29 Nov 2013)
+* Bugfix: Bootstrap even without port_rules options (Ben Langfeld, 29 Nov 2013)
+* Bugfix: Option to specify iso as template when deploying instance <tt>cosmic server create</tt> (Sander Botman, 28 Nov 2013)
+* Restructure all list commands (Sander Botman, 28 Nov 2013)
+* Added subcommand: <tt>cosmic aag list</tt> (John E. Vincent, 23 Nov 2013)
+* Added support for anti-affinity groups in <tt>cosmic server create</tt> (John E. Vincent, 23 Nov 2013)
+* Added subcommand: <tt>cosmic server add nic</tt> (John E. Vincent, 13 Nov 2014)
+* Added Trademark (David Nalley, 08 Nov 2013)
+* Bugfix: fixing server creation inside basic networks (Sander Botman, 07 Nov 2013)
+
+== 2013-11-04 (0.0.15)
+* Bugfix: fixed the proxy with the option: --cosmic-proxy http://username:password@yourproxy:8080 or use config file. (Sander Botman, 04 Nov 2013)
+* Added subcommand: <tt>cosmic publicip list</tt> (Sander Botman, 03 Nov 2013)
+* Bugfix: removed the chef rest dependency because this is changed in chef 11.8.0 (Sander Botman, 03 Nov 2013)
+* Bugfix: added the option --cosmic-no-ssl-verify in order to ignore ssl verification (Sander Botman, 03 Nov 2013)
+* Added subcommand: <tt>cosmic forwardrule create</tt> (Sander Botman, 28 Aug 2013)
+* Added subcommand: <tt>cosmic firewallrule create</tt> (Sander Botman, 28 Aug 2013)
+* Added the option: <tt>--set-display-name</tt> to <tt>server create</tt> (Florin Stan, 5 Aug 2013)
+* Added the option: <tt>--keypair</tt> to <tt>server create</tt> (Florin Stan, 31 Jul 2013)
+* Added subcommand: <tt>cosmic volume create</tt> (Jeremy Baumont, 17 Jul 2013)
+* Added the option: <tt>--disk</tt> to <tt>server create</tt> (Stanislav Voroniy (voroniys) 13 Jun 2013)
+* Added subcommands: <tt>cosmic keypair list</tt>, <tt>cosmic keypair create</tt>, <tt>cosmic keypair delete</tt> and adding basic zone check. (Sebastian Goasguen (runseb) 29 May 2013)
+* Bugfix: changed output name to password (Warren Bain, 26 May 2013)
+* Bugfix: various bugfixes and fixing bootstrap context (bacoboy, 22 Apr 2013)
+
+== 2013-04-14 (0.0.14)
+* Added bash/addinstance.sh script in onder to ease instance creation from cli.
+
+* Added the cosmic_base.rb to merge all common options.
+* Added the cosmic_base_list.rb to merge all common options and functions for the list commands.
+* Added the option: <tt>-P</tt> / <tt>--cosmic-project</tt> to the following commands: <tt>account list</tt>, <tt>firewallrule list</tt>, <tt>hosts</tt>,
+  <tt>iso list</tt>, <tt>network list</tt>, <tt>router list</tt>, <tt>server list</tt>, <tt>template list</tt>, <tt>volume list</tt>
+
+* Added subcommands: <tt>account list</tt>, <tt>cluster list</tt>, <tt>config list</tt>, <tt>disk create</tt>,
+  <tt>disk list</tt>, <tt>domain list</tt>,<tt>firewallrule list</tt>, <tt>host list</tt>,
+  <tt>iso list</tt>, <tt>ostype list</tt>, <tt>oscategory list</tt>, <tt>pod list</tt>, <tt>project list</tt>,
+  <tt>service create</tt>, <tt>template create</tt>, <tt>template extract</tt>, <tt>template register</tt>, <tt>router list</tt>, <tt>user list</tt>, <tt>volume list</tt>
+
+* Updated subcommands: <tt>hosts</tt>, <tt>network list</tt>, <tt>server list</tt>, <tt>service list</tt>,
+  <tt>template list</tt>, <tt>zone list</tt>
+
+* Added option: <tt>--filter</tt> to all list commands. This filters your output on the fields that you specify.
+  Filter can be a string <tt>'name'</tt> or regexp <tt>'/name/i'</tt>. Example: <tt>--filter "instancename:/i-xxx/i,accountname:jenkins"</tt>
+  Additional filters can be added by separating them using a comma ',' 
+    NOTE: --filter is done client side, filtering by --name or --keyword is faster and is done server side.
+
+* Added option: <tt>--fields</tt> to all list commands. Here you specify the fields that you want to display in your output.
+  Default outputs will be shown if no fields are defined. Example: <tt>--fields "name, instancename, domain"</tt>
+
+* Added option: <tt>--noheader</tt> to all list commands.
+  This will remove the header from the output.
+
+* Added option: <tt>--fieldlist</tt> to all list commands. This will display the fields that you can use to filter or
+  use in your output. Example will be given with the first result that you specify in your filter.
+
+* Added option: <tt>--listall</tt> to: <tt>account list</tt>, <tt>domain list</tt>, <tt>firewallrule list</tt>, <tt>hosts</tt>, <tt>iso list</tt>,
+  <tt>network list</tt>, <tt>project list</tt>, <tt>router list</tt>, <tt>server list</tt>, <tt>template list</tt>, <tt>user list</tt>, <tt>volume list</tt>.
+
+* Added option: <tt>--keyword</tt> to: <tt>account list</tt>, <tt>cluster list</tt>, <tt>config list</tt>, <tt>disk list</tt>, <tt>firewallrule list</tt>,
+  <tt>hosts</tt>, <tt>iso list</tt>, <tt>network list</tt>, <tt>ostype list</tt>, <tt>oscategory list</tt>, <tt>pod list</tt>, <tt>project list</tt>, <tt>router list</tt>,
+  <tt>server list</tt>, <tt>service list</tt>, <tt>user list</tt>, <tt>volume list</tt>, <tt>zone list</tt>.
+
+* Added option: <tt>--name</tt> to: <tt>account list</tt>, <tt>cluster list</tt>, <tt>config list</tt>, <tt>disk list</tt>, <tt>host list</tt>, <tt>hosts</tt>, <tt>iso list</tt>,
+  <tt>pod list</tt>, <tt>project list</tt>, <tt>router list</tt>, <tt>server list</tt>, <tt>service list</tt>, <tt>volume list</tt>
+
+* Added option: <tt>--action</tt> to: <tt>server list</tt> which <tt>start</tt>, <tt>stop</tt> or <tt>destroy</tt> the machines based on the result.
+* Added option: <tt>--cosmic-password</tt> to let cosmic generate the password (only works if your template supports this.)
+* Added option: <tt>--ipfwd-rules</tt> and <tt>--fw-rules</tt> to: <tt>server create</tt>
+* Fixed delay-loading.
+* Fixed <tt>-F json</tt> / <tt>--format json</tt> option for every list command.
+* Fixed <tt>--no-bootstrap</tt> option to ignore the chef bootstrap
+* Fixed default bootstrap template to: <tt>chef-full</tt>
+
+
+== 2012-11-29 (0.0.13)
+* Windows support
+  https://github.com/cosmic-extras/knife-cosmic/issues/31
+* Support for Projects
+* HTTPS support 
+
+== 2012-05-17 (0.0.12)
+* Adding option to disable public IP allocation on server create
+  https://github.com/cosmic/knife-cosmic/pull/8
+* Fix whitespace issue in network names
+  https://github.com/cosmic/knife-cosmic/pull/7
+
+== 2011-11-03 (0.0.11)
+* Added LICENSE file and licensing headers to source. No feature changes.
+
+== 2011-10-13 (0.0.10)
+* Support for multi-homed VMs: The --networks option for the <tt>server create</tt> command takes a comma-separated list
+  of network offering names. The created VM will have one nic per network, with nicosmic assigned to networks in the order
+  specified (e.g. the first network in the list will be assigned to eth0, the second to eth1 and so on). The --networks
+  option replaces the --network option, which supported a single network name.
+* The <tt>server list</tt> command now shows the VM 'displayname' in parentheses when the displayname is defined and is
+  different than the VM name.
+* Public IP logic has been updated to support multi-homed VMs. It now uses the first nic attached to a network with the
+  'default' value set to true as the primary interface.
+   
+== 2011-08-30 (0.0.9)
+* Added subcommands: <tt>server start</tt>, <tt>server stop</tt> and <tt>server reboot</tt>.
+* Updated the <tt>hosts</tt> command to return short hostnames and FQDNs. Also added comments where needed so the output
+  can be directly pasted into /etc/hosts.
+
+== 2011-08-06 (0.0.8)
+* Changed cosmic async command timeout from 60 to 300 seconds.
+
+== 2011-07-21 (0.0.7)
+* Fixed http_request actions in <tt>stack create</tt>.
+
+== 2011-07-15 (0.0.6)
+* The <tt>server delete</tt> command now deletes the chef node and client if their names match the fqdn of the server.
+* Added the <tt>stack create</tt> and <tt>stack delete</tt> commands for bulk creation and deletion of servers using a
+  JSON definition file. These commands are still experimental and subject to change. See README.rdoc for details.
+* Added a <tt>hosts</tt> command, which lists the public ip address and fqdn of all servers in /etc/hosts file format.
+* Fixed nil reference bug in <tt>server list</tt> command.
+
+== 2011-06-05 (0.0.5)
+* Added <tt>--port-rules</tt> option to the <tt>cosmic server create</tt> command. It accepts a list of port forwarding
+  rules to be created for the server (only applies to servers on a virtual network). See 'Port forwarding rules for
+  virtual networks' in README.rdoc for details.
+
+== 2011-06-01 (0.0.4)
+* Fixed ssh detection bug.
+
+== 2011-05-30 (0.0.3)
+
+* Added support for virtual networks. A public IP address is allocated for each new server in a virtual network
+  and an ssh port forwarding rule is created. The IP is released when the server is destroyed as long as it doesn't
+  have forwarding rules for any servers other than the one being deleted.
+* Default network is now detected automatically. If there is more than one network marked as 'default' for an
+  account, the first Direct network is preferred.
+
+== 2011-05-22 (0.0.2)
+
+* Added subcommands: <tt>service list</tt>, <tt>template list</tt>, <tt>network list</tt> and <tt>zone list</tt>.
+* Removed -H (and --hostname) option from the <tt>cosmic server create</tt> command. The host name is now the first
+  argument to the command: <tt>knife cosmic server create myhostname</tt>. If a host name is not specified, cosmic
+  will use an auto-generated name.
+* Added --no-bootstrap option to the server create command. This prevents Chef from being installed on the new server.
+* Fixed help banners (commands were shown as <tt>knife cosmic ...</tt> instead of <tt>knife cosmic ...</tt>).
+* Added README.rdoc.
+
+== 2011-05-15 (0.0.1)
+
+* Initial release

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,427 @@
+= knife-cosmic
+
+{<img src="https://codeclimate.com/github/cosmic-extras/knife-cosmic.png" />}[https://codeclimate.com/github/cosmic-extras/knife-cosmic]
+{<img src="https://gemnasium.com/cosmic-extras/knife-cosmic.png" alt="Dependency Status" />}[https://gemnasium.com/cosmic-extras/knife-cosmic]
+
+== DESCRIPTION:
+
+This is the Edmunds Knife plugin for cosmic. This plugin gives Knife the ability to create, bootstrap and manage
+cosmic instances.
+
+== INSTALLATION:
+This plugin is distributed as a Ruby Gem. To install it, run:
+
+    gem install knife-cosmic
+
+Depending on your system's configuration, you may need to run this command with root privileges.
+
+== CONFIGURATION:
+In order to communicate with the cosmic API you will have to tell Knife about your cosmic API Key, your Secret Key and the URL of the API endpoint.
+The easiest way to accomplish this is to create some entries in your <tt>knife.rb</tt> file:
+
+    knife[:cosmic_url] = "http://yourcosmicosmicerver.com:8080/client/api
+    knife[:cosmic_api_key]  = "Your cosmic API Key"
+    knife[:cosmic_secret_key] = "Your cosmic Secret Key"
+
+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:
+
+    knife[:cosmic_url] = "#{ENV['cosmic_URL']}"
+    knife[:cosmic_api_key] = "#{ENV['cosmic_API_KEY']}"
+    knife[:cosmic_secret_key] = "#{ENV['cosmic_SECRET_KEY']}"
+
+You also have the option of passing your cosmic URL and API/Secret Keys into the individual knife subcommands using the <tt>-U</tt> (or <tt>--cosmic-url</tt>),
+<tt>-A</tt> (or <tt>--cosmic-api-key </tt>) <tt>-K</tt> (or <tt>--cosmic-secret-key</tt>) command options
+    # provision a new small RHEL 5.6 webserver
+    knife cosmic server create my-server -r 'role[webserver]' -S "small" -T "RHEL 5.6 Base" -A 'Your cosmic API Key' -K "Your cosmic Secret Key" --distro "rhel5-gems"
+
+Additionally the following options may be set in your <tt>knife.rb</tt>:
+
+* knife[:cosmic_service]
+* knife[:cosmic_template]
+* knife[:cosmic_zone]
+* knife[:cosmic_proxy]
+* knife[:cosmic_no_ssl_verify]
+* knife[:distro] 
+* knife[:template_file]
+
+== Public Clouds (Tata InstaCompute, Ninefold etc):
+To get this plugin to work in public clouds, it is essential that the virtual network (and router) be allocated to the account. cosmic clouds automatically creates a virtual network  when the first VM is requested to be created. Hence, it is essential to create the first VM (of a newly created account) manually(which can be terminated immediately if not required) to ensure the virtual network is created.
+
+== SUBCOMMANDS:
+
+This plugin provides the following Knife subcommands.  Specific command options can be found by invoking the subcommand with a <tt>--help</tt> flag
+
+=== knife cosmic <command> list
+
+<tt>--filter</tt>               Filters your output on the fields that you specify. Filter can be a string 'name' or regexp '/name/i'
+    Example: knife cosmic server list --filter "instancename:/i-xxx/i, account:accname"
+
+<tt>--fields</tt>               The fields that you want to display in your output. Default outputs will be shown if no fields are defined.
+    Example: knife cosmic server list --fields "name, instancename, domain"
+
+<tt>--fieldlist</tt>            This will display all information returned by the cosmic API. These fields can be used within the <tt>--fields</tt> or <tt>--filter</tt> to create custom output.
+The data displayed is based on first result returned in your output. You can get other result by using the <tt>--filter</tt> option.
+
+<tt>--noheader</tt>             this will remove the column header from the output.
+
+
+=== knife cosmic server create
+
+Provisions a new server in cosmic and then performs 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' template (default bootstrap option for knife,
+(Ref. http://docosmic.opscode.com/knife_bootstrap.html). This can be overridden using the <tt>-d</tt> or <tt>--template-file</tt> command options.
+VM provided with <tt>--no-bootstrap</tt> option have no forwarded ports or forwared ip rules (in case <tt>--static-nat</tt> is used).
+
+By default, new servers are allocated a public IP address mapping to the cosmic private IP address. If you do not want this behavior, pass the <tt>--no-public-ip</tt> option.
+
+Forcing cloustack to reserve and use a certain private ipv4 address when deploying an instance inside an advanced zone is possible by passing <option>--private-ip</option> followed by the intended ipv4 address. Ip Address must be contained within the network mask of the isolated network, of course.
+
+ Example: knife cosmic server create testvm --private-ip 192.168.1.1 --networks mynetwork
+
+Here mynetwork must have a network mask for example like 192.168.1.0/24.
+
+==== Port forwarding rules for virtual networks
+The <tt>--port-rules</tt> option takes a comma separated list of port forwarding rules. These rules are created on the
+virtual public ip address of the server. Note that this option only applies to servers using a virtual network; it is
+ignored if the server's public ip address is on a direct attached network.
+
+Port forwarding rules have the syntax <tt>PUBLIC_PORT[:PRIVATE_PORT[:PROTOCOL]]</tt>. <tt>PRIVATE_PORT</tt> and
+<tt>PROTOCOL</tt> are optional. The default value of <tt>PRIVATE_PORT</tt> is <tt>PUBLIC_PORT</tt> and the default
+<tt>PROTOCOL</tt> is 'TCP'.
+For example, a rule to forward from public port 80 to private port 7000 would look like <tt>80:7000:TCP</tt>.
+Since 'TCP' is the default protocol, the rule can be shortened to <tt>80:7000</tt>. A rule can even be shortened to a
+single number when the public and private ports are the same. For example, a rule to forward from public port 25 to
+private port 25 can be stated as simply <tt>25</tt>. A list of such rules for a webserver might look like
+<tt>80,443</tt>.
+
+==== IP forwarding rules
+The <tt>--ipfwd-rules</tt> option takes a comma separated list of ip forwarding rules. These rules are created on public ip appdress assigned obtained with <tt>--static-nat</tt> option.
+(Ref. http://cosmic.apache.org/docosmic/api/apidocosmic-4.0.0/root_admin/createIpForwardingRule.html)
+
+Ip forwarding rules have the syntax <tt>START_PORT[:END_PORT[:PROTOCOL]]</tt>. <tt>END_PORT</tt> and <tt>PROTOCOL</tt> are optional.
+The default value of <tt>END_PORT</tt> is <tt>START_PORT</tt> and the default <tt>PROTOCOL</tt> is 'TCP'.
+For example, a rule to forward ports range from 1024 to 10000 would look like <tt>1024:10000:TCP</tt>.
+Since 'TCP' is the default protocol, the rule can be shortened to <tt>1024:10000</tt>. A rule can even be shortened to a
+single number when the start and end ports are the same. For example, a rule to forward port 22 can be stated as simply <tt>22</tt>. A list of such rules for a webserver might look like <tt>80,443</tt>.
+
+==== Create Firewall Rule for given ip address
+The <tt>-f, --fw-rules</tt> option takes a comma separated list of firewall rules which are applied to the public ip address assigned to the current server.
+
+Firewall rules have the syntax <tt>PROTOCOL[:CIDR_LIST[:START_PORT[:END_PORT]]]</tt>. <tt>START_PORT</tt> and <tt>END_PORT</tt> must not be specified when <tt>PROTOCOL</tt> is <tt>ICMP</tt>, <tt>CIDR_LIST</tt> is always optional.
+The default value of <tt>END_PORT</tt> is <tt>START_PORT</tt>, the default <tt>CIDR_LIST</tt> is '0.0.0.0/0'.
+For example, a rule to open firewall for port 80 to everyone would look like <tt>TCP::80</tt> and a rule to open ICMP to internal network would look like <tt>ICMP:10.0.0.0/8</tt>.
+
+=== knife cosmic server delete
+
+Deletes an existing server in the currently configured cosmic account.  <b>PLEASE NOTE</b> - this does not delete
+the associated node and client objects from the Chef server.
+
+=== knife cosmic server list
+
+Displays a list of all servers in the currently configured cosmic account.  <b>PLEASE NOTE</b> - this shows all
+servers associated with the cosmic account including servers that are not registered with a Chef server.
+
+<tt>--listall</tt>              This will list all the servers, depending on the account that you are using.
+
+<tt>--keyword</tt>              Filters your output on the instance name that you specify: 
+    Example: --keyword "i-324", This will display all servers with <tt>'i-324'</tt> inside the instancename.
+
+<tt>--name</tt>                         Filters your output on the name that you specify. 
+    Example: --name "webserver", This will display all servers that contains 'webserver' inside the hostname.
+
+<tt>--action</tt>               This action will be executed on the output of the list command. Actions can be start, stop or destroy.
+
+=== knife cosmic network list
+Displays a list of all networks available in the currently configured cosmic account. A network can be specified
+when creating a new server by passing the network name as an argument to the -W (or --network) option of the
+<tt>knife cosmic server create</tt> command.
+
+<tt>--listall</tt>              This will list all the networks, depending on the account that you are using.
+
+<tt>--keyword</tt>              Filters your output on the keyword that you specify. 
+    Example: --keyword "network1", This will display all networks with 'network1' inside the name.
+
+=== knife cosmic service list
+Displays a list of all service offerings available in the currently configured cosmic account. A service offering
+can be specified when creating a new server by passing the name as an argument to the -S (or --service) option of the
+<tt>knife cosmic server create</tt> command.
+
+<tt>--keyword</tt>              Filters your output on the service name, just like <tt>--name</tt> here below.
+
+<tt>--name</tt>                 Filters your output on the name that you specify. 
+    Example: --name "medium" or --keyword "medium", This will display all cpu service offerings with 'medium' inside the name.
+
+=== knife cosmic template list
+Displays a list of all templates in the currently configured cosmic account. Featured templates are displayed by default.
+Use the -F (or --filter) option to use a different filter. The allowable filter values are:
+
+* featured - templates that are featured and are public (this is the default)
+* self - templates that have been registered/created by the owner
+* self-executable - templates that have been registered/created by the owner that can be used to deploy a new VM
+* executable - all templates that can be used to deploy a new VM
+* community - templates that are public
+
+A template can be specified when creating a new server by passing the template name as an argument to the -T
+(or --template) option of the <tt>knife cosmic server create</tt> command.
+
+<tt>--listall</tt>              This will list all the templates, depending on the account that you are using.
+
+=== knife cosmic template create
+Creates a template based on a volumeID
+
+=== knife cosmic template extract
+Returns a link where an extractable template can be downloaded
+
+=== knife cosmic template register
+Creates a template based on a file
+
+=== knife cosmic volume create
+Creates a volume based on a name
+
+=== knife cosmic zone list
+Displays a list of all zones available in the currently configured cosmic account. A zone can be specified
+when creating a new server by passing the zone name as an argument to the -Z (or --zone) option of the
+<tt>knife cosmic server create</tt> command.
+
+<tt>--keyword</tt>              Filters your output on the keyword that you specify. 
+    Example: --keyword "zone1", This will display all zones with 'zone1' inside the name
+
+=== knife cosmic hosts
+Convenience command that displays the public ip address and fqdn for all servers. Matches /etc/hosts file format.
+
+<tt>--listall</tt>              This will list all the servers, depending on the account that you are using.
+
+<tt>--keyword</tt>              Filters your result based on a keyword.
+
+<tt>--name</tt>                 Filters your output on the name that you specify.
+
+==== knife cosmic account list
+Displays all accounts that are currently in your cosmic environment.
+
+<tt>--listall</tt>              This will list all the possible results, depending on the account that you are using.
+
+<tt>--keyword</tt>               Filters your result based on a keyword.
+
+<tt>--name</tt>                  Filters your output on the name that you specify.
+
+==== knife cosmic cluster list
+Displays all clusters that are currently available in your cosmic environment.
+
+<tt>--keyword</tt>               Filters your result based on a keyword.
+
+<tt>--name</tt>                  Filters your output on the name that you specify.
+
+==== knife cosmic config list
+Displays all the configuration settings that are configured inside the cosmic environment.
+
+<tt>--keyword</tt>               Filters your result based on a keyword.
+
+<tt>--name</tt>                  Filters your output on the name that you specify.
+
+==== knife cosmic disk list
+Displays all the disks that are available within cosmic.
+
+<tt>--keyword</tt>               Filters your result based on a keyword.
+
+<tt>--name</tt>                  Filters your output on the name that you specify.
+
+==== knife cosmic domain list
+Displays all domains within the cosmic environment.
+
+<tt>--listall</tt>              This will list all the domains, depending on the account that you are using.
+
+==== knife cosmic firewallrule list
+Displays all firewall rules that are currently active within your cosmic environment.
+
+<tt>--listall</tt>              This will list all the firewallrules, depending on the account that you are using.
+
+<tt>--keyword</tt>              Filters your result based on a keyword.
+
+==== knife cosmic host list
+Displays all hosts from the cosmic environment.
+
+<tt>--name</tt>                 Filters your output on the name that you specify.
+
+==== knife cosmic iso list
+Displays all iso's that are available within the cosmic environment.
+
+<tt>--listall</tt>              This will list all the iso's, depending on the account that you are using.
+
+<tt>--keyword</tt>              Filters your result based on a keyword.
+
+<tt>--name</tt>                 Filters your output on the name that you specify.
+
+==== knife cosmic ostype list
+Displays all the os types that are available within the cosmic environment.
+
+<tt>--keyword</tt>              Filters your output on the keyword that you specify.
+
+==== knife cosmic oscategory list
+Displays all os categories that are available 
+<tt>--keyword</tt>              Filters your output on the keyword that you specify.
+
+==== knife cosmic pod list
+Displays all the pods that are currently available within the cosmic environment.
+
+<tt>--keyword</tt>              Filters your result based on a keyword.
+
+<tt>--name</tt>                 Filters your output on the name that you specify.
+
+==== knife cosmic project list
+Displays all the projects that are within the cosmic environment.
+
+<tt>--listall</tt>              This will list all the projects, depending on the account that you are using.
+
+<tt>--keyword</tt>              Filters your result based on a keyword.
+
+<tt>--name</tt>                 Filters your output on the name that you specify.
+
+==== knife cosmic publicip list
+Displays all public ip's that are used within the cosmic environment.
+
+<tt>--listall</tt>              This will list all the public ip's, depending on the account that you are using.
+
+==== knife cosmic router list
+Displays all the routers that are within the cosmic environment.
+
+<tt>--listall</tt>              This will list all the routers, depending on the account that you are using.
+
+<tt>--keyword</tt>              Filters your result based on a keyword.
+
+<tt>--name</tt>                 Filters your output on the name that you specify.
+
+==== knife cosmic user list
+Displays all the users that are available within your account.
+
+<tt>--listall</tt>              This will list all the users, depending on the account that you are using.
+
+<tt>--keyword</tt>              Filters your output on the keyword that you specify.
+
+==== knife cosmic volume list:
+Displays all the volumes that are currently available within the cosmic environment.
+
+<tt>--listall</tt>              This will list all the volumes, depending on the account that you are using.
+
+<tt>--keyword</tt>              Filters your output on the keyword that you specify.
+
+<tt>--name</tt>                 Filters your output on the name that you specify.
+
+=== knife cosmic stack create
+Creates a "stack" of servers based on a JSON definition file. Simple orchestration can be performed by
+specifying one or more actions to be executed after a server (or group of servers) is created.
+
+<tt>--skip-existing</tt>        Skip erroring on any servers already created in the stack (default is false)
+
+==== Example Stack Definition File:
+
+    {
+      "name": "hadoop_cluster_a",
+      "description": "A small hadoop cluster with hbase",
+      "version": "1.0",
+      "environment": "production",
+      "servers": [
+        {
+          "name": "zookeeper-a, zookeeper-b, zookeeper-c",
+          "description": "Zookeeper nodes",
+          "template": "rhel-5.6-base",
+          "service": "small",
+          "port_rules": "2181",
+          "run_list": "role[cluster_a], role[zookeeper_server]",
+          "actions": [
+            { "knife_ssh": ["role:zookeeper_server", "sudo chef-client"] }
+          ]
+        },
+        {
+          "name": "hadoop-master",
+          "description": "Hadoop master node",
+          "template": "rhel-5.6-base",
+          "service": "large",
+          "networks": "app-net, storage-net",
+          "port_rules": "50070, 50030, 60010",
+          "run_list": "role[cluster_a], role[hadoop_master], role[hbase_master]"
+        },
+        {
+          "name": "hadoop-worker-a hadoop-worker-b hadoop-worker-c",
+          "description": "Hadoop worker nodes",
+          "template": "rhel-5.6-base",
+          "service": "medium",
+          "port_rules": "50075, 50060, 60030",
+          "run_list": "role[cluster_a], role[hadoop_worker], role[hbase_regionserver]",
+          "actions": [
+            { "knife_ssh": ["role:hadoop_master", "sudo chef-client"] },
+            { "http_request": "http://${hadoop-master}:50070/index.jsp" }
+          ]
+        }
+      ]
+    }
+
+==== Stack Attributes
+name:: Stack name. May be used in the future to e.g. look up a stack in a databag.
+version:: Stack version. This attribute is not currently used.
+environment:: Chef environment used for all servers in the stack.
+servers:: List of servers to create.
+
+==== Server Attributes
+name:: The name of the new server. Specify a list of names separated by commas and/or spaces to create multiple servers.
+description:: Server description.
+template:: cosmic template name.
+service:: cosmic service offering name.
+port_rules:: Port forwarding rules for virtual networks. These are ignored when using direct or other network types.
+run_list:: Chef run list.
+actions:: List of actions to perform after the server (or group of servers) is created.
+
+==== Actions
+knife-ssh:: Performs a knife-ssh command. Takes the search query and the command to execute as an array of arguments.
+http_request:: Performs an http request. Supports references to server names in the stack with ${server_name}.
+
+==== Upcoming Actions
+The following actions are under development:
+
+runlist_add:: Adds an entry from the run list.
+runlist_remove:: Removes an entry from the run list.
+
+=== knife cosmic stack delete
+Deletes all servers in the specified stack definition.
+
+=== knife cosmic server start
+Starts the specified virtual machine(s).
+
+=== knife cosmic server stop
+Stops the specified virtual machine(s). Force stop is optional.
+
+=== knife cosmic server reboot
+Reboots the specified virtual machines(s).
+
+== LICENSE:
+
+Original knife-cloudstack author:: Ryan Holmes <rholmes@edmunds.com> 
+Original knife-cloudstack author:: KC Braunschweig <kcbraunschweig@gmail.com>
+Original knife-cloudstack author:: John E. Vincent <lusis.org+github.com@gmail.com>
+Original knife-cloudstack author:: Sander Botman <sbotman@schubergphilis.com>
+Original knife-cloudstack author:: Frank Breedijk <fbreedijk@schubergphilis.com>
+Original knife-cloudstack author:: Jeremy Baumont <jbaumont@schubergphilis.com>
+Copyright:: Copyright (c) 2011 Edmunds, 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.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+== Trademark Attribution
+
+knife is a trademark of Opscode
+
+cosmic is a trademark or registered trademark of The Apache Software Foundation
+
+The use of these marks is nominative in describing the function and integration of
+this software and does not imply endorsement by Opscode, the Apache Software Foundation, 
+or Apache cosmic.