knife-proxmox 0.0.12

data/CHANGELOG

@@ -0,0 +1,155 @@
+Author: Jorge Moratilla
+Date: 2012-10-07
+[2013-01-23]
+Version: 0.0.10
+* knife proxmox server create can bootstrap a server, enabled by default
+
+[2013-01-21]
+Version: 0.0.9
+* Added IP field to server list command
+
+[2012-12-21]
+Version: 0.0.8
+* Added a patch for proxmox that allows me to fetch the IP of the guess
+* Working with the PVE API
+
+[2012-12-13]
+Version: 0.0.6
+* Added new field in proxmox server list to show the node the vm is in
+* Now you can start, stop, destroy a server without to specify the node
+
+[2012-12-12]
+Version: 0.0.5
+* Improved problems with selection of the node of the cluster
+* Better checking of task status
+* Solved problem #3 catching from exceptions
+
+[2012-11-12]
+
+Added an option to knife proxmox server create that allows the user to specify the ipaddress.  If not, then the VM will be created with DHCP enabled.
+Created a very basic task control for creating and deleting servers.  Great refactoring needed.
+Now, I'm using bitbucket issue control center to keep control of issues.  Please use this link to add control keys in pushes 
+https://confluence.atlassian.com/display/BITBUCKET/Automatically+Resolving+Issues+when+Users+Push+Code 
+
+[2012-11-06]
+
+Added server start and stop commands
+$ knife proxmox server start --vmid 401
+Starting VM 401....
+Result: 200
+
+$ knife proxmox server stop --vmid 103
+Stoping VM 103....
+Result: 200
+
+
+[2012-11-05]
+
+First refactor, ProxmoxBase has now all the common parameters
+Added proxmox server list to show current servers
+Example:
+$ knife proxmox server list
+Id   Name                 Type    Status
+104  tetatet.jnlabs.isp   openvz  down  
+470  sg-node1.jnlabs.isp  openvz  up  
+102  test                 qemu    down  
+202  chef-client1         openvz  down 
+
+[2012-10-24]
+
+Improved knife commands.  Needs refactor internally
+Examples:
+
+List templates installed
+$ knife proxmox  template list -U https://localhost:8006/api2/json/ -n localhost -u test -p test123 -R pve -VV
+DEBUG: Using configuration from /home/jorge/workspace/chef-repo/.chef/knife.rb
+Id  Name                                                         Size  
+0   local:vztmpl/debian-6.0-request-tracker_3.8.8-2_i386.tar.gz  171 MB
+1   local:vztmpl/old_ubuntu-11.10-x86_64.tar.gz                  124 MB
+2   local:vztmpl/ubuntu-10.04-standard_10.04-4_i386.tar.gz       135 MB
+3   local:vztmpl/ubuntu-11.10-x86_64-jorge1-.tar.gz              124 MB
+4   local:vztmpl/ubuntu-11.10-x86_64-jorge2-.tar.gz              154 MB
+ 
+
+List templates available to download
+$ knife proxmox template available -U https://localhost:8006/api2/json/ -u test -p test123 -n localhost -R pve  -VV
+DEBUG: Using configuration from /home/jorge/workspace/chef-repo/.chef/knife.rb
+Name                                                       Operating System
+debian-6-turnkey-concrete5_12.0-1_i386.tar.gz              debian-6        
+ubuntu-10.04-turnkey-prestashop_11.3-1_i386.tar.gz         ubuntu-10.04    
+debian-6-turnkey-joomla25_12.0-1_i386.tar.gz               debian-6        
+debian-6-turnkey-tomcat-apache_12.0-1_i386.tar.gz          debian-6        
+debian-6.0-wordpress_3.4.2-1_i386.tar.gz                   debian-6.0 .....
+
+
+Create a server
+$ knife proxmox server create -U https://localhost:8006/api2/json/ -n localhost -u test -p test123 -R pve -N vm-node1 --template 4 -VV 
+DEBUG: Using configuration from /home/jorge/workspace/chef-repo/.chef/knife.rb
+DEBUG: vmid=303&hostname=vm-node1&storage=local&password=pve123&ostemplate=local%3Avztmpl%2Fubuntu-11.10-x86_64-jorge2-.tar.gz&memory=512&swap=512&disk=4&cpus=1&netif=ifname%3Deth0%2Cbridge%3Dvmbr0
+Result: 200
+..............................
+Starting VM 303....
+Result: 200
+
+Destroy a server
+$ knife proxmox server destroy -U https://localhost:8006/api2/json/ -u test -p test123 -n localhost -R pve -N vm-node1 -VV
+DEBUG: Using configuration from /home/jorge/workspace/chef-repo/.chef/knife.rb
+node to destroy: vm-node1
+Stopping VM 303....
+Result: 200
+..............................
+Result: 200
+
+
+[2012-10-17]
+
+First preliminar version is working, but only as separate knife plugin files.
+
+In order to work, these files must be copied to your ~/.chef/plugins/knife directory.  If it
+doesn't exist, then you must create it.
+
+Actions implemented
+
+proxmox server create
+proxmox server destroy
+proxmox template available
+proxmox template list
+
+Next steps
+
+R.E.F.A.C.T.O.R
+
+Options in command line for each action
+
+
+[2012-10-07]
+
+This project is a plugin for knife that allows a user to list templates, create and delete 
+proxmox virtual machines (openvz instances mainly)
+
+I've two ways to do this:
+A) Create a knife plugin directly using command line tools (pvesh and pvesm)
+B) Create a provider for fog (github.com/fog/fog) and then create the knife plugin based on fog
+
+Thoughts:
+Option A is the easy quick and dirty solution for me now.
+Option B is the proper way to do it.  Unfortunately, I'm not able to afford it.  It's too complex.
+
+Actions:
+Option A)
+
+. knife proxmox template list
+|- pvesh get /nodes/SERVER_NAME/storage/STORAGE/content
+|--{
+      "content" : "vztmpl",
+      "format" : "tgz",
+      "size" : 161655654,
+      "volid" : "local:vztmpl/ubuntu-11.10-x86_64-jorge2-.tar.gz"
+   },
+
+. knife proxmox server create
+|- pvesh create /nodes/localhost/openvz -ostemplate local:vztmpl/ubuntu-11.10-x86_64-jorge2-.tar.gz -vmid 106 -cpus 1 -memory 1024 -disk 4 -hostname jorge_test
+
+. knife proxmox server destroy
+|- pvesh destroy 106
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in knife-proxmox.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    knife-proxmox (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  knife-proxmox!

data/LICENSE

@@ -0,0 +1,201 @@
+                              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

@@ -0,0 +1,127 @@
+Authors: Jorge Moratilla, Sergio Galvan
+Date: 2012-10-07
+
+This knife plugin allows to access Proxmox Virtualization Environment (Proxmox VE or PVE) through its API.
+It allows you to lists templates installed on the server/cluster (like images or amis), create a server or
+destroy it.
+
+Currently it only supports management of openVZ instances, but KVM instances will be able too.
+
+
+Actions implemented
+
+proxmox server list
+proxmox server create
+proxmox server start
+proxmox server stop
+proxmox server destroy
+proxmox template available
+proxmox template list
+
+Some Examples 
+
+List servers
+$ knife proxmox server list
+Id   Node    Name                 Type    Status
+104  node-1  tetatet.jnlabs.isp   openvz  down  
+470  node-2  sg-node1.jnlabs.isp  openvz  up  
+102  node-1  test                 qemu    down  
+202  node-2  chef-client1         openvz  down 
+
+List templates installed
+$ knife proxmox  template list -U https://localhost:8006/api2/json/ -n localhost -u test -p test123 -R pve -VV
+DEBUG: Using configuration from /home/jorge/workspace/chef-repo/.chef/knife.rb
+Id  Name                                                         Size  
+0   local:vztmpl/debian-6.0-request-tracker_3.8.8-2_i386.tar.gz  171 MB
+1   local:vztmpl/old_ubuntu-11.10-x86_64.tar.gz                  124 MB
+2   local:vztmpl/ubuntu-10.04-standard_10.04-4_i386.tar.gz       135 MB
+3   local:vztmpl/ubuntu-11.10-x86_64-jorge1-.tar.gz              124 MB
+4   local:vztmpl/ubuntu-11.10-x86_64-jorge2-.tar.gz              154 MB
+ 
+
+List templates available to download
+$ knife proxmox template available -U https://localhost:8006/api2/json/ -u test -p test123 -n localhost -R pve  -VV
+DEBUG: Using configuration from /home/jorge/workspace/chef-repo/.chef/knife.rb
+Name                                                       Operating System
+debian-6-turnkey-concrete5_12.0-1_i386.tar.gz              debian-6        
+ubuntu-10.04-turnkey-prestashop_11.3-1_i386.tar.gz         ubuntu-10.04    
+debian-6-turnkey-joomla25_12.0-1_i386.tar.gz               debian-6        
+debian-6-turnkey-tomcat-apache_12.0-1_i386.tar.gz          debian-6        
+debian-6.0-wordpress_3.4.2-1_i386.tar.gz                   debian-6.0 .....
+
+
+Create a server
+$  knife proxmox server create -n ankh -r "recipe[java]" -C 2 -M 1024 -H example-server -P test123 -T 4
+Creating VM 473...
+..............OK
+Preparing the server to start
+Starting VM 473 on node ankh....
+..OK
+New Server 473 has IP Address: 10.0.2.19
+done
+Bootstrapping Chef on 10.0.2.19
+10.0.2.19 --2013-01-23 01:27:20--  http://opscode.com/chef/install.sh
+10.0.2.19 Resolving opscode.com... 
+10.0.2.19 184.106.28.83
+10.0.2.19 Connecting to opscode.com|184.106.28.83|:80... 
+10.0.2.19 connected.
+10.0.2.19 HTTP request sent, awaiting response... 
+10.0.2.19 301 Moved Permanently
+10.0.2.19 Location: http://www.opscode.com/chef/install.sh [following]
+10.0.2.19 --2013-01-23 01:27:21--  http://www.opscode.com/chef/install.sh
+10.0.2.19 Resolving www.opscode.com... 
+10.0.2.19 184.106.28.83
+10.0.2.19 Reusing existing connection to opscode.com:80.
+10.0.2.19 HTTP request sent, awaiting response... 
+10.0.2.19 200 OK
+
+
+Starting a server
+$ knife proxmox server start --vmid 401
+Starting VM 401....
+Result: 200
+
+
+Stopping a server
+$ knife proxmox server stop --vmid 103
+Stoping VM 103....
+Result: 200
+
+
+Destroy a server
+$ knife proxmox server destroy -U https://localhost:8006/api2/json/ -u test -p test123 -n localhost -R pve -N vm-node1 -VV
+DEBUG: Using configuration from /home/jorge/workspace/chef-repo/.chef/knife.rb
+node to destroy: vm-node1
+Stopping VM 303....
+Result: 200
+..............................
+Result: 200
+
+This gem must be installed on your system using the command
+
+$ gem install knife-proxmox
+
+If you want to read values from the environment variables modify your knife.rb:
+
+knife[:pve_cluster_url] ||= "#{ENV['PVE_CLUSTER_URL']}"
+knife[:pve_user_name]   ||= "#{ENV['PVE_USER_NAME']}"
+knife[:pve_node_name]   ||= "#{ENV['PVE_NODE_NAME']}"
+knife[:pve_user_realm]  ||= "#{ENV['PVE_USER_REALM']}"
+
+However I don't recommend to have the user password as a environment variable.
+knife[:pve_user_password] = "#{ENV['PVE_CLUSTER_URL']}"
+
+Environment Variables
+
+PVE_CLUSTER_URL = https://<proxmox_server>:8006/api2/json/
+PVE_USER_NAME   = <user>
+PVE_PASSWORD_NAME = <password>
+PVE_USER_REALM  = <pam|pve|others>
+PVE_NODE_NAME   = <nodename>
+
+If you want to alter some variable by command line then you can use the following options:
+-n --node <node>   If in a cluster, this argument will specify which node of the cluster will do the action
+-U --pve_cluster_url <http://localhost...> Will change the cluster to access to
+-u --username <user>   Same for user
+-p --password <pass>   Same for password
+-r --realm    <realm>  Same for the realm used to authenticate