Difference between revisions of "VRE Administration"

From Gcube Wiki
Jump to: navigation, search
m (→‎VRE Users Management)
 
(45 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
{| align="right"
+
[[Category:Administrator's Guide]]
−
| __TOC__
+
−
|}
+
  
−
Virtual Research Environments (VREs) are the cooperation environments defined in the context of a ''Virtual Organisation'' (VO) user communities are provided with to accomplish specific tasks. These cooperation environments are equipped with specific facilities and resources (e.g. collections and data sources) deemed relevant with respect to the application scenario the VRE has been conceived for. The overall resources (e.g. computing resources, collection, services) supporting the operation of the VRE are dynamically aggregated by relying on those forming the VO while the operation of the VRE is automatically guaranteed by the set of services forming the [[Core Services Installation|Core Services]].  
+
A Virtual Research Environment (VRE) is an application with the following characteristics: (i) it is a Web-based working environment; (ii) it is tailored to serve the needs of a Community of Practice; (iii) it is expected to provide a community of practice with the whole array of commodities needed to accomplish the community’s goal(s); (iv) it is open and flexible with respect to the overall service offering and lifetime; and (v) it promotes fine-grained controlled sharing of both intermediate and final research results by guaranteeing ownership, provenance, and attribution.
  
 
The administration of these cooperation environments is a four tasks activity envisaging:
 
The administration of these cooperation environments is a four tasks activity envisaging:
Line 18: Line 16:
  
 
This portlet guide the VRE Designer through the following steps:
 
This portlet guide the VRE Designer through the following steps:
−
# '''''VRE Profile Specification''''': the VRE Designer should enter data characterising the VRE profile. In particular, he/she should specify the ''VRE name'' and the ''VRE description'', should select the user that will play the role of ''VRE Manager'' (by selecting among the pool of users having such privilege in the Virtual Organisation the VRE will operate in) and should specify the expected duration time, i.e. the start date and the end date characterising the lifetime of the VRE;  
+
# '''''VRE Profile Information''''': the VRE Designer should enter data characterising the VRE profile. In particular, he/she should specify the ''VRE name'' and the ''VRE description'', should select the user that will play the role of ''VRE Manager'' (by selecting among the pool of users having such privilege in the Virtual Organisation the VRE will operate in) and should specify the expected duration time, i.e. the start date and the end date characterising the lifetime of the VRE;  
−
# '''''Collection Selection''''': the VRE Designer is provided with the list of collections currently available in the Virtual Organisation the VRE will operate in and, by relying on the description of these data sources, should identify those pertinent to the application scenario the VRE is devised for. For each collection, the VRE Designer is provided with a description and other information like the number of elements or the creation date helping to identify the proper ones; 
+
#: [[File:VRE-Definition.png|thumb|center|700px|Figure 1. VRE Profile Information]]
−
# '''''Metadata Selection''''': the VRE Designer is provided with the list of metadata formats collection items can be described with and should identify those pertinent to the application scenario the VRE is devised for. For each collection the VRE Designer can select one or more metadata formats. These metadata formats will characterise some of the functionality of the resulting VRE, e.g. the end users will rely on them to discover the information objects in the collection VREs. For each metadata format the VRE Designer is provided with descriptive information; 
+
# '''''Functionality Selection''''': the VRE Designer is provided with the list of [https://www.gcube-system.org/catalogue-of-applications Application Bundles] containing functionality that can be deployed and should identify those pertinent to the application scenario the VRE is devised for.  
−
# '''''Functionality Selection''''': the VRE Designer is provided with the list of functionality that can be deployed and should identify those pertinent to the application scenario the VRE is devised for. For each functionality, the VRE Designer is provided with descriptive information;
+
For each functionality, the VRE Designer is provided with descriptive information; Moreover for some functionality it is possible to select related resources to make available in the VRE (e.g. for the StatsCube application bundle, the Statistical Service application provides the list of Statistical Algorithms available for deployment as shown in Figure 2.
 +
#:[[File:VRE Application Bundles.png|thumb|center|700px|Figure 2. Functionality Selection shows the Statistical Service application providing the list of Statistical Algorithms available for deployment.]]
 
# '''''VRE Specification Summary''''': the VRE Designer is provided with the overall specification resulting from the previous steps and should either submit this specification for approval or change some of the choices.
 
# '''''VRE Specification Summary''''': the VRE Designer is provided with the overall specification resulting from the previous steps and should either submit this specification for approval or change some of the choices.
−
 
+
#:[[File:VRE Summary.png|thumb|center|700px|Figure 3. VRE Specification Summary]]
−
<gallery>
+
−
Image:VREStart.png|Wizard Welcome Page
+
−
Image:VREInformation.png|VRE Profile Specification
+
−
Image:VRECollections.png|Collection Selection
+
−
Image:VREMetadataFormats.png|Metadata Selection
+
−
Image:VREFunctionality.png|Functionality Selection
+
−
Image:VRESpecSummary.png|VRE Specification Summary
+
−
</gallery>
+
  
 
== VRE Approval ==
 
== VRE Approval ==
−
Approving the Virtual Research Environment
 
  
−
== VRE Verification ==
+
The VRE Approval is the action performed after the definition phase aiming at actually deploying the VRE.
−
Verifying the Virtual Research Environment correctness
+
  
−
== VRE Management ==
+
To perform this action, the VRE Manager should use the VRE Deployment portlet. This portlet list the existing VREs with their status as depicted below:
−
Managing the Virtual Research Environment
+
  
−
=== VRE Layout Specification ===
+
:: [[File:VREDeploument.png|700px|VRE Deployment Portlet]]
  
−
The VRE layout characterises the arrangement of the VRE graphical user interface. In particular, it specifies how the user interface main constituents, i.e. the portlets, are arranged in tabs, sub-tabs, rows and columns.  
+
VRE to be approved are in the "Pending" status. By using the "Action" menu, the VRE Manager can decide to analyze the VRE definition ("View Definition"), edit a VRE definition produced by a VRE Designer ("Edit"), start the approval phase ("Approve") or withdraw the VRE designed by a VRE Designer ("Withdraw").
  
−
To create this layout, the VRE Manager should use the [[Layout Generator]], a user friendly interface through which
+
The VRE approval phase relies on the VRE wizard exploited during the [[VRE_Administration#VRE_Definition|VRE definition phase]], i.e. the VRE Manager will analyze the VRE specification by going through the same steps performed by the designer. Going through these steps, the VRE Manager is entitled to revise the VRE Specification. In addition to these steps the VRE Manager is requested to perform the action needed to characterise the VRE from an architectural point of view. Thus, the steps the VRE Manager will be guided through are:
−
* tabs and sub-tabs can be created, and  
+
# '''''VRE Profile Specification''''': the VRE Manager should check (and revise if needed) the data characterising the VRE profile including the ''VRE name'', the ''VRE description'', and the expected duration time, i.e. the start date and the end date characterising the lifetime of the VRE;  
−
* portlets can be placed in the area identified by sub-tab;
+
  
−
[[Image:LayoutGenerator.jpg|Layout Generator Interface]]
+
# '''''Collection Selection''''': the VRE Manager should check (and revise if needed) the set of selected collections. For each collection, the VRE Manager is provided with a description and other information like the number of elements or the creation date helping to identify the proper ones;
 +
# '''''Functionality Selection''''': the VRE Manager should check (and revise if needed) the set of selected functionality that will be deployed to serve the needs of the application scenario the VRE is devised for. For each functionality, the VRE Manager is provided with descriptive information;
  
−
Information on how to use the Layout Generator are available [[Layout Generator|here]]
+
# '''''VRE Architecture Specification''''': the VRE Manager should select the candidate GHNs the system will use to deploy the VRE services. This selection should match a set of conditions:
 +
## '''''at least two GHNs''''' should be identified;
 +
## '''''one''''' of the selected '''''GHN must be marked for hosting the VRE Manager''''';
 +
## the '''''node candidate to host the VRE Manager service should not host this service''''' (for serving another VRE);
 +
#:[[File:VRE-Deployer.png|700px]]
 +
# '''''VRE Specification Summary''''': the VRE Manager is provided with the overall specification resulting from the previous steps and should either start the deployment ("Create") or change some of the choices.
 +
#:[[File:Summary2.png|700px]]
  
−
=== VRE Information Space Specification ===
+
During the deployment phase, the VRE Manager is provided with a living report that shows the actions performed by the system (e.g. deployment of a new service) during the initial steps of this activity. The rest of the deployment phase can be monitored by using the VRE Deployment portlet that provides the VRE Manager with a comprehensive report for VREs the deployment task have been lunched, both for those successfully deployed as well as for those that have not successfully deployed. An example of the information contained in this report is depicted in the picture below.
  
−
The VRE Information Space characterises the arrangement of the VRE collections into a hierarchy. In particular, it specifies how the VRE collections are organised in groups and sub-groups.  
+
:: [[File:VRE-report.png|800px]]
  
−
To create this layout, the VRE Manager should use the [[Information Space Editor]], a user friendly interface through which
+
For VREs successfully deployed, the VRE Manager should perform the [[VRE_Administration#VRE_Verification|verification phase]] before to release the service to the user community.
−
* groups and sub-groups can be created;
+
−
* VRE collections can be assigned to a group by dragging it;
+
−
* collection information can be edited.
+
  
−
Information on how to use the Layout Generator are available [[Information Space Editor|here]].
+
== VRE Verification ==
 +
 
 +
VRE Verification is the action performed by the VRE Manager to check the features of the deployed VRE.
 +
 
 +
This action includes two steps:
 +
* the [[VRE_Administration#VRE_Monitoring|check of the status of the VRE resources]];
 +
* the actual test of the VRE. In this phase, the VRE Manager should log in the just created VRE and go through the various functionality the VRE is conceived to realise to test their compliance with the requirement and their effectiveness. There is no tool supporting this step except the portal.
 +
 
 +
Once this test is complete, the VRE Manager can start [[VRE_Administration|managing the VRE]], e.g. inform the community on the availability of this new VRE and [[VRE_Administration#VRE_Users_Management|start managing requests for membership]].
 +
 
 +
== VRE Management ==
 +
 
 +
VRE Management includes the activities performed during the VRE operation in order to revise the behaviour of the application. It includes
 +
* the [[VRE_Administration#VRE_Layout_Specification|revision of the VRE user interface]];
 +
* the [[VRE_Administration#VRE_Information_Space_Specification|revision of the Information Space]];
 +
* the [[VRE_Administration#VRE_Users_Management|management of the VRE users and roles]];
 +
* the [[VRE_Administration#VRE_Monitoring|monitoring of the status of the resources partaking to the VRE]].
 +
 
 +
=== VRE Layout Specification ===
 +
 
 +
The VRE layout characterises the arrangement of the VRE graphical user interface. In particular, it specifies how the user interface main constituents, i.e. the portlets, are arranged in tabs, sub-tabs, rows and columns.
 +
 
 +
The D4Science portal is based on the[http://www.liferay.com/ Liferay portal] and uses liferay's base functionality to manage the layout of each VO/VRE.
 +
For more information visit the Liferay's official documentation [http://www.liferay.com/community/wiki/-/wiki/Main/Managing+End-User+Pages Liferay portal: Pages' Management]
  
 
=== VRE Users Management ===
 
=== VRE Users Management ===
Line 71: Line 85:
 
In order to manage the pool of users of a VRE, the VRE Manager should use the [[Users' Management|Users Management Portlet]], a user friendly interface through which he/she can
 
In order to manage the pool of users of a VRE, the VRE Manager should use the [[Users' Management|Users Management Portlet]], a user friendly interface through which he/she can
 
* manage request for membership;  
 
* manage request for membership;  
−
* assign roles to the users;
+
* revise the roles a users is entitled to play;
 
* remove users.
 
* remove users.
  
Line 77: Line 91:
  
 
=== VRE Monitoring ===
 
=== VRE Monitoring ===
−
Monitoring the Virtual Research Environment through the Information System
+
 
 +
VRE Monitoring is the action through which the VRE Manager checks the status and quality of the resources partaking to the VRE.
 +
 
 +
This activity is performed by using the gCube [[Monitoring System]], an example of these view is reported in the picture below.
 +
 
 +
[[File:Monitor.png|800px]]

Latest revision as of 15:35, 25 August 2016


A Virtual Research Environment (VRE) is an application with the following characteristics: (i) it is a Web-based working environment; (ii) it is tailored to serve the needs of a Community of Practice; (iii) it is expected to provide a community of practice with the whole array of commodities needed to accomplish the community’s goal(s); (iv) it is open and flexible with respect to the overall service offering and lifetime; and (v) it promotes fine-grained controlled sharing of both intermediate and final research results by guaranteeing ownership, provenance, and attribution.

The administration of these cooperation environments is a four tasks activity envisaging:

  • a definition phase in which a user having the role of VRE Designer specifies the characteristics of a new VRE conceived to serve an application scenario;
  • an approval phase in which a user having the role of VRE Manager decides whether the specified VREs have to be accepted or rejected. For what is concerned with the accepted VRE, the VRE Manager decides also how this VRE has to be deployed, e.g. which hosting nodes will be exploited;
  • a verification phase in which a user having the role of VRE Manager validates a VRE resulting from the approval phase;
  • a management phase in which a user having the role of VRE Manager operates on a deployed VRE in order to customise specific aspects (e.g. the layout governing the placement of user interfaces constituents a.k.a. portlets) or monitor the operational state of the VRE as a whole.

VRE Definition

The VRE Definition is the procedure performed by the VRE Designer and leading to the specification of a Virtual Research Environment, i.e. the selection of the resources and the identification of other characteristics describing the desiderata for a VRE devised to serve the needs of a specific community.

This procedure is supported by a dedicated portlet, the VRE Definition Portlet, that implements a wizard-based approach.

This portlet guide the VRE Designer through the following steps:

  1. VRE Profile Information: the VRE Designer should enter data characterising the VRE profile. In particular, he/she should specify the VRE name and the VRE description, should select the user that will play the role of VRE Manager (by selecting among the pool of users having such privilege in the Virtual Organisation the VRE will operate in) and should specify the expected duration time, i.e. the start date and the end date characterising the lifetime of the VRE;
    Figure 1. VRE Profile Information
  2. Functionality Selection: the VRE Designer is provided with the list of Application Bundles containing functionality that can be deployed and should identify those pertinent to the application scenario the VRE is devised for.

For each functionality, the VRE Designer is provided with descriptive information; Moreover for some functionality it is possible to select related resources to make available in the VRE (e.g. for the StatsCube application bundle, the Statistical Service application provides the list of Statistical Algorithms available for deployment as shown in Figure 2.

  1. Figure 2. Functionality Selection shows the Statistical Service application providing the list of Statistical Algorithms available for deployment.
  2. VRE Specification Summary: the VRE Designer is provided with the overall specification resulting from the previous steps and should either submit this specification for approval or change some of the choices.
    Figure 3. VRE Specification Summary

VRE Approval

The VRE Approval is the action performed after the definition phase aiming at actually deploying the VRE.

To perform this action, the VRE Manager should use the VRE Deployment portlet. This portlet list the existing VREs with their status as depicted below:

VRE Deployment Portlet

VRE to be approved are in the "Pending" status. By using the "Action" menu, the VRE Manager can decide to analyze the VRE definition ("View Definition"), edit a VRE definition produced by a VRE Designer ("Edit"), start the approval phase ("Approve") or withdraw the VRE designed by a VRE Designer ("Withdraw").

The VRE approval phase relies on the VRE wizard exploited during the VRE definition phase, i.e. the VRE Manager will analyze the VRE specification by going through the same steps performed by the designer. Going through these steps, the VRE Manager is entitled to revise the VRE Specification. In addition to these steps the VRE Manager is requested to perform the action needed to characterise the VRE from an architectural point of view. Thus, the steps the VRE Manager will be guided through are:

  1. VRE Profile Specification: the VRE Manager should check (and revise if needed) the data characterising the VRE profile including the VRE name, the VRE description, and the expected duration time, i.e. the start date and the end date characterising the lifetime of the VRE;
  1. Collection Selection: the VRE Manager should check (and revise if needed) the set of selected collections. For each collection, the VRE Manager is provided with a description and other information like the number of elements or the creation date helping to identify the proper ones;
  2. Functionality Selection: the VRE Manager should check (and revise if needed) the set of selected functionality that will be deployed to serve the needs of the application scenario the VRE is devised for. For each functionality, the VRE Manager is provided with descriptive information;
  1. VRE Architecture Specification: the VRE Manager should select the candidate GHNs the system will use to deploy the VRE services. This selection should match a set of conditions:
    1. at least two GHNs should be identified;
    2. one of the selected GHN must be marked for hosting the VRE Manager;
    3. the node candidate to host the VRE Manager service should not host this service (for serving another VRE);
    VRE-Deployer.png
  2. VRE Specification Summary: the VRE Manager is provided with the overall specification resulting from the previous steps and should either start the deployment ("Create") or change some of the choices.
    Summary2.png

During the deployment phase, the VRE Manager is provided with a living report that shows the actions performed by the system (e.g. deployment of a new service) during the initial steps of this activity. The rest of the deployment phase can be monitored by using the VRE Deployment portlet that provides the VRE Manager with a comprehensive report for VREs the deployment task have been lunched, both for those successfully deployed as well as for those that have not successfully deployed. An example of the information contained in this report is depicted in the picture below.

VRE-report.png

For VREs successfully deployed, the VRE Manager should perform the verification phase before to release the service to the user community.

VRE Verification

VRE Verification is the action performed by the VRE Manager to check the features of the deployed VRE.

This action includes two steps:

  • the check of the status of the VRE resources;
  • the actual test of the VRE. In this phase, the VRE Manager should log in the just created VRE and go through the various functionality the VRE is conceived to realise to test their compliance with the requirement and their effectiveness. There is no tool supporting this step except the portal.

Once this test is complete, the VRE Manager can start managing the VRE, e.g. inform the community on the availability of this new VRE and start managing requests for membership.

VRE Management

VRE Management includes the activities performed during the VRE operation in order to revise the behaviour of the application. It includes

VRE Layout Specification

The VRE layout characterises the arrangement of the VRE graphical user interface. In particular, it specifies how the user interface main constituents, i.e. the portlets, are arranged in tabs, sub-tabs, rows and columns.

The D4Science portal is based on theLiferay portal and uses liferay's base functionality to manage the layout of each VO/VRE. For more information visit the Liferay's official documentation Liferay portal: Pages' Management

VRE Users Management

A VRE is an application conceived to serve the needs of a well defined pool of people, its users.

In order to manage the pool of users of a VRE, the VRE Manager should use the Users Management Portlet, a user friendly interface through which he/she can

  • manage request for membership;
  • revise the roles a users is entitled to play;
  • remove users.

Information on how to use the portlet are available here.

VRE Monitoring

VRE Monitoring is the action through which the VRE Manager checks the status and quality of the resources partaking to the VRE.

This activity is performed by using the gCube Monitoring System, an example of these view is reported in the picture below.

Monitor.png

Retrieved from "https://gcube.wiki.gcube-system.org/index.php?title=VRE_Administration&oldid=26487"