From b07d7922c9bba8d33918ecdb2fd3d3bc03175b9f Mon Sep 17 00:00:00 2001 From: Ofir Sonsino Date: Wed, 8 Nov 2017 16:55:45 +0200 Subject: Update ReadTheDocs docs folder Change-Id: Ifec6f6fd659b1a6d6a3c23f2c02eb2c1fdc0973e Issue-ID: VID-71 Signed-off-by: Ofir Sonsino --- docs/administration.rst | 11 ++++ docs/architecture.rst | 75 +++++++++++++++++++++ docs/configuration.rst | 79 +++++++++++++++++++++++ docs/consumedapis.rst | 99 ++++++++++++++++++++++++++++ docs/delivery.rst | 37 +++++++++++ docs/docs-administration.rst | 11 ---- docs/docs-architecture.rst | 75 --------------------- docs/docs-configuration.rst | 79 ----------------------- docs/docs-consumedapis.rst | 99 ---------------------------- docs/docs-delivery.rst | 37 ----------- docs/docs-humaninterfaces.rst | 15 ----- docs/docs-installation.rst | 31 --------- docs/docs-logging.rst | 27 -------- docs/docs-offeredapis.rst | 147 ------------------------------------------ docs/docs-release-notes.rst | 33 ---------- docs/humaninterfaces.rst | 15 +++++ docs/index.rst | 20 +++--- docs/installation.rst | 31 +++++++++ docs/logging.rst | 27 ++++++++ docs/offeredapis.rst | 147 ++++++++++++++++++++++++++++++++++++++++++ docs/release-notes.rst | 33 ++++++++++ 21 files changed, 564 insertions(+), 564 deletions(-) create mode 100644 docs/administration.rst create mode 100644 docs/architecture.rst create mode 100644 docs/configuration.rst create mode 100644 docs/consumedapis.rst create mode 100644 docs/delivery.rst delete mode 100644 docs/docs-administration.rst delete mode 100644 docs/docs-architecture.rst delete mode 100644 docs/docs-configuration.rst delete mode 100644 docs/docs-consumedapis.rst delete mode 100644 docs/docs-delivery.rst delete mode 100644 docs/docs-humaninterfaces.rst delete mode 100644 docs/docs-installation.rst delete mode 100644 docs/docs-logging.rst delete mode 100644 docs/docs-offeredapis.rst delete mode 100644 docs/docs-release-notes.rst create mode 100644 docs/humaninterfaces.rst create mode 100644 docs/installation.rst create mode 100644 docs/logging.rst create mode 100644 docs/offeredapis.rst create mode 100644 docs/release-notes.rst diff --git a/docs/administration.rst b/docs/administration.rst new file mode 100644 index 000000000..33595fdb8 --- /dev/null +++ b/docs/administration.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Administration +============== + +Actions +------- + +- | **Set the list of services to be instantiated by MACRO** + | To set a certain service for the MACRO style instantiation instead of A La Carte, update MACRO_SERVICES in vidConfiguration.js file, with the service model invariant UUID (More info under the Configurations section). \ No newline at end of file diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 000000000..40e337fef --- /dev/null +++ b/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 the target instantiation environment (e.g. multi-clouds, + testing environment, etc.). + + - Check the availability of already-created and reserved cloud + resources. + - Invoke the creations of cloud resources. + + - Customize Services and VNF/VF to fit a current instantiation. + + - Based on SDC Design specific assignments. + + - Feedback on the 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 currently 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 perform operations 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 tests on a given Service and + VNF/VF. +- Collaboration + + - Project/Admin dashboard (includes 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/configuration.rst b/docs/configuration.rst new file mode 100644 index 000000000..6357d5aac --- /dev/null +++ b/docs/configuration.rst @@ -0,0 +1,79 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Configuration +============= + +Configurations .properties files are located under ``WEB-INF/conf/``, while .js files are under ``scripts/constants/`` + +system.properties file +---------------------- + +``db.connectionURL`` + The connection URL for the VID database + +``db.userName`` + The username for the VID database + +``db.password`` + The password for the VID database + +``aai.server.url.base`` + Base URL for the A&AI server + +``aai.server.url`` + URL for the A&AI server including its version (default: v11) + +``aai.vid.username``, ``aai.vid.pass`` + Credentials for accessing A&AI server offered APIs + +``mso.server.url`` + Base URL for the SO server + +``mso.polling.interval.msecs`` + Interval in milliseconds for polling the SO for the instantiation status + +``mso.max.polls`` + Max attempts for polling the SO instantiation status + +``mso.user.name``, ``mso.password.x`` + Credentials for accessing the SO server + +``scheduler.server.url`` + Base URL for the Scheduler + +``scheduler.create.new.vnf.change.instance``, ``scheduler.get.time.slots``, ``scheduler.submit.new.vnf.change``, ``scheduler.get.schedules`` + Scheduler endpoints + +asdc.properties file +---------------------- +``asdc.client.rest.protocol`` + States the protocol used for accessing SDC: http or https + +``asdc.client.rest.host`` + States the hostname of the SDC instance + +``asdc.client.rest.port`` + States the port of the SDC instance + +``asdc.client.rest.auth`` + Basic authorization string for accessing SDC + +vidConfiguration.js file +------------------------ +``MSO_MAX_POLLS`` + Max attempts for polling the SO instantiation status + +``MSO_POLLING_INTERVAL_MSECS`` + Interval in milliseconds for polling the SO for the instantiation status + +``SCHEDULER_POLLING_INTERVAL_MSECS`` + Interval in milliseconds for polling the Scheduler + +``SCHEDULER_MAX_POLLS`` + Max attempts for polling the Scheduler + +``MACRO_SERVICES`` + | List of all service model invariant UUIDs that need macro instantiation. + | Example: ["3cf30cbb-5fe7-4fb3-b049-559a4997b221", "b135a703-bab5-4295-a37f-580a4f2d0961"] + \ No newline at end of file diff --git a/docs/consumedapis.rst b/docs/consumedapis.rst new file mode 100644 index 000000000..4326aeec6 --- /dev/null +++ b/docs/consumedapis.rst @@ -0,0 +1,99 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Consumed APIs +============= +VID consumes the following APIs from other components: + +SDC +---- + ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| /sdc/v1/catalog/services/meta | Get available services | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| /sdc/v1/catalog/services/toscaModel | Download CSAR by UUID | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ + +SO +--- + ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| POST /serviceInstances/v5 | Create instance | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| DELETE | Delete instance | +| /serviceInstances/v5/ | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| POST | Create VNF | +| /serviceInstances/v5//vnfs | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| DELETE | Delete VNF | +| /serviceInstances/v5//vnfs/ | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| POST | Create VF-Module | +| /serviceInstances/v5//vnfs//vfModules | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| DELETE | Delete VF-Module | +| /serviceInstances/v5//vnfs//vfModules | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| POST | Create Volume group | +| /serviceInstances/v5//vnfs//volumeGroups | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| DELETE | Delete Volume group | +| /serviceInstances/v5//vnfs//volumeGroups | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| POST | Create configuration | +| /serviceInstances/v5//configurations/ | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| DELETE | Delete configuration | +| serviceInstances/v5//configurations/ | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| POST | Create network | +| /serviceInstances/v5//networks | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| DELETE | Delete network (network instance id) | +| /serviceInstances/v5//networks/ | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| GET /orchestrationRequests/v5 | Get orchestration status | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| GET /tasks/v1 | Get available manual tasks by request id | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ + + +A&AI +----- + ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| GET | Get all subscribers | +| aai/v11/business/customers?subscriber-type=INFRA&depth=2 | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| GET aai/v11/ | Get data for a specific subscriber including its available services | +| business/customers/customer/ | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| GET | Get all service types | +| aai/v11/service-design-and-creation/services | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| GET | Get services by owner entity id | +| aai/v11/business/owning-entities? | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| GET | Get services by project name | +| aai/v11/business/projects? | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| GET aai/v11/network/zones | Get all AIC zones | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| POST search/named-query | Get data regarding an instance and the instance's related nodes | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| GET aai/v11/ | Get AIC zones for a specific service instance | +| business/customers/customer// | | +| /service-subscriptions/service-subscription//service-instances/service-instance/ | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| PUT Aai/v11/query?format=simple(types: | This is a custom query and has multiple types(declared in the url line)| +| “query/vnfFromModelbyRegion?cloudRegionId”,” | | +| vnf-topology-fromServiceInstance”) | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| Aai/v11/ | Get the human readable version by version id | +| service-design-and-creation/models?depth=2 | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| business/customers/customer//service-subscriptions/service-subscription/?depth=0 | Get all service subscriptions | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| | | ++-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ \ No newline at end of file diff --git a/docs/delivery.rst b/docs/delivery.rst new file mode 100644 index 000000000..13a9aa389 --- /dev/null +++ b/docs/delivery.rst @@ -0,0 +1,37 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Delivery +======== + +- | **MariaDB Image** + | Create a container using the Docker MariaDB image. + +- | **VID Image** + | Create a Docker image which extends the Tomcat Docker image, and linked to the MariaDB container created earlier. + | Configuration of the Docker container will be customized by providing environment variables to the "docker run" command. + + +.. blockdiag:: + + blockdiag layers { + node_width = 200; + default_fontsize = 24; + node_height = 100; + orientation = portrait + VID -> MariaDb [dir = both]; + + group l1 { + VID; MariaDb [shape = flowchart.database]; + } + } + + +Recommended Rackspace VM Flavor +-------------------------------- ++------------+------------------------+--------+------+-----------+-------+-------------+ +| ID | Flavor name | Memory | Disk | Ephemeral | VCPUs | RTTX factor | ++============+========================+========+======+===========+=======+=============+ +| general1-2 | 2GB General Purpose v1 | 2048 | 40 | 0 | 2 | 400.0 | ++------------+------------------------+--------+------+-----------+-------+-------------+ + diff --git a/docs/docs-administration.rst b/docs/docs-administration.rst deleted file mode 100644 index 33595fdb8..000000000 --- a/docs/docs-administration.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Administration -============== - -Actions -------- - -- | **Set the list of services to be instantiated by MACRO** - | To set a certain service for the MACRO style instantiation instead of A La Carte, update MACRO_SERVICES in vidConfiguration.js file, with the service model invariant UUID (More info under the Configurations section). \ No newline at end of file diff --git a/docs/docs-architecture.rst b/docs/docs-architecture.rst deleted file mode 100644 index 40e337fef..000000000 --- a/docs/docs-architecture.rst +++ /dev/null @@ -1,75 +0,0 @@ -.. 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 the target instantiation environment (e.g. multi-clouds, - testing environment, etc.). - - - Check the availability of already-created and reserved cloud - resources. - - Invoke the creations of cloud resources. - - - Customize Services and VNF/VF to fit a current instantiation. - - - Based on SDC Design specific assignments. - - - Feedback on the 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 currently 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 perform operations 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 tests on a given Service and - VNF/VF. -- Collaboration - - - Project/Admin dashboard (includes 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 deleted file mode 100644 index 6357d5aac..000000000 --- a/docs/docs-configuration.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Configuration -============= - -Configurations .properties files are located under ``WEB-INF/conf/``, while .js files are under ``scripts/constants/`` - -system.properties file ----------------------- - -``db.connectionURL`` - The connection URL for the VID database - -``db.userName`` - The username for the VID database - -``db.password`` - The password for the VID database - -``aai.server.url.base`` - Base URL for the A&AI server - -``aai.server.url`` - URL for the A&AI server including its version (default: v11) - -``aai.vid.username``, ``aai.vid.pass`` - Credentials for accessing A&AI server offered APIs - -``mso.server.url`` - Base URL for the SO server - -``mso.polling.interval.msecs`` - Interval in milliseconds for polling the SO for the instantiation status - -``mso.max.polls`` - Max attempts for polling the SO instantiation status - -``mso.user.name``, ``mso.password.x`` - Credentials for accessing the SO server - -``scheduler.server.url`` - Base URL for the Scheduler - -``scheduler.create.new.vnf.change.instance``, ``scheduler.get.time.slots``, ``scheduler.submit.new.vnf.change``, ``scheduler.get.schedules`` - Scheduler endpoints - -asdc.properties file ----------------------- -``asdc.client.rest.protocol`` - States the protocol used for accessing SDC: http or https - -``asdc.client.rest.host`` - States the hostname of the SDC instance - -``asdc.client.rest.port`` - States the port of the SDC instance - -``asdc.client.rest.auth`` - Basic authorization string for accessing SDC - -vidConfiguration.js file ------------------------- -``MSO_MAX_POLLS`` - Max attempts for polling the SO instantiation status - -``MSO_POLLING_INTERVAL_MSECS`` - Interval in milliseconds for polling the SO for the instantiation status - -``SCHEDULER_POLLING_INTERVAL_MSECS`` - Interval in milliseconds for polling the Scheduler - -``SCHEDULER_MAX_POLLS`` - Max attempts for polling the Scheduler - -``MACRO_SERVICES`` - | List of all service model invariant UUIDs that need macro instantiation. - | Example: ["3cf30cbb-5fe7-4fb3-b049-559a4997b221", "b135a703-bab5-4295-a37f-580a4f2d0961"] - \ No newline at end of file diff --git a/docs/docs-consumedapis.rst b/docs/docs-consumedapis.rst deleted file mode 100644 index 4326aeec6..000000000 --- a/docs/docs-consumedapis.rst +++ /dev/null @@ -1,99 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Consumed APIs -============= -VID consumes the following APIs from other components: - -SDC ----- - -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| /sdc/v1/catalog/services/meta | Get available services | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| /sdc/v1/catalog/services/toscaModel | Download CSAR by UUID | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ - -SO ---- - -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| POST /serviceInstances/v5 | Create instance | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| DELETE | Delete instance | -| /serviceInstances/v5/ | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| POST | Create VNF | -| /serviceInstances/v5//vnfs | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| DELETE | Delete VNF | -| /serviceInstances/v5//vnfs/ | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| POST | Create VF-Module | -| /serviceInstances/v5//vnfs//vfModules | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| DELETE | Delete VF-Module | -| /serviceInstances/v5//vnfs//vfModules | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| POST | Create Volume group | -| /serviceInstances/v5//vnfs//volumeGroups | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| DELETE | Delete Volume group | -| /serviceInstances/v5//vnfs//volumeGroups | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| POST | Create configuration | -| /serviceInstances/v5//configurations/ | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| DELETE | Delete configuration | -| serviceInstances/v5//configurations/ | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| POST | Create network | -| /serviceInstances/v5//networks | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| DELETE | Delete network (network instance id) | -| /serviceInstances/v5//networks/ | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET /orchestrationRequests/v5 | Get orchestration status | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET /tasks/v1 | Get available manual tasks by request id | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ - - -A&AI ------ - -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET | Get all subscribers | -| aai/v11/business/customers?subscriber-type=INFRA&depth=2 | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET aai/v11/ | Get data for a specific subscriber including its available services | -| business/customers/customer/ | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET | Get all service types | -| aai/v11/service-design-and-creation/services | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET | Get services by owner entity id | -| aai/v11/business/owning-entities? | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET | Get services by project name | -| aai/v11/business/projects? | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET aai/v11/network/zones | Get all AIC zones | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| POST search/named-query | Get data regarding an instance and the instance's related nodes | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| GET aai/v11/ | Get AIC zones for a specific service instance | -| business/customers/customer// | | -| /service-subscriptions/service-subscription//service-instances/service-instance/ | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| PUT Aai/v11/query?format=simple(types: | This is a custom query and has multiple types(declared in the url line)| -| “query/vnfFromModelbyRegion?cloudRegionId”,” | | -| vnf-topology-fromServiceInstance”) | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| Aai/v11/ | Get the human readable version by version id | -| service-design-and-creation/models?depth=2 | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| business/customers/customer//service-subscriptions/service-subscription/?depth=0 | Get all service subscriptions | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ -| | | -+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ \ No newline at end of file diff --git a/docs/docs-delivery.rst b/docs/docs-delivery.rst deleted file mode 100644 index 13a9aa389..000000000 --- a/docs/docs-delivery.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Delivery -======== - -- | **MariaDB Image** - | Create a container using the Docker MariaDB image. - -- | **VID Image** - | Create a Docker image which extends the Tomcat Docker image, and linked to the MariaDB container created earlier. - | Configuration of the Docker container will be customized by providing environment variables to the "docker run" command. - - -.. blockdiag:: - - blockdiag layers { - node_width = 200; - default_fontsize = 24; - node_height = 100; - orientation = portrait - VID -> MariaDb [dir = both]; - - group l1 { - VID; MariaDb [shape = flowchart.database]; - } - } - - -Recommended Rackspace VM Flavor --------------------------------- -+------------+------------------------+--------+------+-----------+-------+-------------+ -| ID | Flavor name | Memory | Disk | Ephemeral | VCPUs | RTTX factor | -+============+========================+========+======+===========+=======+=============+ -| general1-2 | 2GB General Purpose v1 | 2048 | 40 | 0 | 2 | 400.0 | -+------------+------------------------+--------+------+-----------+-------+-------------+ - diff --git a/docs/docs-humaninterfaces.rst b/docs/docs-humaninterfaces.rst deleted file mode 100644 index 25c7b5d7e..000000000 --- a/docs/docs-humaninterfaces.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Human Interfaces -================ - -User Guides ------------- - - -The following VID user guides are available on the ONAP Wiki: - -- `VID Application Overview `_ -- `Gather and validate data for an infrastructure service/network `_ -- `Instantiate an infrastructure service `_ diff --git a/docs/docs-installation.rst b/docs/docs-installation.rst deleted file mode 100644 index a2b93d021..000000000 --- a/docs/docs-installation.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Installation -============ - -VID is delivered in a Docker image format. - -Installing VID Using a Docker Image ------------------------------------ - -Please follow the instructions given below, for installing VID using a Docker image. - -1. Download the vid & mariadb Docker image - -.. code-block:: bash - - docker pull mariadb:10 - docker login -u docker -p docker nexus3.onap.org:10001 - docker pull nexus3.onap.org:10001/openecomp/vid:v1.1.0 - -2. Install by running following command (Use the path for the lf_config folder under the VID git repository as CONFIG_PATH) - -.. code-block:: bash - - #start Maria-DB - 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 CONFIG_PATH/vid-pre-init.sql:/docker-entrypoint-initdb.d/vid-pre-init.sql -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/openecomp/vid:v1.1.0 - diff --git a/docs/docs-logging.rst b/docs/docs-logging.rst deleted file mode 100644 index 52d18e85f..000000000 --- a/docs/docs-logging.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Logging -======= - -Where to Access Log Information --------------------------------- - -+------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Location | Type | Description | -+================================================+=====================+===========================================================================================================================================================================================+ -| /usr/local/tomcat/logs/catalina.YYYY-MM-DD.log | Jetty server log | Tomcat server information | -+------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| /opt/app/vid/logs/vid/audit.log | Application audit | An audit record is created in response to code transactions/operations taking place in VID. For instance "start logging". | -+------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| /opt/app/vid/logs/vid/application.log | Application logging | This log describes internal flows within VID. | -+------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| /opt/app/vid/logs/vid/debug.log | Application logging | Higher level logging can be enabled on demand by editing the logback.xml inside the server docker. | -| | | The file is located under: WEB-INF/classes/logback.xml. | -| | | This log holds the application's debug and trace level output. | -+------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| /opt/app/vid/logs/vid/error.log | Application logging | This log holds the application's exceptions info and error level output. | -+------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| /opt/app/vid/logs/vid/metrics.log | Application logging | This log holds the metrics info on application's transactions. | -+------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - diff --git a/docs/docs-offeredapis.rst b/docs/docs-offeredapis.rst deleted file mode 100644 index 4408bf6f0..000000000 --- a/docs/docs-offeredapis.rst +++ /dev/null @@ -1,147 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - - -Offered APIs -================= - -+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Entity | Method | Path Info | Description | -+=====================+==========+=======================================================+===========================================================================================================================================================================================+ -| Health Check | GET | /healthCheck | The Health Status of the application checks the DB connection. | -+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | Used by IDNS for redundancy | -+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | | -+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | return response entity: | -+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | - statusCode Either 200 or 500 | -+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| | | | - The message contains additional detail in the case of an error, and is empty in the 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 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/docs-release-notes.rst b/docs/docs-release-notes.rst deleted file mode 100644 index 7c054a651..000000000 --- a/docs/docs-release-notes.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Release Notes -============= - -Version: 1.1.0 --------------- - - -:Release Date: 2017-11-16 - - - -**New Features** - -1. Improved TOSCA parser. -2. Change Management - Provides the Operators a single tool for installing and maintaining the services as a self service activity. Provides the ability to schedule and execute change management workflows, Maintenance activities for vNFs that are already installed . -3. PNF - PNFs are already installed on the edges of the cloud. In order to configure the PNF, the service needs to be connected to the PNF. - - -**Known Issues** - - `VID-78 `_ - VID shows the HTML code output whenever the customer list is empty (Cosmetic) - -**Upgrade Notes** -A scheduler is needed for the change management feature to work (not included in the Amsterdam release). - -**Other** -In order to work properly, VID needs a working instance of SDC, A&AI and SO. - -=========== - -End of Release Notes diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst new file mode 100644 index 000000000..25c7b5d7e --- /dev/null +++ b/docs/humaninterfaces.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Human Interfaces +================ + +User Guides +------------ + + +The following VID user guides are available on the ONAP Wiki: + +- `VID Application Overview `_ +- `Gather and validate data for an infrastructure service/network `_ +- `Instantiate an infrastructure service `_ diff --git a/docs/index.rst b/docs/index.rst index 4f5b8db4c..c22d1cfd4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,13 +7,13 @@ VID Documentation :maxdepth: 2 - docs-architecture.rst - docs-offeredapis.rst - docs-consumedapis.rst - docs-delivery.rst - docs-logging.rst - docs-installation.rst - docs-configuration.rst - docs-administration.rst - docs-humaninterfaces.rst - docs-release-notes.rst + architecture.rst + offeredapis.rst + consumedapis.rst + delivery.rst + logging.rst + installation.rst + configuration.rst + administration.rst + humaninterfaces.rst + release-notes.rst diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 000000000..a2b93d021 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,31 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Installation +============ + +VID is delivered in a Docker image format. + +Installing VID Using a Docker Image +----------------------------------- + +Please follow the instructions given below, for installing VID using a Docker image. + +1. Download the vid & mariadb Docker image + +.. code-block:: bash + + docker pull mariadb:10 + docker login -u docker -p docker nexus3.onap.org:10001 + docker pull nexus3.onap.org:10001/openecomp/vid:v1.1.0 + +2. Install by running following command (Use the path for the lf_config folder under the VID git repository as CONFIG_PATH) + +.. code-block:: bash + + #start Maria-DB + 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 CONFIG_PATH/vid-pre-init.sql:/docker-entrypoint-initdb.d/vid-pre-init.sql -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/openecomp/vid:v1.1.0 + diff --git a/docs/logging.rst b/docs/logging.rst new file mode 100644 index 000000000..52d18e85f --- /dev/null +++ b/docs/logging.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 + +Logging +======= + +Where to Access Log Information +-------------------------------- + ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Location | Type | Description | ++================================================+=====================+===========================================================================================================================================================================================+ +| /usr/local/tomcat/logs/catalina.YYYY-MM-DD.log | Jetty server log | Tomcat server information | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/audit.log | Application audit | An audit record is created in response to code transactions/operations taking place in VID. For instance "start logging". | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/application.log | Application logging | This log describes internal flows within VID. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/debug.log | Application logging | Higher level logging can be enabled on demand by editing the logback.xml inside the server docker. | +| | | The file is located under: WEB-INF/classes/logback.xml. | +| | | This log holds the application's debug and trace level output. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/error.log | Application logging | This log holds the application's exceptions info and error level output. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| /opt/app/vid/logs/vid/metrics.log | Application logging | This log holds the metrics info on application's transactions. | ++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst new file mode 100644 index 000000000..4408bf6f0 --- /dev/null +++ b/docs/offeredapis.rst @@ -0,0 +1,147 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +Offered APIs +================= + ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Entity | Method | Path Info | Description | ++=====================+==========+=======================================================+===========================================================================================================================================================================================+ +| Health Check | GET | /healthCheck | The Health Status of the application checks the DB connection. | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | Used by IDNS for redundancy | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | return response entity: | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | - statusCode Either 200 or 500 | ++---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | | | - The message contains additional detail in the case of an error, and is empty in the 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 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 new file mode 100644 index 000000000..7c054a651 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,33 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Release Notes +============= + +Version: 1.1.0 +-------------- + + +:Release Date: 2017-11-16 + + + +**New Features** + +1. Improved TOSCA parser. +2. Change Management - Provides the Operators a single tool for installing and maintaining the services as a self service activity. Provides the ability to schedule and execute change management workflows, Maintenance activities for vNFs that are already installed . +3. PNF - PNFs are already installed on the edges of the cloud. In order to configure the PNF, the service needs to be connected to the PNF. + + +**Known Issues** + - `VID-78 `_ + VID shows the HTML code output whenever the customer list is empty (Cosmetic) + +**Upgrade Notes** +A scheduler is needed for the change management feature to work (not included in the Amsterdam release). + +**Other** +In order to work properly, VID needs a working instance of SDC, A&AI and SO. + +=========== + +End of Release Notes -- cgit 1.2.3-korg