Documents published by the GENI Project Office

GPO documents have the following classifications:

Adopted Recommendation - Documents that reflect the current GENI design, policy, or procedures in effect at this time.

Draft Recommendation - Candidate recommendations that are open to comments or suggested changes.

Informational - Descriptive or analytical documents intended to provide process, background, or other contextual information about GENI.


Adopted Recommendations

GENI Recommended Use Policy

GENI-INF-RUP-01.1
This document communicates common guidelines for using the suite of GENI infrastructures to the GENI community. GENI participants should be willing to follow the guidelines, and to support GENI community efforts to implement this policy.
 http://groups.geni.net/geni/attachment/wiki/RUP/RUP.pdf (updated 3/10/09)
This document has a wiki page at RUP. This document was reviewed and approved by the OMIS working group (see GeniOmisGEC4), and is adopted for use in GENI Spiral 2.

GENI Aggregate Provider's Agreement

GENI is a federated network testbed designed to allow researchers to experiment with network applications and ser- vices that benefit from distribution across a wide geographic area. All uses of GENI should be consistent with this high-level goal. Management Authorities (MAs), providing aggregates and components operating as a part of GENI, are well-served by having a common set of principles to establish an expected level of service, and methods of cooperation. Such principles, presented in this agreement, benefit the security and stability of the entire GENI suite of infrastructures.
This document was reviewed and approved by the COMIS working group (see Gec9COMISAgenda), and is adopted for use in GENI Spiral 3.
 http://groups.geni.net/geni/attachment/wiki/ComprehensiveSecurityPgm/Aggregate%20Provider%20Agreement%20v3.pdf

Emergency Stop Procedure

One of the essential early operational requirements for the GENI facility is the need to manage and coordinate the stop and/or containment of GENI resources among all GENI projects in the case of an urgent request. Emergency stop is the system used to respond to incidents of interference or resource exhaustion caused either unintentionally (misconfiguration), or intentionally (malware). This is intended to protect GENI aggregates when they begin to integrate with other aggregates, and when GENI begins to interconnect with outside networks. For Spiral 2, GENI aggregates will have active experimentation and increased integration and interconnection with other aggregates or non-GENI networks. This document will provide an approach for an early emergency stop service in Spiral 2, as well as a potential evolution for emergency stop for future spirals.
This document was reviewed and approved by the OMIS working group (see Gec8OmisAgenda), and is adopted for use in GENI Spiral 2 and 3.
 http://groups.geni.net/geni/attachment/wiki/GENIMetaOps/Emergency_Stop_System_Description_v5.1.doc
There is a new draft Emergency Stop Procedure [ posted by GMOC]. Changes were proposed to improve the procedure after live network tests with GMOC. Comments are welcome.

GMOC Concept of Operations

The GENI facility will require a model of operations moving forward that is both responsive enough to the needs of GENI users and stakeholders (researchers using the facility, users opting-in to GENI, and GENI operators) and flexible enough to evolve with the federated, reconfigurable nature of the facility. We expect that GENI research users will require a facility that is highly available, with a clear and simple process for getting support, which provides a robust set of highly detailed data about its use and operations, and which communicates maintenance and experiment affecting issues in a responsive and transparent way.
This document was reviewed and approved by the COMIS working group (see Gec9COMISAgenda), and is adopted for use in GENI Spiral 3.
 http://groups.geni.net/geni/attachment/wiki/GENIMetaOps/GENI-Concept-of-Operations-v2.1.doc

Legal, Law Enforcement and Regulatory Plan

