GridSafe Documentation

Grid-SAFE is a software framework designed to support accounting, reporting and usage monitoring, and resource management on advanced computing facilities. It comprises of a number of modularised components which may function as separate applications, or be assembled to provide end-to-end applications for monitoring resource use on HPC systems. The structure and interaction of the Grid-SAFE software framework is shown in the following pictures:

The current components available under the Grid-SAFE framework are:

• WebAcct: The web accounting portal. Allows usage records presented in multiple formats to be persistently stored in a relational database. Once stored, complex reports detailing the records may be generated in multiple formats. A web based interface is presented to allow multiple users to upload records and generate reports. This code base also comes with a command line tool to allow scripts access to most functions without going through the web interface.
• SafeRupi: An implementation of the Resource Usage Publishing Interface (RUPI) specification being developed by the RUS working group, a part of the Open Grid Foundation. This component allows usage records represented in the OGF Usage Record format to be uploaded and stored using the Grid-SAFE software framework. Any client which adheres to the RUPI specification may use this service to publish usage information.
• SafeRuqi: An implementation of a Resource Usage Query Interface. This is an additional web-services interface allowing a Grid-SAFE data repository to be queried programatically over the network. This is intended to allow complex distributed accounting solutions to be built out of the Grid-SAFE components.
• Accounting: The Accounting code module. These are the support classes specific to accounting and report generation.
• Webapp: The Grid-SAFE core module. These are the core web-application support classes that are used to build the rest of the componants.

---

General Grid-SAFE Documentation

This documentation applies to all components of Grid-SAFE.

Installation

• Prerequisites
• Configuration Properties

Accounting concepts

• Usage Records
• Database Tables
• Accounting Properties

---

WebAcct Documentation

Documentation specific to the WebAcct component. Make sure to read the General documentation too. It is all relevant to WebAcct.

Installation

• Ensure the standard Grid-SAFE Prerequisites are met.
• Building Grid-SAFE (not needed if using a binary release).
• Installation

Administration

• User Administration
• Command Line Tools
• Uploading Data

Accounting

• Accounting Tables
• Accounting Parsers
• Accounting Policies

Reporting

• Time Range Mapping
• Reporting Properties
• Report Templates
• Reporting accounting information to the NGS

---

SafeRupi Documentation

Documentation specific to the SafeRupi component. Make sure to read the General documentation too. It is all relevant to SafeRupi.

Installation

• Ensure the standard Grid-SAFE Prerequisites are met.
• Specific SafeRupi Prerequisites
• Installation

Accounting

• RUPI configuration
• The OGF Usage Record Database Table
• Parser Configuration

---

SafeRuqi Documentation

Documentation specific to the SafeRUQI component. The Resource Usage Query Interface (RUQI) describes a minimum set of operations required to query a set of usage records held in a data repository. RUQI uses the OGF Usage Record format.

As resources are used within a Grid, resource usage information is logged and cached at various disparate locations. Arbitrators of these resources require this information for the purposes of accounting, billing and usage monitoring, reporting and various other purposes. As such, this information must be collected from the various locations. This has been recognized as one of OGSA core services. Resource Usage Query Interface (RUQI) defines a minimum set of operations for querying resource usage information held at a location. RUQI uses the OGF Usage Record format in two ways:

• Usage information may be returned in this format.
• This format is used as a common data model for usage data allowing particular properties in a usage data record to be identified by reference to the corresponding OGF-URF XML element.

RUQI is intended to be applicable to any data repository where a mapping between the internal data format and OGF-UR can be defined. It does not require that the internal data is held in OGF-UR format or ever previously existed in this format. The specification is therefore does not make direct use of existing query languages such as SQL or Xpath that are closely tied to particular implementation technologies but can be implemented using them. This document describes normative rendering of the RUQI-IDL in the framework of the WS-I Basic Profile WS-BP1.0 transport layer. The content of this document focuses on description of SOAP message SOAP 1.2 encoding in detail. Information given in the RUQI IDL is not repeated here where possible. Some SOAP message header and body elements described within this document depend on definitions of Web Service Addressing WS-Addressing. Implementations of RUQI therefore MUST conform to relevant requirements specified in those two specifications in addition to the requirements contained within this document.