Merge "Docs update" into casablanca

3 files changed, 63 insertions, 112 deletions

diff --git a/docs/installation.rst b/docs/installation.rst
index e7a1585a..040baf28 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -17,7 +17,7 @@ Please follow the instructions given below, for installing VID using a Docker im
 
   docker pull mariadb:10
   docker login -u docker -p docker nexus3.onap.org:10001
-  docker pull nexus3.onap.org:10001/onap/vid:1.2.1
+  docker pull nexus3.onap.org:10001/onap/vid:3.1.0
 
 2. Install by running following command (Use the path for the lf_config folder under the VID git repository as CONFIG_PATH)
 
@@ -27,7 +27,7 @@ Please follow the instructions given below, for installing VID using a Docker im
    docker run --name vid-mariadb -e MYSQL_DATABASE=vid_openecomp_epsdk -e MYSQL_USER=vidadmin -e MYSQL_PASSWORD=YOUR_PASSWORD -e MYSQL_ROOT_PASSWORD=ROOT_PASSWORD -v CONFIG_PATH/vid-my.cnf:/etc/mysql/my.cnf -v /var/lib/mysql -d mariadb:10
    
    #start VID server
-   docker run -e VID_MYSQL_DBNAME=vid_openecomp_epsdk -e VID_MYSQL_PASS=YOUR_PASSWORD --name vid-server -p 8080:8080 --link vid-mariadb:vid-mariadb-docker-instance -d nexus3.onap.org:10001/onap/vid:1.2.1
+   docker run -e VID_MYSQL_DBNAME=vid_openecomp_epsdk -e VID_MYSQL_PASS=YOUR_PASSWORD --name vid-server -p 8080:8080 --link vid-mariadb:vid-mariadb-docker-instance -d nexus3.onap.org:10001/onap/vid:3.1.0
 
 Or use docker-compose:
 
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
index 4408bf6f..e8f7ef78 100644
--- a/docs/offeredapis.rst
+++ b/docs/offeredapis.rst
@@ -35,113 +35,3 @@ Offered APIs
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |                     |          |                                                       |                                                                                                                                                                                           |
 +---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Health Check        | GET      | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID}     | The Health Status of the application checks the DB connection                                                                                                                             |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | return response entity:                                                                                                                                                                   |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | - statusCode Either 200 or 500                                                                                                                                                            |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | - message contains additional detail in the case of an error, and is empty in the case of success.                                                                                        |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | - date string indicating the current date & time                                                                                                                                          |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | Expected:                                                                                                                                                                                 |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | {                                                                                                                                                                                         |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “statusCode”:200,                                                                                                                                                                         |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “message”:“health check succeeded”,                                                                                                                                                       |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “date”: current date                                                                                                                                                                      |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | }                                                                                                                                                                                         |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Change management   | GET      | change-management/workflow {vnfStringsList}           | Get Workflow details for the VNFs list                                                                                                                                                    |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | Expected HTTP Code 200                                                                                                                                                                    |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Change management   | GET      | change-management/mso                                 | Get MSO Change Management details                                                                                                                                                         |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | [{“requestId”:“”,“requestScope”:“vnf”,“requestStatus”:{“percentProgress”:,                                                                                                                |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “requestState”:“FAILED”,                                                                                                                                                                  |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “statusMessage”:“Service request FAILED schema validation. No valid vnf-id is specified”,                                                                                                 |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “finishTime”:“Fri, 20 May 2016 13:36:53 GMT”},                                                                                                                                            |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “requestType”:“updateInstance”,                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “startTime”:“Fri, 20 May 2016 13:36:53 GMT”,                                                                                                                                              |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | “instanceReferences”:{“vnfInstanceName”:“ZRDM1PCRF01”,“vfModuleInstanceName”:“ZRDM1PCRF01-PCRF::base::module-0”,“volumeGroupInstanceId”:“1cc27274-1376-4168-af5d-3e35d1365a4c”}}, {…}…]   |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | Expected HTTP Code 200                                                                                                                                                                    |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Change management   | POST     | change-management/workflow/{vnfName}                  | Post workflow request for vnf                                                                                                                                                             |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | Request body:                                                                                                                                                                             |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | requestDetails:{                                                                                                                                                                          |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | vnfName: vnfNAME                                                                                                                                                                          |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | vnfInstanceId: ID                                                                                                                                                                         |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | RelatedInstanceList:[ ]                                                                                                                                                                   |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | }                                                                                                                                                                                         |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | requestType:                                                                                                                                                                              |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | Expected HTTP Code 200                                                                                                                                                                    |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Change management   | GET      | change-management/scheduler                           | Get Scheduler Change Management Details                                                                                                                                                   |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | Expected                                                                                                                                                                                  |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | HTTP Code 200                                                                                                                                                                             |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | response: Scheduler details in json                                                                                                                                                       |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | Explicit HTTP Error Codes                                                                                                                                                                 |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       | 404, 406                                                                                                                                                                                  |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                     |          |                                                       |                                                                                                                                                                                           |
-+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
\ No newline at end of file
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 89e1919d..d267e4d2 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -3,6 +3,67 @@
 VID Release Notes
 =================
 
+Version: 3.1.0
+--------------
+
+:Release Date: 2018-11-15
+
+New Features
+------------
+1. PNF plug & play services instantiation.
+2. HTTPS support.
+3. Manual vNF Scale Out enhancements.
+
+**Epics**
+
+-  [`VID-159`_] - AAF integration
+-  [`VID-194`_] - PNF Use case support
+-  [`VID-248`_] - Support scaling use case
+-  [`VID-254`_] - Usability
+-  [`VID-258`_] - Security
+
+.. _VID-159: /browse/VID-159
+.. _VID-194: /browse/VID-194
+.. _VID-248: /browse/VID-248
+.. _VID-254: /browse/VID-254
+.. _VID-258: /browse/VID-258
+
+**Stories**
+
+-  [`VID-166`_] - Improve CSIT coverage
+-  [`VID-203`_] - PNF Plug & Play use case with vCPE flow
+-  [`VID-236`_] - Align OOM templates
+-  [`VID-249`_] - Change Manual Scaling Use Case to use the same SO API that Policy is using in Auto Scaling
+-  [`VID-250`_] - Remove Controller Type from the VID GUI and from the request sent to SO
+-  [`VID-256`_] - Add tutorials/user guides
+-  [`VID-257`_] - AAF integration
+-  [`VID-260`_] - Use HTTPS for external interfaces
+-  [`VID-261`_] - Use HTTPS for internal interfaces
+
+.. _VID-166: /browse/VID-166
+.. _VID-203: /browse/VID-203
+.. _VID-236: /browse/VID-236
+.. _VID-249: /browse/VID-249
+.. _VID-250: /browse/VID-250
+.. _VID-256: /browse/VID-256
+.. _VID-257: /browse/VID-257
+.. _VID-260: /browse/VID-260
+.. _VID-261: /browse/VID-261
+
+**Security Notes**
+
+VID code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The VID open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378623>`_.
+
+Quick Links:
+
+- `VID project page <https://wiki.onap.org/display/DW/Virtual+Infrastructure+Deployment+Project>`_
+- `Passing Badge information for VID <https://bestpractices.coreinfrastructure.org/en/projects/1658>`_
+- `Project Vulnerability Review Table for VID <https://wiki.onap.org/pages/viewpage.action?pageId=28378623>`_
+
+**Other**
+
+In order to work properly, VID needs a working instance of SDC, A&AI and SO.
+
 Version: 2.0.0
 --------------