At first glance, it may appear that the GENI federation and its governance entities have no legal responsibilities of their own since "GENI" owns virtually no infrastructure and researchers are ultimately responsible for the actions of their individual experiments. While both statements are true, there is a subtlety here as (1) lawyers, law enforcement and regulatory agencies (LLR) do not know this, and (2) no one party necessarily has all the information to address inquiries from these entities. Therefore, collaboration will be necessary to resolve some LLR issues and the need for a plan to handle such requests is established. This document begins by further motivating this need with several scenarios or use cases, some based on previous experience in other federations and testbeds. These scenarios also drive the need for proactive measures, such as, having a simple mechanism to reach slice owners and heading off future DMCA requests which could discourage campus participation in GENI. Finally, it becomes clear that someone is needed to fulfill a facilitator role to help route LLR requests to the appropriate parties when a single institution is unable to address the request it receives entirely on its own.
This document was reviewed and approved by the Ops Agreements meeting at GEC10 (see GEC10OpsAgreements), and is adopted for use in GENI Spiral 3.
 http://groups.geni.net/geni/attachment/wiki/ComprehensiveSecurityPgm/LLR%20Responsibilities%20of%20GENI%20v03.pdf

GENI Aggregate Manager API

GENI-SE-CF-AMAPI-01.0
This document describes a programming interface, known as an API, for allowing GENI experimenters to contact aggregates of GENI resources to learn what resources are available and present requests for resource reservations. The GENI Aggregate Manager API is a common API for reserving disparate resources from multiple GENI aggregates.
 http://groups.geni.net/geni/attachment/wiki/GeniAggregateManagerApiDoc/GENI-SE-CF-AMAPI-01.0.pdf (updated 9/1/10)
This document has a wiki page at GeniAggregateManagerApiDoc.

GENI Instrumentation and Measurement Architecture

GENI-SE-IM-ARCH-1.0
This document presents the GENI Instrumentation and Measurement (I&M) architecture. To conduct useful and repeatable experiments, GENI experimenters require extensive and reliable instrumentation and measurement capabilities to gather, analyze, present and archive Measurement Data (MD). In addition, the GENI operations staff require extensive and reliable instrumentation and measurement capabilities to monitor and troubleshoot the GENI suite and its constituent entities. Some of this data will be made available to experimenters, to help them conduct useful and repeatable experiments.
 http://groups.geni.net/geni/attachment/wiki/GeniInstrumentationandMeasurementsArchitecture/122010i%20GENI-SE-IM-ARCH-1.0.doc?format=raw (updated 12/20/10)
This document has a wiki page at GeniInstrumentationandMeasurementsArchitecture.

GENI Monitoring Architecture

This document presents the GENI Monitoring architecture which addresses operational monitoring in the context of GENI. The members of the GENI federation are highly dependent on each other. Operational monitoring largely consists of cooperatively resolving problems, and this architecture describes the data and interfaces needed for the various participants in GENI to share the information required to solve these problems.
 http://groups.geni.net/geni/wiki/MonitoringArch (updated 6/6/12)
This document has a wiki page at MonitoringArch.


Draft Recommendations

GENI Spiral 2 Security Plan

GENI-SE-SY-SA-TS-S2-00.1

This document describes GENI Spiral 2 security plans. The plans presented in this document are motivated by: (1) The tremendous growth of GENI by the end of Spiral 2: By the end of Spiral 2 GENI will have been deployed in over a dozen campus networks and will have over twenty aggregates providing resources for use by experimenters, and (2) An increase in the numbers of researchers expected to use GENI for experimentation. The plans described in this document are Spiral 2 activities in preparation for this growth by Spiral 3. (3/15/10)
This documents has a wiki page at SpiralTwoSecurityPlans.

Lifecycle of a GENI Experiment

GENI-SE-SY-TS-UC-LC-01.0
This document describes an experimenter’s view of the lifecycle of an experiment in the GENI environment. The objective of this document is to understand the workflow of the experimenter and identify tools and services needed to simplify experimentation in GENI.
 http://groups.geni.net/geni/attachment/wiki/ExperimentLifecycleDocument/ExperimentLifeCycle-v01.2.pdf (updated 4/30/09)
This document has a wiki page at ExperimentLifecycleDocument.

