== Virtual Cluster ==

---- dataentry addon ----
name               : IS4AC Virtual Cluster
url_url            : https://github.com/is4ac-ismb/oneVirtualCluster
brief description  : The IS4AC Virtual Cluster Plugin for OpenNebula allows users to deploy and manage virtual cluster directly from Sunstone GUI, with easy steps and standard OpenNebula interfaces.
type               : Tool
license            : Apache v2 License
opennebula version : 4.0.1 and 4.2.0
author             : IS4AC @ ISMB
email              : is4ac_one at ismb.it
organization_img100 :  {{ users:ismb.png }}
keyword_tags       : cluster, sunstone
last update_dt     : 2013-11-26
----

== Description ==

The IS4AC Virtual Cluster Plugin for OpenNebula allows users to deploy and manage virtual clusters directly from Sunstone GUI, with easy steps and standard OpenNebula interfaces.

== Benefits ==

With IS4AC Virtual Cluster Sunstone plugin it is possible to specify a master node and an arbitrary number of compute nodes that will be deployed with easy steps and standard Open Nebula interfaces.  
In this way, the user can quickly setup a set of VMs according to a Beowulf cluster architecture. The templates of the nodes are updated just before the deployment, to transmit to each VM the information needed to configure the networking with other nodes of the cluster.
Please, refer to [[https://github.com/is4ac-ismb/oneVirtualCluster|our github page]] for further information.

==  Installation instructions ==

Actually, the plugin is suitable for the versions of Sunstone included in Open Nebula 4.0.1 and 4.2.0 and for the SQLite database.

Reference to OpenNebula folders: \\ 
 - Open Nebula installation: /usr/lib/one/ \\ 
 - Open Nebula ruby folder: /usr/lib/one/ruby/ \\ 
 - OpenNebula ruby/opennebula/ folder: /usr/lib/one/ruby/opennebula/ \\ 
 - Sunstone installation: /usr/lib/one/sunstone \\ 
 - Sunstone models folder: /usr/lib/one/sunstone/models/ \\ 
 - Sunstone javascript folder: /usr/lib/one/sunstone/public/js/ \\ 
 - Sunstone plugins folder: /usr/lib/one/sunstone/public/js/plugins/ \\ 

=== Changed files ===
Replace the following files with those provided by the plugin: \\ 
 - //SunstoneServer.rb// in the models folder of Sunstone installation; \\ 
 - //OpenNebulaJSON.rb// in the ruby folder of Open Nebula installation; \\ 
 - //opennebula.js// in the public/js/ folder of Sunstone installation; \\ 
 - //OpenNebula.rb// (opennebula.rb for version ≥ 4.0.1) in the ruby folder of Open Nebula installation. \\ 
 

=== New files ===
Add the following files: \\ 
 - //vclusters-tab.js// in the plugins folder of Sunstone installation; \\ 
 - //VirtualClusterJSON.rb// in the ruby/OpenNebulaJSON folder of Open Nebula installation; \\ 
 - //virtual_cluster.rb// in the ruby/opennebula/ folder of Open Nebula installation. \\ 

=== Database changes ===
Manually execute the following queries to one.db: \\ 
//virtual_cluster_pool// table creation: 
    CREATE TABLE virtual_cluster_pool (oid INTEGER PRIMARY KEY, name VARCHAR(128), body TEXT, uid INTEGER, gid INTEGER, owner_u INTEGER, group_u INTEGER, other_u INTEGER, UNIQUE(name));
//vcluster_vm_control// table creation (to manage vms-vclusters associations): 
    CREATE TABLE vcluster_vm_control (vm_id INTEGER PRIMARY KEY REFERENCES vm_pool(oid) ON DELETE CASCADE, vcluster_id INTEGER REFERENCES virtual_cluster_pool(oid) ON DELETE CASCADE);
Row for virtual cluster pool in //pool_control// the table: 
    INSERT INTO pool_control VALUES('virtual_cluster_pool', '0');

=== Plugin tab registration ===  
To register the virtual cluster tab in Sunstone, insert the vclusters-tab row entry in the available_tabs section of the file /etc/one/sunstone-views.yaml. 
Insert the vclusters-tab row entry at the first part of the file /etc/one/sunstone-views/.yaml for the views you want the plugin to be enabled, between the files-tab and infra-tab entries as shown below:

In the same files, append the following lines under the vresources-tab and before the “infra-tab:” row.

  vclusters-tab: 
    panel_tabs: 
        vcluster_info_tab: true 
        vcluster_monitoring_tab: true 
        vcluster_vms_tab: true 
    table_columns: 
        - 0         # Checkbox 
        - 1         # ID 
        - 2         # Name 
        - 3         # Virtual Machines 
    actions: 
        Vcluster.create: true 
        Vcluster.create_dialog: true 
        Vcluster.refresh: true 
        Vcluster.autorefresh: true 
        Vcluster.list: true 
        Vcluster.help: true 
        Vcluster.showinfo: true 
        Vcluster.addvm: true 
        Vcluster.delete: true 
        Vcluster.monitor_vm: true 

If you still haven't customized the admin view (admin.yaml file), you can replace it with the one provided inside the plugin folder.