Changes between Version 20 and Version 21 of AaronHelsinger/GAPI_AM_API_DRAFT

Timestamp:

03/29/12 14:33:39 (12 years ago)

Author:

Aaron Helsinger

Comment:

--

AaronHelsinger/GAPI_AM_API_DRAFT

@@ -1011 +1011 @@
 The manifest is a manifest of only newly allocated slivers. The `geni_end_time` argument requests an expiration of the allocated slivers. AMs may not be able to honor it, but may still succeed the overall request.
 
- == !RenewAllocations ==
-AKA Renew() or !RenewAllocated
-{{{
-struct RenewAllocations(string urn[],
+ == !Renew ==
+AKA !RenewSliver() or !RenewAllocated
+{{{
+struct Renew(string urn[],
                     struct credentials[],
                     string expiration_time, 
@@ -1040 +1040 @@
    geni_sliver_urn: <string>,
    geni_allocation_status: <string>,
+   geni_operational_status: <string>,
    geni_expires: <time when the sliver expires from its current state>,
    <others AM or method specific>
@@ -1047 +1048 @@
 }}}
 
-FIXME: Combine with !RenewSlivers()?
 FIXME: Split Renew(slice) from Renew(slivers)
 
@@ -1096 +1096 @@
 {{{
 struct ProvisionSlivers(string urn[], struct credentials[],  
-                                 struct users[], struct options)
+                                   struct options)
 }}}
 
@@ -1111 +1111 @@
 }}}
 
-Options include {{{geni_best_effort = True/False, default false}}}, {{{geni_end_time}}}
+Options include:
+ - {{{geni_best_effort = True/False, default false}}}
+ - {{{geni_end_time}}}
+ - `struct users[]`: An array of user structs, which contain information about the users that might login to the sliver that the AM needs to know about. Each struct must include the key 'keys', which is an array of strings and can be empty. The struct must also include the key 'urn', which is the user’s URN string. The users array can be empty. For example:
+{{{
+[
+  {
+    urn: urn:publicid:IDN+geni.net:gcf+user+alice
+    keys: [<ssh key>, <ssh key>]
+  },
+  {
+    urn: urn:publicid:IDN+geni.net:gcf+user+bob
+    keys: [<ssh key>]
+  }
+]
+}}}
 
 Return struct:
@@ -1139 +1154 @@
 {{{
 struct UpdateSlivers(string urn[], struct credentials[], string rspec, 
-                                                 struct users[], struct options)
+                                                 struct options)
 }}}
 
@@ -1154 +1169 @@
 }}}
 
-Options include {{{geni_end_time}}} and {{{geni_best_effort: <True/False, default false>}}}
+Options include:
+ - {{{geni_end_time}}} 
+ - {{{geni_best_effort: <True/False, default false>}}}
+ - `struct users[]`: An array of user structs, which contain information about the users that might login to the sliver that the AM needs to know about. Each struct must include the key 'keys', which is an array of strings and can be empty. The struct must also include the key 'urn', which is the user’s URN string. The users array can be empty. For example:
+{{{
+[
+  {
+    urn: urn:publicid:IDN+geni.net:gcf+user+alice
+    keys: [<ssh key>, <ssh key>]
+  },
+  {
+    urn: urn:publicid:IDN+geni.net:gcf+user+bob
+    keys: [<ssh key>]
+  }
+]
+}}}
 
 Return struct:
@@ -1178 +1208 @@
 FIXME: Is this the same method as for updating allocated slivers?
 FIXME: Return both a manifest and a delta RSpec?
-
- == !RenewSlivers ==
-AKA Renew() or !RenewProvisioned()
-{{{
-struct RenewSlivers(string urn[],
-                    struct credentials[],
-                    string expiration_time, 
-                    struct options)
-}}}
-
-Where credentials is:
-{{{
-credentials = [
-   {
-    geni_type: <string>, 
-    geni_version: <string>,
-    geni_value: <string>,
-    <others>
-   }
-]
-}}}
-
-Options include {{{geni_best_effort: <True/False, default false>}}}
-
-Return list of structs:
-{{{ 
-[
-  {
-   geni_sliver_urn: <string>,
-   geni_allocation_status: <string>,
-   geni_operational_status: <string>,
-   geni_expires: <time when the sliver expires from its current state>,
-   <others AM or resource specific>
-  },
-  ...
-]
-}}}
-
-FIXME: Combine with !RenewAllocations()?
-FIXME: Split Renew(slice) from Renew(slivers)
 
  == !SliversStatus ==