An addendum to this document describing Experimenter Tools and Services available at the end of Spiral One is available  here.

GENI System Requirements

GENI-SE-SY-RQ-02.0
This document specifies GENI system requirements. This document specifies requirements for the system as a whole: that is, all requirements listed in this document pertain to the overall system. They form the basis of further derived requirements that then flow down to the various subsystems, which are in turned captured in Requirements Documents for those subsystems.

 http://groups.geni.net/geni/attachment/wiki/SysReqDoc/GENI-SE-SY-RQ-02.0.pdf (updated 7/7/09)
This document now has a wiki page at SysReqDoc.

GENI Control Framework Requirements

GENI-SE-CF-RQ-01.3
This document defines the GENI control framework subsystem, and then specifies its requirements. It is a DRAFT, to be used for discussion in the GENI Control Framework working group. Once approved, it can be used as a guide to judge the completeness of prototype control framework designs, and as a guide to their continued evolution.
 http://groups.geni.net/geni/attachment/wiki/GeniControlFrameworkRequirements/010909b%20%20GENI-SE-CH-RQ-01.3.pdf (updated 1/9/09)
This document has a wiki page at GeniControlFrameworkRequirements.

Templates for Information Pages about Aggregates and Clearinghouses

Template for Aggregates | Example for ProtoGENI Aggregate
Template for Clearinghouses | Example for ProtoGENI Clearinghouse


Informational

GENI System Overview

This document is intended to help readers unfamiliar to the GENI project understand the design through examples and discussions of key elements and concepts. The February 2012 version of this document includes a description of the GENI meso-scale deployment
An Introduction to GENI (February 2012 version) Download

This document has a wiki page at [GeniSysOvrvw].

GENI Spiral 3 Integration Release Guidelines

GENI-INF-PRO-S3-IR1-01.0
This document provides common guidelines for contributing software to Spiral 3 Integration Release 1 (GIR 3.1) and Release 2 (GIR 3.2). These releases will capture working versions of software that have been integrated in GENI. GIR3.1 will include software that have been integrated in GENI as of March 2011, and GIR 3.2 will include software that is integrated as of September 2011. This document describes completion criteria that are helpful for any software deliverable associated with a feature milestone (release, integration, resource availability, and documentation).
 http://groups.geni.net/geni/attachment/wiki/GIR3Guidelines/Spiral3-GIR_Guidelines.pdf (02/11/11)

GENI Spiral 2 Integration Release Guidelines

GENI-INF-PRO-S2-IR1-01.1
This document provides common guidelines for contributing software to Spiral 2 Integration Release 1 (GIR 2.1) This release will capture working versions of software that have been integrated in GENI as of GENI Engineering Conference 8 (GEC8). This document describes completion criteria that are helpful for any software deliverable associated with a feature milestone (release, integration, resource availability, and documentation).
 http://groups.geni.net/geni/attachment/wiki/GIR2.1Guidelines/GIR2.1Guidelines.pdf (5/10/10)

GENI Spiral 2 Overview

GENI-INF-PRO-S2-OV-1.1
This document provides an overview of GENI Spiral 2. It describes this spiral’s developmental goals and summarizes the active projects. GENI Spiral 2 runs from October 2009 through September 2010. It is the second phase of exploratory rapid-prototyping that will begin to inform technical and operational plans for the envisioned GENI suite of research infrastructure. Spiral 2's primary goal is to begin moving towards continuous experimentation.
 http://groups.geni.net/geni/attachment/wiki/SpiralTwo/GENIS2Ovrvw060310.pdf (6/3/10)

Experimenter Tools and Services: Spiral 1 Capabilities

This draft document, published as an appendix to the Lifecycle of a GENI Experiment document, describes experimenter tools and services available from each of the GENI Spiral 1 clusters. (7/15/09)
 http://groups.geni.net/geni/attachment/wiki/ExperimentLifecycleDocument/Spiral1-Capabilities-appendix.pdf

