wiki:GeniApi

Version 20 (modified by Aaron Helsinger, 9 years ago) (diff)

--

The GENI API

The GENI API is an effort to enable interoperability between Control Frameworks/Clearinghouses and Aggregates.

The GENI API implements a key interface of the SFA 2.0 Draft, providing a common interface to Aggregate Managers. Experimenters can use the API to access resources belonging to any compliant Control Framework. The API lets you mix and match aggregates with control frameworks.

ProtoGENI, PlanetLab, and Openflow all have implemented the API and are now interoperable. This was initially demonstrated at GEC8, and was used to reserve the resources used in the plenary session demos at GEC9.

The ProtoGENI implementation is live in Utah and Kentucky, and is part of emulab-stable. ProtoGENI has trusted the PlanetLab root certificate (it is included in their standard certificate bundle that all ProtoGENI installs receive), meaning that PlanetLab users can use the GENI API to reserve ProtoGENI resources. Contact the mailing list (geni-dev@emulab.net) with questions on using the API at ProtoGENI.

The PlanetLab implementation is live on PLC and PLE. ProtoGENI and PLC have also swapped root certificates, meaning that ProtoGENI users can use the API to reserve PlanetLab resources at PLC. To run the GENI API on your MyPLC instance, simply install the latest release of SFA. Use the mailing list: devel@planet-lab.org for questions.

The OpenFlow team has built a combined client/clearinghouse/aggregate manager called Expedient. Expedient exposes the GENI API to reserve OpenFlow slivers. To learn more about Expedient, see the Expedient developer's site. Expedient has been installed at multiple campuses. Contact OpenFlow for further availability information.

The GPO has developed a reference implementation of this API, particularly demonstrating the use of certificates, credentials and credential verification. Also provided is a reference client, omni. Omni communicates with each clearinghouse in its 'native tongue', and then calls the Aggregate Manager API at any compliant Aggregate. These packages are available together for download here: Download Sample Code, with source code and our open ticket issues available and public here.

Experimenters should begin designing and conducting experiments that take advantage of the broad variety of resources now available to them. Contact Mark Berman and the Experimentation Working Group with questions.

Full details on the API specification are available here: GENI Aggregate Manager API

Questions? Comments? Suggestions? Contact Tom Mitchell (tmitchell) or Josh Karlin (jkarlin) or Aaron Helsinger (ahelsing) or Sarah Edwards (sedwards) at geni.net