From 49351d760fb64a9eb26a2a5a79aa4799d0696aef Mon Sep 17 00:00:00 2001 From: Ofir Sonsino Date: Tue, 24 Oct 2017 10:18:23 +0300 Subject: Update ReadTheDocs docs folder Change-Id: Ib1bf76d20f7e80a9152eb28c122cc5b98be0b1c8 Issue-ID: VID-71 Signed-off-by: Ofir Sonsino --- docs/api/index.rst | 147 ------------------------------------------ docs/docs-administration.rst | 24 +++++++ docs/docs-architecture.rst | 75 +++++++++++++++++++++ docs/docs-configuration.rst | 27 ++++++++ docs/docs-consumedapis.rst | 16 +++++ docs/docs-delivery.rst | 44 +++++++++++++ docs/docs-humaninterfaces.rst | 17 +++++ docs/docs-installation.rst | 20 ++++++ docs/docs-logging.rst | 36 +++++++++++ docs/docs-offeredapis.rst | 147 ++++++++++++++++++++++++++++++++++++++++++ docs/docs-release-notes.rst | 48 ++++++++++++++ docs/index.rst | 17 ++++- docs/intro/index.rst | 75 --------------------- 13 files changed, 468 insertions(+), 225 deletions(-) delete mode 100644 docs/api/index.rst create mode 100644 docs/docs-administration.rst create mode 100644 docs/docs-architecture.rst create mode 100644 docs/docs-configuration.rst create mode 100644 docs/docs-consumedapis.rst create mode 100644 docs/docs-delivery.rst create mode 100644 docs/docs-humaninterfaces.rst create mode 100644 docs/docs-installation.rst create mode 100644 docs/docs-logging.rst create mode 100644 docs/docs-offeredapis.rst create mode 100644 docs/docs-release-notes.rst delete mode 100644 docs/intro/index.rst diff --git a/docs/api/index.rst b/docs/api/index.rst deleted file mode 100644 index 9181b195..00000000 --- a/docs/api/index.rst +++ /dev/null @@ -1,147 +0,0 @@ -.. 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/docs-administration.rst b/docs/docs-administration.rst new file mode 100644 index 00000000..94a74071 --- /dev/null +++ b/docs/docs-administration.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Administration +============== + + +.. note:: + * This section is used to describe a software component from the perspective of on-going + operation including regular processes and actions that are taken to configure and manage + the component. + + * This section is typically: provided for platform-component or applications; and + referenced in user guides + + * This note must be removed after content has been added. + + +Processes +--------- + + +Actions +------- diff --git a/docs/docs-architecture.rst b/docs/docs-architecture.rst new file mode 100644 index 00000000..2710cb9a --- /dev/null +++ b/docs/docs-architecture.rst @@ -0,0 +1,75 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +VID Architecture +================= +VID 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 diff --git a/docs/docs-configuration.rst b/docs/docs-configuration.rst new file mode 100644 index 00000000..085f9c66 --- /dev/null +++ b/docs/docs-configuration.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Configuration +============= + +.. note:: + * This section is used to describe the options a software component offers for configuration. + + * Configuration is typically: provided for platform-component and sdk projects; + and referenced in developer and user guides. + + * This note must be removed after content has been added. + + + +Example ... + +You can provide the following in ``basic.conf`` + +``host=ADDRESS`` + The address of the host + +``port=PORT`` + The port used for signaling + + Optional. Default: ``8080`` diff --git a/docs/docs-consumedapis.rst b/docs/docs-consumedapis.rst new file mode 100644 index 00000000..c2af4c20 --- /dev/null +++ b/docs/docs-consumedapis.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Consumed APIs +============= + +.. note:: + * This section is used to reference APIs that a software component depends on + and uses from other sources. + + * Consumed APIs should be a specific link to the offered APIs from another component + or external source. + + * This note must be removed after content has been added. + + diff --git a/docs/docs-delivery.rst b/docs/docs-delivery.rst new file mode 100644 index 00000000..f3f083a7 --- /dev/null +++ b/docs/docs-delivery.rst @@ -0,0 +1,44 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Delivery +======== + +.. note:: + * This section is used to describe a software component packaging. + For a run-time component this might be executable images, containers, etc. + For an SDK this might be libraries. + + * This section is typically provided for a platform-component and sdk; + and referenced in developer and user guides + + * This note must be removed after content has been added. + +Example use of a block diagram. + +.. blockdiag:: + + + blockdiag layers { + orientation = portrait + a -> m; + b -> n; + c -> x; + m -> y; + m -> z; + group l1 { + color = blue; + x; y; z; + } + group l2 { + color = yellow; + m; n; + } + group l3 { + color = orange; + a; b; c; + } + + } + + diff --git a/docs/docs-humaninterfaces.rst b/docs/docs-humaninterfaces.rst new file mode 100644 index 00000000..42928460 --- /dev/null +++ b/docs/docs-humaninterfaces.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Human Interfaces +================ + +.. note:: + * This section is used to describe a software component's command line and graphical + user interfaces. + + * This section is typically: provided for a platform-component and application; and + referenced from user guides. + + * This note must be removed after content has been added. + + + diff --git a/docs/docs-installation.rst b/docs/docs-installation.rst new file mode 100644 index 00000000..be64a63b --- /dev/null +++ b/docs/docs-installation.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Installation +============ + +.. note:: + * This section is used to describe how a software component is acquired and installed. + + * This section is typically: provided for a platform-component and application; and + referenced in user guides. + + * This note must be removed after content has been added. + +Environment +----------- + + +Steps +----- diff --git a/docs/docs-logging.rst b/docs/docs-logging.rst new file mode 100644 index 00000000..b65f2aef --- /dev/null +++ b/docs/docs-logging.rst @@ -0,0 +1,36 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Logging +======= + +.. note:: + * This section is used to describe the informational or diagnostic messages emitted from + a software component and the methods or collecting them. + + * This section is typically: provided for a platform-component and sdk; and + referenced in developer and user guides + + * This note must be removed after content has been added. + + +Where to Access Information +--------------------------- + ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| Location | Type | Description | Rolling | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| /opt/app/vid/logs/vid/application.log | Jetty server log | This log describes inner flows inside VID | the log rolls daily | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| /opt/app/vid/logs/vid/audit.log | application audit | An audit record is created for some of the operations in VID | rolls at 20 mb | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| /opt/app/vid/logs/vid/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. | rolls at 20 mb | +| | | The file is located under: WEB-INF/classes/logback.xml. | | +| | | This log holds the debug and trace level output of the application. | | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| /opt/app/vid/logs/vid/error.log | application logging | This log holds the info and error level output of the application. | rolls at 20 mb | ++------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ + + +Error / Warning Messages +------------------------ diff --git a/docs/docs-offeredapis.rst b/docs/docs-offeredapis.rst new file mode 100644 index 00000000..9181b195 --- /dev/null +++ b/docs/docs-offeredapis.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/docs-release-notes.rst b/docs/docs-release-notes.rst new file mode 100644 index 00000000..b568bee8 --- /dev/null +++ b/docs/docs-release-notes.rst @@ -0,0 +1,48 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Release Notes +============= + +.. note:: + * This Release Notes must be updated each time the team decides to Release new artifacts. + * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. + * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. + * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. + * This note must be removed after content has been added. + + +Version: x.y.z +-------------- + + +:Release Date: yyyy-mm-dd + + + +**New Features** + +One or two sentences explaining the purpose of this Release. + +**Bug Fixes** + - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. +**Known Issues** + - `CIMAN-65 `_ and two, three sentences. + One sentences explaining what is the issue. + + Another sentence explaining the impact of the issue. + + And an optional sentence providing a workaround. + +**Security Issues** + You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ + + +**Upgrade Notes** + +**Deprecation Notes** + +**Other** + +=========== + +End of Release Notes diff --git a/docs/index.rst b/docs/index.rst index 920bdb5f..b9712708 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,18 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +VID Documentation +================= + .. toctree:: :maxdepth: 2 - - intro/index - api/index \ No newline at end of file + + administration.rst + architecture.rst + configuration.rst + consumedapis.rst + offeredapis.rst + delivery.rst + humaninterfaces.rst + installation.rst + logging.rst + release-notes.rst diff --git a/docs/intro/index.rst b/docs/intro/index.rst deleted file mode 100644 index 6164adeb..00000000 --- a/docs/intro/index.rst +++ /dev/null @@ -1,75 +0,0 @@ -.. 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 -- cgit 1.2.3-korg