Changes between Version 37 and Version 38 of NewTestbedAPISpec


Ignore:
Timestamp:
Jul 25, 2015 7:21:18 PM (9 years ago)
Author:
faber
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • NewTestbedAPISpec

    v37 v38  
    16261626A realization is a binding of an Experiment and a Circle to Resources.  Intuitively, it is an experiment in progress.  A researcher manipulates a realization using the Realizations service.
    16271627
     1628There are two bindings that are part of a realization, the containment hierarchy that shows how resources are bound to other resources and a topology mapping that maps topology elements to resources.
     1629
     1630In addition a realization has a status, indicating the state of the experiment instance as a whole.
     1631
    16281632=== Viewing Realizations ===
    16291633
    … …  
    16341638 * '''Input Parameters:'''
    16351639   * Userid - a string, if given return all experiments this user can see
    1636    * Circle - a string, the name of a circle.  Only experiments realized in that circle will be returned
    16371640   * Regex - a string containing a regular expression matched against experiment names
    16381641 * '''Return Values:'''
    16391642   * One or more structures with the following fields
    16401643     * Name - a string containing the realization name (scoped by owner name)
    1641      * Owner - a string containing the owner's userid
     1644     * Experiment - a string containing the realized experiment
    16421645     * Circle - the circle that the experiment is realized in
    1643      * State - one of:
    1644        * initializing
    1645        * changing
    1646        * active
    1647        * terminating
     1646     * Status - one of:
     1647       * Empty
     1648       * Allocated
     1649       * Initializing
     1650       * Active
     1651       * Terminating
     1652     * Containment - a list of structures of the format
     1653       * Outer resource name - the name of the containing resource
     1654       * Inner resource name - the name of the contained resource
    16481655     * Mapping - a list of structures of the format
    16491656       * Element name - the name of the element from the experiment's layout aspect
    … …  
    16511658
    16521659
    1653 === Creating A Realization ===
    1654 
    1655 A researcher creates a realization - starts an experiment - using the realizeExperiment operation.
     1660=== Creating and Deleting a Realization ===
     1661
     1662A researcher creates a realization - starts an experiment - using the realizeExperiment operation on an experiment.
    16561663
    16571664 * '''Service:''' Realizations
    … …  
    16661673   * Success or failure
    16671674
    1668 Though none are yet specified, constraint aspects on the experiment may influence the realization.
    1669 
    1670 === Changing a Realization ===
    1671 
    1672 * '''Service:''' Realizations
    1673  * '''Operation:''' changeRealization
    1674  * '''Input Parameters:'''
    1675    * RealizationID - the realization to modify
    1676    * A list of change requests. Each request contains
    1677      * Element Name - the name of the element to remap
    1678      * Resource Name - the resource to map the element to
    1679  * '''Return Values:'''
    1680    * A list of responses each containing
    1681     * Name - astring with the name of the field
    1682     * Success - a flag indicating if the request succeeded
    1683     * Reason - a string indicating the reason if Success is false
    1684 
    1685 
    1686 This allows a researcher to modify the current mapping of the element to resource mapping of a realization.
    1687 
    16881675=== Removing A Realization ===
    16891676
    1690 A library is deleted using:
     1677A realization is deleted using:
    16911678 
    16921679 * '''Service:''' Realizations
    … …  
    16981685
    16991686After {{{removeRealization}}} succeeds, the realization is removed from the testbed and the resources are released.
     1687
     1688A user may deallocate the resources from a realization using:
     1689
     1690A realization is deleted using:
     1691 
     1692 * '''Service:''' Realizations
     1693 * '''Operation:''' relraseRealization
     1694 * '''Input Parameters:'''
     1695   * Name - a string containing the realization to delete
     1696 * '''Return Values:'''
     1697   * a boolean, true on success
     1698
     1699After {{{removeRealization}}} succeeds, the realization remains in the testbed in the empty state.  When future interface changes allow changes to realizations, this will be more useful.