ProtoGENI Control Framework Overview

GENI-SE-CF-PRGO-01.3
This document provides an overview of the ProtoGENI control framework being implemented for Spiral 1, for use in Cluster C. It is a DRAFT, to be used for discussion in the GENI Control Framework working group. (Note: A review of this document by the ProtoGENI team is underway, but has not yet been completed.) It provides a description of the ProtoGENI control framework structure, a summary of how it meets the requirements as presented in the “GENI Control Framework Requirements”, and a view of its implementation at the start and the finish of Spiral 1.
 http://groups.geni.net/geni/attachment/wiki/ProtoGeniControlFrameworkOverview/011409%20%20GENI-SE-CF-ProtoGENIOver-01.3.pdf (updated 1/14/09)
This document has a wiki page at ProtoGeniControlFrameworkOverview .

ORCA GENI Control Framework Overviews

GENI-SE-CF-ORGO-01.2
This document provides an overview of the ORCA GENI control framework being implemented for Spiral 1, for use in Cluster D. It is a DRAFT, to be used for discussion in the GENI Control Framework working group. (Note: A review of this document by the ORCA team is underway, but has not yet been completed.) It provides a description of the ORCA GENI control framework structure, a summary of how it meets the requirements as presented in the “GENI Control Framework Requirements”, and a view of its implementation at the start and the finish of Spiral 1.
 http://groups.geni.net/geni/attachment/wiki/OrcaGeniControlFrameworkOverview/011409%20%20GENI-SE-CF-ORCAGENIOver-01.2.pdf (updated 1/9/09)
This document has a wiki page at OrcaGeniControlFrameworkOverview.

PlanetLab GENI Control Framework Overview

GENI-SE-CF-PLGO-01.2
This document provides an overview of the PlanetLab GENI control framework being implemented for Spiral 1, for use in Cluster B. It is a DRAFT, to be used for discussion in the GENI Control Framework working group. (Note: A review of this document by the PlanetLab team is underway, but has not yet been completed.) It provides a description of the PlanetLab GENI control framework structure, a summary of how it meets the requirements as presented in the “GENI Control Framework Requirements”, and a view of its implementation at the start and the finish of Spiral 1.
 http://groups.geni.net/geni/attachment/wiki/PlanetLabGeniControlFrameworkOverview/011409%20%20GENI-SE-CF-PlanetLabGENIOver-01.2.pdf (updated 1/14/09)
This document has a wiki page at PlanetLabGeniControlFrameworkOverview.

GENI Spiral 1 Overview

GENI-INF-PRO-S1-OV-1.12
This document provides a brief introduction to GENI Spiral 1, the first phase of GENI prototyping. It identifies the goals of Spiral 1, the various research projects that will be integrated to form Spiral 1, and the ways in which they will be integrated. (9/29/08)
 http://groups.geni.net/geni/attachment/wiki/SpiralOne/GENIS1Ovrvw092908.pdf

Spiral 1 Substrate Catalog

GENI-INF-PRO-S1-CAT-01.5
The substrate catalog provides detailed information on each of the substrate projects integrating into Spiral 1 control frameworks.(12/10/08)
 http://groups.geni.net/geni/attachment/wiki/DeliverablePage/Spiral1%20substrate%20catalog.doc
 A description of required information found in this document

GENI Working Groups

This document defines the structure and operations of GENI working groups. (updated 9/20/07)
 http://groups.geni.net/geni/attachment/wiki/GeniWorkingGroupDoc/geni-wgs-20070920.pdf
This document has a wiki page at [GeniWorkingGroupDoc].

Other

Contributed Documents: Documents contributed by members of the GENI community. May come from D&P projects. A listing may be found at wiki:ContributedDocs.

Older Documents: Pre-GPO documents (from 2005-2007) can be found at wiki:OldGPGDesignDocuments.