Changes between Version 12 and Version 13 of GeniGet


Ignore:
Timestamp:
11/18/13 09:01:58 (10 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • GeniGet

    v12 v13  
    11= geni-get =
    22
    3 A command that runs on and is accessible from inside a GENI compute resource (node) and tells you GENI meta-information about the slice, sliver and experimenter associated with the node. This is a separate tool that must be installed in your disk image. All GENI compute resource providers should make available a version of this client script that can be installed on their compute resources such that the below functionality works.
     3A command that runs on and is accessible from inside a GENI compute resource (node) and tells you GENI meta-information about the slice, sliver and experimenter associated with the node. This is a separate tool that may be installed in your disk image. All GENI compute resource providers shall make available a version of this client script that can be installed on their compute resources such that the below functionality works.
    44
    55Within this specification, `client` refers to any software or configuration installed on the compute resource (node). `server` refers to any software or configuration required to support these functions that is not installed within each compute resource, if any.
    66
    7 '''FIXME: Return error code for the script?'''
     7== Return codes ==
     8This script shall return an unix error code of `0` for success, and non-zero on any kind of error.
     9
     10'''FIXME: Defined error codes for the script?'''
    811
    912= PG implementation =
    … …  
    2831 - `--version`
    2932
    30 Options that may be no-ops for some client implementations but must be valid options:
     33Options that may have no effect for some client implementations but must be valid options:
    3134 - `--no-cache`
    3235 - `--port`
    … …  
    5962
    6063== commands ==
    61 Return a list of all commands that you can issue in this implementation. The return is a JSON list. Each of the commands listed below should be supported, but additional commands are allowed.
     64Return a list of all commands that you can issue in this implementation. The return is a JSON array. Each of the commands listed below should be supported, but additional commands are allowed.
    6265
    6366Example:
    … …  
    102105== geni_user ==
    103106
    104 Return the users and SSH keys installed on this node. Return is in the format of the geni_user argument to the AM API: http://groups.geni.net/geni/wiki/GAPI_AM_API_V3/CommonConcepts#geni_users
    105 
    106 '''FIXME: Includes updates from later `poa` actions?'''
     107Return the users and SSH keys installed on this node. Return is in the format of the `geni_user` argument to the AM API: http://groups.geni.net/geni/wiki/GAPI_AM_API_V3/CommonConcepts#geni_users
     108
     109Note that this return shall include include any changes to the defined users and keys made through later AM API calls (e.g. `PeformOperationalAction` action `geni_update_users`), but not calls made directly within the compute node.
    107110
    108111Example:
    … …  
    142145Return the return from the GENI AM API `getversion` command for the latest AM API revision supported, in JSON format. Note that not every element from the AM API `getversion` call is required to be returned here, but all are allowed and more are encouraged.
    143146
    144 '''FIXME: Which selected fields are returned here? If this is a full getversion return, then which AM API version# is used? The one you used to make the reservation?'''
     147Returned fields shall include all of the fields that this aggregate supports from this list: `geni_am_type`, `geni_single_allocation`, `geni_allocate`, `geni_credential_types`, `geni_am_code_version`, `geni_urn`, `geni_api_versions`, plus any others specific to this aggregate or defined by later versions of the AM API.
    145148
    146149Example:
    … …  
    152155== manifest ==
    153156
    154 Return the manifest RSpec for the slice, in standard GENI RSpec XML format.
    155 
    156 '''FIXME: For only this node? For only this AM?'''
     157Return the manifest RSpec for the slice, in standard GENI RSpec XML format. This manifest shall describe all resources reserved in this slice at this aggregate, not just the current compute resource.
    157158
    158159Example:
    … …  
    190191== sliverstatus ==
    191192
    192 Return the AM API v2 return from `sliverstatus` for this slice (see http://groups.geni.net/geni/wiki/GAPI_AM_API_V2#SliverStatus), a JSON struct.
    193 
    194 '''FIXME: For just the current resource (plus an overall status)? Or for all resources at this AM?'''
     193Return the AM API v2 return from `sliverstatus` for this slice (see http://groups.geni.net/geni/wiki/GAPI_AM_API_V2#SliverStatus), a JSON array. This status shall be for all slivers in this slice at this aggregate.
    195194
    196195Example:
    … …  
    201200
    202201== status ==
    203 Return the AM API v3 `status` return. Only supported if the AM supports AM API v3. See http://groups.geni.net/geni/wiki/GAPI_AM_API_V3#Status
    204 
    205 ''' FIXME: For only the current sliver? Or for all resources at this AM? If only for this sliver, then the status should also include a slice-overall status.'''
     202Return the AM API v3 `status` return. Only supported if the AM supports AM API v3. See http://groups.geni.net/geni/wiki/GAPI_AM_API_V3#Status. This status shall be for all slivers in this slice at this aggregate.
    206203
    207204Example: