summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/requirements/revision.rst7
-rw-r--r--docs/requirements/schemas.rst24
-rw-r--r--docs/requirements/supported_apis.rst1
-rw-r--r--docs/userguide/userguide.rst1
4 files changed, 25 insertions, 8 deletions
diff --git a/docs/requirements/revision.rst b/docs/requirements/revision.rst
index 2c4cb54..e085b1b 100644
--- a/docs/requirements/revision.rst
+++ b/docs/requirements/revision.rst
@@ -28,4 +28,11 @@ ANNEX D: Document revision
| 1.0.6 | JIRA: PROMISE-62 |
| | - Supported APIs for Brahmaputra |
+---------+-----------------------------------------+
+| 1.0.7 | JIRA: PROMISE-63 |
+| | - Update message flow for shim-layer |
+| | JIRA: PROMISE-58 |
+| | - Integrated approach description |
+| | JIRA: PROMISE-64 |
+| | - Promise userguide |
++---------+-----------------------------------------+
diff --git a/docs/requirements/schemas.rst b/docs/requirements/schemas.rst
index de9d9f8..c8081b6 100644
--- a/docs/requirements/schemas.rst
+++ b/docs/requirements/schemas.rst
@@ -39,6 +39,15 @@ ANNEX B: Promise YANG schema based on YangForge
description "When enabled, provides resource management across multiple providers";
}
+ typedef reference-identifier {
+ description "defines valid formats for external reference id";
+ type union {
+ type yang:uuid;
+ type inet:uri;
+ type uint32;
+ }
+ }
+
grouping resource-utilization {
container capacity {
container total { description 'Conceptual container that should be extended'; }
@@ -557,19 +566,18 @@ ANNEX B: Promise YANG schema based on YangForge
}
leaf name { type string; mandatory true; }
leaf image {
- type union {
- type yang:uuid;
- type inet:uri;
- }
+ type reference-identifier;
mandatory true;
}
leaf flavor {
- type union {
- type yang:uuid;
- type inet:uri;
- }
+ type reference-identifier;
mandatory true;
}
+ leaf-list networks {
+ type reference-identifier;
+ description "optional, will assign default network if not provided";
+ }
+
// TODO: consider supporting a template-id (such as HEAT) for more complex instantiation
leaf reservation-id {
diff --git a/docs/requirements/supported_apis.rst b/docs/requirements/supported_apis.rst
index 50a47ab..658b448 100644
--- a/docs/requirements/supported_apis.rst
+++ b/docs/requirements/supported_apis.rst
@@ -323,6 +323,7 @@ reservation-id String Id of the resource reservation
name String Name of the instance
image String Id of the image
flavor String Id of the flavor
+networks Uuid List of network uuids
============================ =============== ==============================================
Response parameters
diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst
index 1485273..6e68ce9 100644
--- a/docs/userguide/userguide.rst
+++ b/docs/userguide/userguide.rst
@@ -212,6 +212,7 @@ The operation takes the following input parameters:
* name (mandatory): Assigned name for the instance to be created
* image (mandatory): the image to be booted in the new instance
* flavor (mandatory): the flavor of the requested server instance
+* networks: the list of network uuids of the requested server instance
* provider-id: identifier of the provider where the instance shall be created
* reservation-id: identifier of a resource reservation the *create-instance*
is issued against