aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/sections/.DS_Storebin0 -> 8196 bytes
-rw-r--r--docs/sections/administration.rst6
-rw-r--r--docs/sections/architecture.rst55
-rw-r--r--docs/sections/configuration.rst6
-rw-r--r--docs/sections/consumedapis.rst22
-rw-r--r--docs/sections/delivery.rst6
-rw-r--r--docs/sections/diagrams/.DS_Storebin0 -> 6148 bytes
-rw-r--r--docs/sections/diagrams/OSDF-components.pngbin0 -> 122198 bytes
-rw-r--r--docs/sections/humaninterfaces.rst6
-rw-r--r--docs/sections/installation.rst10
-rw-r--r--docs/sections/logging.rst16
-rw-r--r--docs/sections/offeredapis.rst317
-rw-r--r--docs/sections/release-notes.rst43
13 files changed, 487 insertions, 0 deletions
diff --git a/docs/sections/.DS_Store b/docs/sections/.DS_Store
new file mode 100644
index 0000000..c425cf1
--- /dev/null
+++ b/docs/sections/.DS_Store
Binary files differ
diff --git a/docs/sections/administration.rst b/docs/sections/administration.rst
new file mode 100644
index 0000000..0650561
--- /dev/null
+++ b/docs/sections/administration.rst
@@ -0,0 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Administration
+=============================================
+
+ Administration - TBD \ No newline at end of file
diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst
new file mode 100644
index 0000000..64bc43c
--- /dev/null
+++ b/docs/sections/architecture.rst
@@ -0,0 +1,55 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Architecture
+=============================================
+
+Technology Choices
+------------------
+Minizinc provides an open source constraint modeling language/platform for specifying optimization applications.
+It contains direct interfaces to COIN-OR CBC, Gurobi and IBM ILOG CPLEX. Additionally, many optimization projects
+support minizinc via FlatZinc interfaces. The Minizinc standard library provides a subset of constraints form the
+global constraint catalogue as a high-level abstraction that have efficient algorithms implemented by several solvers.
+
+Components of the Core Framework
+--------------------------------------------
+
+.. image:: ./diagrams/OSDF-components.png
+
+An overview of the components of the core optimization framework. The OOF utilizes the open source project Minizinc,
+which has a solver-independent modeling language and has interfaces to various open source and commercial solvers.
+One of the additional benefits of this approach is that by developing a focused set of ONAP-related components,
+we can utilize ongoing advances in optimization technologies, as well as adapt other currently available extensions to
+Minizinc and related projects. The OOF project aims to build these components with a focus on minimal viable product
+for Beijing Release in order to support initial applications and use cases, with subsequent focus on expanding the
+platform.
+
+Data Adapter Library
+----------------------
+
+The OOF will provide a library of adapters for common ONAP systems. These can be directly used in data specification
+templates of the applications. In the initial release, these will include adapters to Policy, A&AI, Multi-Cloud, and
+SDC (additional "stretch goals" for this release include SDN-C, Microservice Bus). As new use cases are implemented,
+this library will be augmented by new adapters to other services.
+
+Translation Modules
+--------------------------------------------
+
+The OOF will provide modules for translating policies into constraints for the optimization environment. When an
+underlying minizinc model is used for optimization, it is translated into a minizinc constraint (either via a data
+specification template or directly from policy). For custom optimizers, these constraints will be translated to the
+input format expected by the optimizer via the data specification template. The Homing and Allocation Service (HAS;
+described in the next section) uses a custom optimization module and hence uses the data specification template approach.
+
+Modeling Support
+----------------------
+
+The OOF provides simple templating system through which users can specify links to different ONAP components, including policy,
+A&AI, SDC, etc.
+
+
+Execution Environment
+------------------------------------------------------------------------
+
+The OOF execution environment contains the minizinc system, along with data/template rendering system that leverages
+the adapters to various systems. The flow of execution can be configured via the configuration file for the application
+and supports a choice of specific solver or invocations to custom/external solvers.
diff --git a/docs/sections/configuration.rst b/docs/sections/configuration.rst
new file mode 100644
index 0000000..1532e78
--- /dev/null
+++ b/docs/sections/configuration.rst
@@ -0,0 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Configuration
+=============================================
+
+TBD
diff --git a/docs/sections/consumedapis.rst b/docs/sections/consumedapis.rst
new file mode 100644
index 0000000..67178c5
--- /dev/null
+++ b/docs/sections/consumedapis.rst
@@ -0,0 +1,22 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Consumed APIs
+=============================================
+The following are the dependencies for the project based on the scope for the Beijing Release.
+The required dependencies have been identified based on the current homing requirements for the vCPE use case,
+and the potential dependencies are tentative dependencies that may exist based on how the information required
+for homing (e.g., Hardware Platform Enablement, VIM attributes) is available.
+
+
+Service Orchestrator
+--------------------------------------------
+See documentation for Service Orchestrator
+
+
+Policy
+--------------------------------------------
+See documentation for Policy
+
+SDC
+--------------------------------------------
+See documentation for SDC
diff --git a/docs/sections/delivery.rst b/docs/sections/delivery.rst
new file mode 100644
index 0000000..bfe8480
--- /dev/null
+++ b/docs/sections/delivery.rst
@@ -0,0 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Delivery
+=============================================
+
+ Delivery description TBD \ No newline at end of file
diff --git a/docs/sections/diagrams/.DS_Store b/docs/sections/diagrams/.DS_Store
new file mode 100644
index 0000000..5008ddf
--- /dev/null
+++ b/docs/sections/diagrams/.DS_Store
Binary files differ
diff --git a/docs/sections/diagrams/OSDF-components.png b/docs/sections/diagrams/OSDF-components.png
new file mode 100644
index 0000000..6fbab4a
--- /dev/null
+++ b/docs/sections/diagrams/OSDF-components.png
Binary files differ
diff --git a/docs/sections/humaninterfaces.rst b/docs/sections/humaninterfaces.rst
new file mode 100644
index 0000000..dc09e7e
--- /dev/null
+++ b/docs/sections/humaninterfaces.rst
@@ -0,0 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Human Interfaces
+=============================================
+
+ OOF OSDF does not expose a human interface \ No newline at end of file
diff --git a/docs/sections/installation.rst b/docs/sections/installation.rst
new file mode 100644
index 0000000..fac87bf
--- /dev/null
+++ b/docs/sections/installation.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Installation
+=============================================
+
+Installing from the Source Code
+------------------------------------
+Get code from the Linux Foundation Projects page
+ $ git clone https://gerrit.onap.org/r/optf/osdf
+
diff --git a/docs/sections/logging.rst b/docs/sections/logging.rst
new file mode 100644
index 0000000..eb2739f
--- /dev/null
+++ b/docs/sections/logging.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Logging
+=============================================
+
+OSDF uses a single logger, oslo, across all the components. The logging format is compliant with the EELF recommendations,
+including having the following logs:
+error, audit, metric, application.
+
+The log statements follow the following format (values default to preset values when missing):
+
+Timestamp|RequestId|ServiceInstanceId|ThreadId|Virtual Server Name|ServiceName|InstanceUUID|Log Level|Alarm Severity Level|Server IP Address|HOST NAME|Remote IP Address|Class name|Timer|Detailed Message
+
+The logger util module can be found at:
+
+<>/has/conductor/conductor/common/utils/conductor_logging_util.py \ No newline at end of file
diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst
new file mode 100644
index 0000000..c88bcf8
--- /dev/null
+++ b/docs/sections/offeredapis.rst
@@ -0,0 +1,317 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+******************
+Offered APIs
+******************
+
+OOF-HAS Create/Update API
+#########################
+
++--------------------+-------------------------------------+
+|Interface Definition|Description |
++====================+=====================================+
+|URI |{serverRoot}/oof-osdf/v2/placement |
++--------------------+-------------------------------------+
+|Operation Type |POST |
++--------------------+-------------------------------------+
+|Content-Type |application/json |
++--------------------+-------------------------------------+
+
+
+Request Header
+**************
+
++----------------+-----------+-------------------------------------------------------------------------------------------+
+| Header Name | Required | Description |
++================+===========+===========================================================================================+
+| Accept | N | Determines the format of the body of the response. Valid value is “application/json” |
++----------------+-----------+-------------------------------------------------------------------------------------------+
+| Authorization | Y | Supplies Basic Authentication credentials for the request. If the Authorization header is |
+| | | missing, then an HTTP 400 Invalid Request response is returned. If the string supplied is |
+| | | invalid, then an HTTP 401 Unauthorized response is returned. |
++----------------+-----------+-------------------------------------------------------------------------------------------+
+| Content-Type | Y | Determines the format of the request content. Only application/json is supported. |
++----------------+-----------+-------------------------------------------------------------------------------------------+
+| Content-Length | N | Number of bytes in the body of the request. Note that content length is limited to 1 MB. |
++----------------+-----------+-------------------------------------------------------------------------------------------+
+
+
+Request Body
+************
+
++---------------+-----------+-------------+----------------------+---------------+------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++===============+===========+=============+======================+===============+==========================================+
+| requestInfo | M | 1 | RequestInfo Object | - | The content of the RequestInfo object. |
++---------------+-----------+-------------+----------------------+---------------+------------------------------------------+
+| placementInfo | M | 1 | PlacementInfo Object | - | The Content of the PlacementInfo object. |
++---------------+-----------+-------------+----------------------+---------------+------------------------------------------+
+| licenseInfo | M | 1 | LicenseInfo Object | - | The Content of the LicenseInfo object. |
++---------------+-----------+-------------+----------------------+---------------+------------------------------------------+
+| serviceInfo | M | 1 | ServiceInfo Object | - | The Content of the ServiceInfo object. |
++---------------+-----------+-------------+----------------------+---------------+------------------------------------------+
+
+
+RequestInfo Object:
+
++---------------+-----------+-------------+-----------------+---------------+-----------------------------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++===============+===========+=============+=================+===============+=======================================================================+
+| transactionId | M | 1 | UUID/String | - | A unique ID to track an ONAP transaction. |
++---------------+-----------+-------------+-----------------+---------------+-----------------------------------------------------------------------+
+| requestId | M | 1 | UUID/String | - | A unique ID to track multiple requests associated with a transaction. |
++---------------+-----------+-------------+-----------------+---------------+-----------------------------------------------------------------------+
+| callbackUrl | M | 1 | URL | - | The end point of a callback service where recommendations are posted. |
++---------------+-----------+-------------+-----------------+---------------+-----------------------------------------------------------------------+
+| sourceId | M | 1 | String | - | The unique ID of a client making an optimization call. |
++---------------+-----------+-------------+-----------------+---------------+-----------------------------------------------------------------------+
+| requestType | M | 1 | String | create, | The type of a request |
+| | | | | update, | |
+| | | | | delete | |
++---------------+-----------+-------------+-----------------+---------------+-----------------------------------------------------------------------+
+| numSolutions | O | 1 | Integer | - | Expected number of solutions. |
++---------------+-----------+-------------+-----------------+---------------+-----------------------------------------------------------------------+
+| optimizers | M | 1..N | List of Strings | placement | A list of optimization services. |
++---------------+-----------+-------------+-----------------+---------------+-----------------------------------------------------------------------+
+| timeout | M | 1 | Integer | - | A tolerance window (in second) for expecting solutions. |
++---------------+-----------+-------------+-----------------+---------------+-----------------------------------------------------------------------+
+
+
+PlacementInfo Object:
+
++-------------------+-----------+-------------+--------------------------------+---------------+---------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++===================+===========+=============+================================+===============+===================================================+
+| requestParameters | M | 1 | JSON BLOB | - | A service ordering information. |
++-------------------+-----------+-------------+--------------------------------+---------------+---------------------------------------------------+
+| placementDemands | M | 1..N | List of PlacementDemand Object | - | The resource information for a placement service. |
++-------------------+-----------+-------------+--------------------------------+---------------+---------------------------------------------------+
+
+
+PlacementDemand Object:
+
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++====================+===========+=============+======================+===============+=================================================================+
+| resourceModuleName | M | 1 | String | - | A resource name as defined in a service model. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| serviceResourceId | M | 1 | String | - | A unique resource Id with a local scope between client and OOF. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| givenPlacement | O | 1 | KeyValuePairs | - | placement parameters defined in the ordering system, |
+| | | | | | keyname include tenantId. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| resourceModelInfo | M | 1 | ModelMetaData Object | - | Resource model information as defined in SDC. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| existingCandidates | O | 1 | Candidates Object | - | The existing placement information of a resource. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| excludedCandidates | O | 1 | Candidates Object | - | Candidates that need to be excluded from solutions. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| requiredCandidates | O | 1 | Candidates Object | - | Candidates that must be included in solutions. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+
+
+ModelMetaData Object:
+
++------------------------+-----------+-------------+---------+---------------+-----------------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++========================+===========+=============+=========+===============+===========================================================+
+| modelInvariantId | M | 1 | String | - | A model invariant Id as defined in a service model. |
++------------------------+-----------+-------------+---------+---------------+-----------------------------------------------------------+
+| modelVersionId | M | 1 | String | - | A unique model Id as defined in a service model. |
++------------------------+-----------+-------------+---------+---------------+-----------------------------------------------------------+
+| modelName | O | 1 | String | - | A model name as defined in a service model. |
++------------------------+-----------+-------------+---------+---------------+-----------------------------------------------------------+
+| modelType | O | 1 | String | - | A model type as defined in a service model. |
++------------------------+-----------+-------------+---------+---------------+-----------------------------------------------------------+
+| modelVersion | O | 1 | String | - | A model version as defined in a service model. |
++------------------------+-----------+-------------+---------+---------------+-----------------------------------------------------------+
+| modelCustomizationName | O | 1 | String | - | A model customization name as defined in a service model. |
++------------------------+-----------+-------------+---------+---------------+-----------------------------------------------------------+
+
+
+Candidates Object:
+
++----------------+-----------+-------------+-----------------+----------------------+--------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++================+===========+=============+=================+======================+==========================+
+| identifierType | M | 1 | String | service_instance_id, | The type of a candidate. |
+| | | | | vnf_name, | |
+| | | | | cloud_region_id | |
++----------------+-----------+-------------+-----------------+----------------------+--------------------------+
+| identifiers | M | 1..N | List of Strings | - | A list of identifiers. |
++----------------+-----------+-------------+-----------------+----------------------+--------------------------+
+
+
+ServiceInfo Object:
+
++-------------------+-----------+-------------+----------------------+---------------+--------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++===================+===========+=============+======================+===============+==================================================+
+| serviceInstanceId | M | 1 | String | - | A service instance id associated with a request. |
++-------------------+-----------+-------------+----------------------+---------------+--------------------------------------------------+
+| serviceModelInfo | M | 1 | ModelMetaData Object | - | A list of identifiers. |
++-------------------+-----------+-------------+----------------------+---------------+--------------------------------------------------+
+
+
+LicenseInfo Object:
+
++----------------+-----------+-------------+-------------------------------+---------------+--------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++================+===========+=============+===============================+===============+============================================+
+| licenseDemands | M | 1..N | List of LicenseDemands Object | - | A list of resources for license selection. |
++----------------+-----------+-------------+-------------------------------+---------------+--------------------------------------------+
+
+
+LicenseDemands Object:
+
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++====================+===========+=============+======================+===============+=================================================================+
+| resourceModuleName | M | 1 | String | - | A resource name as defined in a service model. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| serviceResourceId | M | 1 | String | - | A unique resource Id with a local scope between client and OOF. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| resourceModelInfo | M | 1 | ModelMetaData Object | - | Resource model information as defined in a service model. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+| existingLicenses | O | 1 | LicenseModel Object | - | Existing license information assigned to a resource. |
++--------------------+-----------+-------------+----------------------+---------------+-----------------------------------------------------------------+
+
+
+LicenseModel Object:
+
++---------------------+-----------+-------------+-----------------+---------------+----------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++=====================+===========+=============+=================+===============+====================================================+
+| entitlementPoolUUID | M | 1..N | List of Strings | - | Entitlement pool UUIDs associated with a resource. |
++---------------------+-----------+-------------+-----------------+---------------+----------------------------------------------------+
+| licenseKeyGroupUUID | M | 1..N | List of Strings | - | License key groups associated with a resource |
++---------------------+-----------+-------------+-----------------+---------------+----------------------------------------------------+
+
+
+Synchronous Response Body:
+
++---------------+-----------+-------------+-------------+------------------+------------------------------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++===============+===========+=============+=============+==================+========================================================================+
+| requestId | M | 1 | UUID/String | - | A unique Id for an ONAP transaction. |
++---------------+-----------+-------------+-------------+------------------+------------------------------------------------------------------------+
+| transactionId | M | 1 | UUID/String | - | A unique ID to track multiple requests associated with a transaction. |
++---------------+-----------+-------------+-------------+------------------+------------------------------------------------------------------------+
+| statusMessage | O | 1 | String | - | Reasoning if a requestStatus is failure. |
++---------------+-----------+-------------+-------------+------------------+------------------------------------------------------------------------+
+| requestStatus | M | 1 | String | success, failure | The status of a request. |
++---------------+-----------+-------------+-------------+------------------+------------------------------------------------------------------------+
+
+
+Asynchronous Response Body:
+
++---------------+-----------+-------------+-----------------+---------------+------------------------------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++===============+===========+=============+=================+===============+========================================================================+
+| requestId | M | 1 | UUID/String | - | A unique Id for an ONAP transaction. |
++---------------+-----------+-------------+-----------------+---------------+------------------------------------------------------------------------+
+| transactionId | M | 1 | UUID/String | - | A unique ID to track multiple requests associated with a transaction. |
++---------------+-----------+-------------+-----------------+---------------+------------------------------------------------------------------------+
+| statusMessage | O | 1 | String | - | Reasoning if requestStatus is failure. |
++---------------+-----------+-------------+-----------------+---------------+------------------------------------------------------------------------+
+| requestStatus | M | 1 | String | success, | The status of a request. |
+| | | | | failure, | |
+| | | | | pending | |
++---------------+-----------+-------------+-----------------+---------------+------------------------------------------------------------------------+
+| solutions | M | 1 | Solutions Object| - | Solutions related to a request. |
++---------------+-----------+-------------+-----------------+---------------+------------------------------------------------------------------------+
+
+
+Solutions Object:
+
++--------------------+-----------+-------------+--------------------------------------+---------------+--------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++====================+===========+=============+======================================+===============+================================+
+| placementSolutions | M | 1..N | List of ComprehensiveSolution Object | - | A list of placement solutions. |
++--------------------+-----------+-------------+--------------------------------------+---------------+--------------------------------+
+| licenseSolutions | M | 1..N | List of LicenseSolution Object | - | A list of license solutions |
++--------------------+-----------+-------------+--------------------------------------+---------------+--------------------------------+
+
+
+
+ComprehensiveSolution Object:
+
++-----------+-----------+-------------+----------------------------------+---------------+--------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++===========+===========+=============+==================================+===============+================================+
+| - | M | 1..N | List of PlacementSolution Object | - | A list of placement solutions. |
++-----------+-----------+-------------+----------------------------------+---------------+--------------------------------+
+
+
+PlacementSolution Object:
+
++--------------------+-----------+-------------+------------------------+---------------------+---------------------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++====================+===========+=============+========================+=====================+=========================================================+
+| resourceModuleName | M | 1 | String | - | The name of a resource as defined in the service model. |
++--------------------+-----------+-------------+------------------------+---------------------+---------------------------------------------------------+
+| serviceResourceId | M | 1 | String | - | A resource Id as defined in a service model. |
++--------------------+-----------+-------------+------------------------+---------------------+---------------------------------------------------------+
+| identifierType | M | 1 | String | service_instance_id | The type of a candidate. |
++--------------------+-----------+-------------+------------------------+---------------------+---------------------------------------------------------+
+| identifier | M | 1 | String | - | The id of a candidate. |
++--------------------+-----------+-------------+------------------------+---------------------+---------------------------------------------------------+
+| assignmentInfo | O | 1..N | List of AssignmentInfo | - | Additional information related to a candidate. |
+| | | | object | | |
++--------------------+-----------+-------------+------------------------+---------------------+---------------------------------------------------------+
+
+
+AssignmentInfo Object:
+
++-----------+-----------+-------------+---------+---------------+---------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++===========+===========+=============+=========+===============+=====================+
+| key | M | 1 | String | - | An attribute name. |
++-----------+-----------+-------------+---------+---------------+---------------------+
+| value | M | 1 | String | - | An attribute value. |
++-----------+-----------+-------------+---------+---------------+---------------------+
+
+
+LicenseSolutions Object:
+
++------------------------------+-----------+-------------+----------------+---------------+------------------------------------------+
+| Attribute | Qualifier | Cardinality | Content | Domain Values | Description |
++==============================+===========+=============+================+===============+==========================================+
+| resourceModuleName | M | 1 | String | - | A resource name as defined in a service. |
++------------------------------+-----------+-------------+----------------+---------------+------------------------------------------+
+| serviceResourceId | M | 1 | String | - | A resource Id as defined in a service. |
++------------------------------+-----------+-------------+----------------+---------------+------------------------------------------+
+| entitlementPoolUUID | M | 1..N | List of String | - | A list of entitlementPoolUUIDs. |
++------------------------------+-----------+-------------+----------------+---------------+------------------------------------------+
+| licenseKeyGroupUUID | M | 1..N | List of String | - | A list of licenseKeyGroupUUID. |
++------------------------------+-----------+-------------+----------------+---------------+------------------------------------------+
+| entitlementPoolInvariantUUID | M | 1..N | List of String | - | A list of entitlementPoolInvariantUUID . |
++------------------------------+-----------+-------------+----------------+---------------+------------------------------------------+
+| licenseKeyGroupInvariantUUID | M | 1..N | List of String | - | A list of licenseKeyGroupInvariantUUID . |
++------------------------------+-----------+-------------+----------------+---------------+------------------------------------------+
+
+
+HTTP Response Code
+++++++++++++++++++
+
++-----------+-----------------------+---------------------------------------------------------------+
+| HTTP Code | Response Phrase | Description |
++===========+=======================+===============================================================+
+| 201 | Created | An optimization solution is found. |
++-----------+-----------------------+---------------------------------------------------------------+
+| 202 | Accepted | An optimization request is accepted. |
++-----------+-----------------------+---------------------------------------------------------------+
+| 400 | Bad request | Bad request. |
++-----------+-----------------------+---------------------------------------------------------------+
+| 401 | Unauthorized | Request body is not compliant with the API definition. |
++-----------+-----------------------+---------------------------------------------------------------+
+| 404 | Not found | The server cannot find the requested URI. |
++-----------+-----------------------+---------------------------------------------------------------+
+| 405 | Method not found | The requested method is not supported by a server. |
++-----------+-----------------------+---------------------------------------------------------------+
+| 500 | Internal server error | The server encountered an internal server error or timed out. |
++-----------+-----------------------+---------------------------------------------------------------+
+
+
+
diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst
new file mode 100644
index 0000000..967433f
--- /dev/null
+++ b/docs/sections/release-notes.rst
@@ -0,0 +1,43 @@
+..
+ This work is licensed under a Creative Commons Attribution 4.0
+ International License.
+
+=============
+Release Notes
+=============
+
+Release Date
+------------
+2018-05-24
+
+
+New Features
+------------
+* Baseline functionality
+* Integration with OOF HAS, SO, Policy and SDC
+* Platform Maturity Level 1
+* ~50% unit test coverage
+
+Bug Fixes
+---------
+None
+
+Known Issues
+------------
+None
+
+Security Issues
+---------------
+None
+
+Upgrade Notes
+-------------
+None
+
+Deprecation Notes
+-----------------
+None
+
+Other
+-----
+None \ No newline at end of file