Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Federated XDMoD description to About page #873

Merged
merged 4 commits into from
Mar 26, 2019
Merged

Add Federated XDMoD description to About page #873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
461aa4c
Add Federated to About
plessbd Mar 25, 2019
60244a3
Make travis happy, remove imagine
plessbd Mar 25, 2019
f5b0e99
per code review
plessbd Mar 25, 2019
18e5f8e
more review
plessbd Mar 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 113 additions & 0 deletions html/about/federated.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
<?php
namespace Xdmod\About;

require_once __DIR__ . '/../../configuration/linker.php';
use CCR\DB;
?>
<h1>Federated Open XDMoD</h1>
<p>
Federated XDMoD supports the collection and aggregation of data from a number of fully-functional and individually managed XDMoD instances into a single federated instance of XDMoD capable of displaying federation-wide metrics.
Each participating institution deploys an XDMoD instance through which local data will be collected and shipped to a central Federation Hub where it is aggregated to provide a federation-wide view of the data.
Data particular to an individual center is available from the Hub by applying filters and drill-downs.
</p>
<p>
<div style="text-align:center; width:65%;">
<img src="/about/images/federated-diagram-1.gif" />
<div>
<fig>
<em>
Example data flow from heterogeneous computing resources to an XDMoD federated hub.
XDMoD instances X and Y ingest data into their databases from the computing resources that they monitor.
Following ingestion on the satellite instances, job data are replicated to the federated hub's database, where they are aggregated for use in the federated XDMoD user interface.
</em>
</fig>
</div>
</div>
</p>
<p>
A simple example use of the federated module is:
Three academic instituitions each with their own HPC resource.
Each institution has its own XDMoD instance which contains the accounting data for only their HPC resource.
These institutions federate their data to a central hub.
HPC accounting data for all three HPC resources is shown on the central hub.
This central hub can then be used to report on the combined data.
</p>
<p>
This example illistrates only one use case.
The federated module supports cloud data as well as HPC. Support for other data realms is planned.
There are no pre defined limits on the number of instances that can be part of a federation.
</p>
<p>
For more information see Section II of <a href="https://ieeexplore.ieee.org/document/8514918">Federating XDMoD to Monitor Affiliated Computing Resources</a>.
</p>
<p>
Documentation avialable at <a href="https://federated.xdmod.org">https://federated.xdmod.org</a>.
</p>
<p>
Source code and downloads at <a href="https://github.com/ubccr/xdmod-federated">https://github.com/ubccr/xdmod-federated</a>.
</p>
<?php

/**
* Attempt to retrieve a value from the configuration located at
* $section->$key.
*
* @param str $section the section in which the desired value resides.
* @param str $key the key under which the desired value can be found.
* @param mixed $default the default value to provide if there is nothing found.
*
* @return mixed
**/
function getConfigValue($section, $key, $default = null)
{
try {
$result = \xd_utilities\getConfiguration($section, $key);
} catch(\Exception $e) {
$result = $default;
}
return $result;
}

