diff options
| -rw-r--r-- | docs/api/index.rst | 147 | ||||
| -rw-r--r-- | docs/index.rst | 7 | ||||
| -rw-r--r-- | docs/intro/index.rst | 75 |
3 files changed, 225 insertions, 4 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst new file mode 100644 index 00000000..9181b195 --- /dev/null +++ b/docs/api/index.rst @@ -0,0 +1,147 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +VID API +================= + ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Entity | Method | Path Info | Description | ++=====================+==========+=======================================================+===========================================================================================================================================================================================+ +| Health Check | GET | /healthCheck | The Health Status of application check the DB connection | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | Used by IDNS for redundancy | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | return response entity: | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | - statusCode Either 200 or 500 | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | - message Additional detail in case of error, empty in case of success. | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | Expected: | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | { | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | “statusCode”:200, | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | “message”:“health check succeeded”, | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | “date”:null | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | } | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of application check the DB connection | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | return response entity: | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | - statusCode Either 200 or 500 | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | - message Additional detail in case of error, empty in case of success. | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | - date string of current date & time | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | Expected: | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | { | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | “statusCode”:200, | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | “message”:“health check succeeded”, | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | “date”: current date | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | } | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Change management | GET | change-management/workflow {vnfStringsList} | Get Workflows details For VNFs list | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | Expected HTTP Code 200 | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Change management | GET | change-management/mso | Get MSO Change Managements | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | [{“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 Managements | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | 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/index.rst b/docs/index.rst index 833e1aa9..920bdb5f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -TODO Add files to toctree and delete this header ------------------------------------------------- .. toctree:: - :maxdepth: 1 - + :maxdepth: 2 + intro/index + api/index
\ No newline at end of file diff --git a/docs/intro/index.rst b/docs/intro/index.rst new file mode 100644 index 00000000..6164adeb --- /dev/null +++ b/docs/intro/index.rst @@ -0,0 +1,75 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +VID Introduction +================= +Provides a well-structured organization of infrastructure deployment, +instantiation and change-management operations used by Operations to derive orchestrations and change-management. + + +Scope +------ +- Invoke instantiation of a Service and all of its sub-components (e.g. + VNF/VF, VNFC/VFC, Modules, Deployment Flavor, etc). +- Invoke instantiation and creation of cloud logical environment (e.g. + tenants). +- Integration with Operations ticketing system for instantiation and + change-management ordering requests. +- Instantiation + + - Instantiation modes. + + - Macro orchestration. + - A la carte orchestration. + + - Choose target instantiation environment (e.g. multi-clouds, + testing environment, etc.). + + - Check availability of already-created and reserved cloud + resources. + - Invoke the creations of cloud resources. + + - Customize Service and VNF/VF to fit a current instantiation. + + - Based on SDC Design specific assignments. + + - Feedback on instantiation process according to the instantiation + workflow. + + - Ability to invoke maintenance operations on an unsuccessful + instantiation. + +- Change-management + + - Integration with inventory (A&AI) to retrieve current deployed + Services. + - Agnostic and specific change-management workflows derived from SDC + Service and VNF/VF models. + - + + - Invoke a CM for a given Service and VNF/VF. + - invoke a CM for monitoring-templates (MTs: control-loops). + - invoke a CM for policy changes + - Invoke a CM for license changes + - etc.. + + - Ability to operate on a workflow (e.g. actions as stop, start, + restart, resume). + - Ability to schedule a workflow + + - notify + - automatic instantiation upon reaching the scheduled time. + +- Invoke Security, Load and performance test on a given Service and + VNF/VF. +- Collaboration + + - Project/Admin dashboard (include user management, VNF/VF and + Services relevant to the project). + +- Interfaces: + + - SDC - get models + - A&AI - get current deployment (inventory) + - MSO - invoke instantiation and change-management. + - BYO Scheduler - set/get schedule
\ No newline at end of file |