Derez Blog: oVirt WebAdmin + ShellInABox UI Plugin

Inspired by a recent post on Oved's blog regarding the new UI-plugins infrastructure
introduced by oVirt, I've decided to take my chances and create one myself.

The Challenge

Using oVirt WebAdmin, make SSH connection to a host and emulate a terminal.

Hosts main-tab -> create a 'Shell Box' action button
Hosts main-tab -> create a 'Shell Box' sub-tab

The Means

Shell In A Box: http://code.google.com/p/shellinabox/

Source code - http://code.google.com/p/shellinabox/downloads/list
Binary - http://rpmfind.net/linux/rpm2html/search.php?query=shellinabox

The Implementation

oVirt Engine side

Create 'shellbox.json' file under '/usr/share/ovirt-engine/ui-plugins'
(a plugin configuration file):
{ "name": "ShellBoxPlugin", "url": "/webadmin/webadmin/plugin/ShellBoxPlugin/start.html", "resourcePath": "shellbox-files" }
Create 'start.html' file under '/usr/share/ovirt-engine/shellbox-files'
(the iframe content HTML file):
<!DOCTYPE html> <html> <head> <script type='text/javascript'> var api = parent.pluginApi('ShellBoxPlugin'); api.register({ UiInit : function() { // Add 'Shell Box' sub-tab under 'Hosts' main-tab api.addSubTab('Host', 'Shell Box', 'shell-box', ''); // Add 'Shell Box' button (+ context menu) // to 'Hosts' main-tab api.addMainTabActionButton('Host', 'Shell Box', { onClick : function() { window.open(getShellBoxUrl(arguments), '_blank'); }, isEnabled : function() { // The button is enabled only when a // single host is selected return arguments.length == 1; }, isAccessible : function() { // The button is always visible return true; } }); }, HostSelectionChange : function() { if (arguments.length == 1) { // Update iframe URL on host selection api.setTabContentUrl( 'shell-box', getShellBoxUrl(arguments)); } }, }); api.ready(); // Get 'Shell Box' URL using specified host address var getShellBoxUrl = function(arguments) { var hostAddress = arguments[0].name; var port = '4200'; var shellUrl = 'http://' + hostAddress + ':' + port; return shellUrl; } </script> </head> <body> </body> </html>

Host side

Download and Install 'shellinabox': http://rpmfind.net/linux/rpm2html/search.php?query=shellinabox
Edit configuration file '/etc/sysconfig/shellinaboxd':
Replace 'OPTS="-s /:LOGIN"' with 'OPTS="--disable-ssl --service /:SSH"'
Start 'shellinabox' service

The Results

Shell Box sub-tab:

Shell Box action button (+ context menu):

Shell Box on a new browser tab:

The Source Code on oVirt

Thanks!

For UI-plugins infrastructure: Vojtech Szocs
For oVirt-Foreman UI Plugin: Oved Ourfali

5 comments:

UnknownJanuary 18, 2013 at 6:56 AM
Can it be enhanced to also show up at the VM's tab?
UnknownJanuary 19, 2013 at 11:17 PM
Joop - Adding the sub-tab and action button shouldn't be difficult.
The problem is understanding the FQDN or ip address of the VM.
If the assumption is that the VM name is the FQDN, then it should be easy.

It would require adding a section (next to the one already available)
api.addMainTabActionButton('VirtualMachine', 'Shell Box', {
onClick : function() {
window.open(getShellBoxUrl(arguments), '_blank');
},
isEnabled : function() {
// The button is enabled only when a
// single VM is selected
return arguments.length == 1;
},
isAccessible : function() {
// The button is always visible
return true;
}
});

// Add 'Shell Box' sub-tab under 'Hosts' main-tab
api.addSubTab('VirtualMachine', 'Shell Box', 'vm-shell-box', '');

VirtualMachineSelectionChange : function() {
if (arguments.length == 1) {
// Update iframe URL on host selection
api.setTabContentUrl(
'vm-shell-box', getShellBoxUrl(arguments));
}
},
AsafJanuary 20, 2013 at 5:03 AM
Cool !!!
UnknownJanuary 20, 2013 at 5:47 AM
Awesome!
CCFebruary 6, 2014 at 2:11 PM
This looks cool although I've not been able to make it work.

Should "Create 'start.html' file under '/usr/share/ovirt-engine/shellbox-files'" actually be "Create 'start.html' file under '/usr/share/ovirt-engine/ui-plugins/shellbox-files'"?

I see the 'Shell Box' tab but it is always empty. When I do a 'tcpdump -i eth0 port 4200' on the RHEV-M node I see no traffic. When I do the equivalent on the fat RHEL hypervisors, I see nothing.

Note that I'm not runing oVirt but RHEV-M 3.3.

Thanks