$role = getConfigValue('federated', 'role');
if($role === 'instance'){
$hubUrl = getConfigValue('federated', 'huburl');
echo '<h2>This instance is part of a federation</h2>';
echo 'Federation Hub: <a href="' . $hubUrl .'">' . $hubUrl .'</a>';
}
elseif ($role === 'hub'){
$db = DB::factory('datawarehouse');
$instanceResults = $db->query('SELECT * FROM federation_instances;');
$instances = array();
$lastCloudQuery = array();
$derived = 1;
foreach ($instanceResults as $instance) {
$prefix = $instance['prefix'];
$extra = json_decode($instance['extra'], true);
$instances[$prefix] = array(
'contact' => $extra['contact'],
'url' => $extra['url'],
'lastCloudEvent' => null,
'lastJobTask' => null
);
unset($extra['contact']);
unset($extra['url']);
$instances[$prefix]['extra'] = $extra;
array_push(
$lastCloudQuery,
'(SELECT \'' . $prefix . '\' AS prefix, FROM_UNIXTIME(event_time_ts) as event_ts FROM `' . $prefix . '-modw_cloud`.`event` ORDER BY 2 DESC LIMIT 1) `A' . $derived . '`'
);
$derived++;
}
$lastCloudResults = $db->query('SELECT * FROM ' . implode($lastCloudQuery, ' UNION ALL SELECT * FROM '));
foreach ($lastCloudResults as $result) {
$instances[$result['prefix']]['lastCloudEvent'] = $result['event_ts'];
}
echo '<h2>Instances that are part of this Federation</h2><ul>';
foreach($instances as $instance){
echo '<li><p><a href="' . $instance['url'] . '">' . $instance['url'] . '</a></p>last event retrieved (' . $instance['lastCloudEvent'] . ')</li>';
}
echo '</ul>';
}
else {
echo 'This installation is not part of a federation.';
}
Binary file added html/about/images/federated-diagram-1.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 26 additions & 38 deletions html/gui/js/modules/About.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,16 @@ XDMoD.Module.About = Ext.extend(XDMoD.PortalModule, {

title: 'About',
module_id: 'about_xdmod',

// ------------------------------------------------------------------

initComponent: function () {

var basePath = '#main_tab_panel:' + this.module_id + '?';
var lastViewed = 'XDMoD';

var contentPanel = new Ext.Panel({
region: 'center',
preventBodyReset: true, // Don't override default css styles in this panel
autoScroll: true,
bodyCssClass: "xdmod-aboutus"
});


var treeNodeClick = function(node) {
Ext.History.add(basePath + encodeURIComponent(node.text));
};
Expand All @@ -30,71 +24,79 @@ XDMoD.Module.About = Ext.extend(XDMoD.PortalModule, {
icon: '/gui/images/info.png',
leaf: true,
listeners: {
'click': treeNodeClick
click: treeNodeClick
} // listeners
},
{
text: 'Open XDMoD',
icon: '/gui/images/info.png',
leaf: true,
listeners: {
'click': treeNodeClick
click: treeNodeClick
} // listeners
},
{
text: 'SUPReMM',
icon: '/gui/images/info.png',
leaf: true,
listeners: {
'click': treeNodeClick
click: treeNodeClick
} // listeners
},
{
text: 'Federated',
icon: '/gui/images/menu.png',
leaf: true,
listeners: {
click: treeNodeClick
} // listeners
},
{
text: 'Roadmap',
icon: '/gui/images/lorry.png',
leaf: true,
listeners: {
'click': treeNodeClick
click: treeNodeClick
} // listeners
},
{
text: 'Team',
icon: '/gui/images/person.png',
leaf: true,
listeners: {
'click': treeNodeClick
click: treeNodeClick
} // listeners
},
{
text: 'Publications',
icon: '/gui/images/user_manual_16.png',
leaf: true,
listeners: {
'click': treeNodeClick
click: treeNodeClick
} // listeners
},
{
text: 'Presentations',
icon: '/gui/images/user_manual_16.png',
leaf: true,
listeners: {
'click': treeNodeClick
click: treeNodeClick
} // listeners
},
{
text: 'Links',
icon: '/gui/images/arrow_right.png',
leaf: true,
listeners: {
'click': treeNodeClick
click: treeNodeClick
} // listeners
},
{
text: 'Release Notes',
icon: '/gui/images/user_manual_16.png',
leaf: true,
listeners: {
'click': treeNodeClick
click: treeNodeClick
} // listeners
}
] // children
Expand All @@ -115,42 +117,36 @@ XDMoD.Module.About = Ext.extend(XDMoD.PortalModule, {
};

var mainArea = new Ext.Panel({

layout: 'border',
region: 'center',
items: [
westPanel,
contentPanel
]

});//mainArea

this.addListener('activate', function() {

var item = decodeURIComponent(CCR.tokenize(Ext.History.getToken()).params);

var items = {
'XDMoD': '/about/xdmod.php',
XDMoD: '/about/xdmod.php',
'Open XDMoD': '/about/openxd.html',
'SUPReMM': '/about/supremm.html',
'Roadmap': '/about/roadmap.php',
'Team': '/about/team.html',
'Publications': '/about/publications.html',
'Presentations': '/about/presentations.html',
'Links': '/about/links.html',
SUPReMM: '/about/supremm.html',
Federated: '/about/federated.php',
Roadmap: '/about/roadmap.php',
Team: '/about/team.html',
Publications: '/about/publications.html',
Presentations: '/about/presentations.html',
Links: '/about/links.html',
'Release Notes': '/about/release_notes/' + (CCR.xdmod.features.xsede ? 'xsede.html' : 'xdmod.html')
};

if (!item || !items[item]) {
item = lastViewed;
}

Ext.Ajax.request({
url: items[item],
success: function(response) {
success: function (response) {
contentPanel.body.update(response.responseText);
lastViewed = item;

var treeNode = Ext.getCmp('treepanel').getRootNode().findChild('text', item);
if (treeNode) {
treeNode.select();
Expand All @@ -159,19 +155,11 @@ XDMoD.Module.About = Ext.extend(XDMoD.PortalModule, {
}
});
});

// ==============================================

Ext.apply(this, {

items: [
mainArea
]

});//Ext.apply

XDMoD.Module.About.superclass.initComponent.apply(this, arguments);

} //initComponent

}); //XDMoD.Module.NewModule