Derez Blog: January 2013

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

Derez Blog

Thursday, January 17, 2013

oVirt WebAdmin + ShellInABox UI Plugin