Administration
==============
-
-.. note::
- * This section is used to describe a software component from the perspective of on-going
- operation including regular processes and actions that are taken to configure and manage
- the component.
-
- * This section is typically: provided for platform-component or applications; and
- referenced in user guides
-
- * This note must be removed after content has been added.
-
-
-Processes
----------
-
-
Actions
-------
+
+- | **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
- Macro orchestration.
- A la carte orchestration.
- - Choose target instantiation environment (e.g. multi-clouds,
+ - Choose the target instantiation environment (e.g. multi-clouds,
testing environment, etc.).
- - Check availability of already-created and reserved cloud
+ - Check the availability of already-created and reserved cloud
resources.
- Invoke the creations of cloud resources.
- - Customize Service and VNF/VF to fit a current instantiation.
+ - Customize Services and VNF/VF to fit a current instantiation.
- Based on SDC Design specific assignments.
- - Feedback on instantiation process according to the instantiation
+ - Feedback on the instantiation process according to the instantiation
workflow.
- Ability to invoke maintenance operations on an unsuccessful
- Change-management
- - Integration with inventory (A&AI) to retrieve current deployed
+ - 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 monitoring-templates (MTs: control-loops).
+ - Invoke a CM for policy changes
- Invoke a CM for license changes
- etc..
- - Ability to operate on a workflow (e.g. actions as stop, start,
+ - 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 test on a given Service and
+- Invoke security, load and performance tests on a given Service and
VNF/VF.
- Collaboration
- - Project/Admin dashboard (include user management, VNF/VF and
+ - Project/Admin dashboard (includes user management, VNF/VF and
Services relevant to the project).
- Interfaces:
Configuration
=============
-Configurations files are located under ``WEB-INF/conf/``
+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 VID database
+ The connection URL for the VID database
``db.userName``
- The username for VID database
+ The username for the VID database
``db.password``
- The password for VID database
+ The password for the VID database
``aai.server.url.base``
- Base URL for A&AI server
+ Base URL for the A&AI server
``aai.server.url``
- URL for A&AI server including its version (default: v11)
+ URL for the A&AI server including its version (default: v11)
``aai.vid.username``, ``aai.vid.pass``
- Credentials for accessing A&AI
+ Credentials for accessing A&AI server offered APIs
``mso.server.url``
- Base URL for SO server
+ Base URL for the SO server
``mso.polling.interval.msecs``
- Interval in milliseconds for polling SO for instantiation status
+ Interval in milliseconds for polling the SO for the instantiation status
``mso.max.polls``
- Max polling tryings fo SO instantiation status
+ Max attempts for polling the SO instantiation status
``mso.user.name``, ``mso.password.x``
- Credentials for accessing SO
+ Credentials for accessing the SO server
``scheduler.server.url``
- Base URL for Scheduler
+ 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 for accessing SDC: http or https
+ States the protocol used for accessing SDC: http or https
``asdc.client.rest.host``
- States the hostname of SDC instance
+ States the hostname of the SDC instance
``asdc.client.rest.port``
- States the port of SDC instance
+ States the port of the SDC instance
``asdc.client.rest.auth``
- Basic authorization string to access SDC
\ No newline at end of file
+ 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
----
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
-| /sdc/v1/catalog/services/meta | Get services general. |
+| /sdc/v1/catalog/services/meta | Get available services |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
-| /sdc/v1/catalog/services/toscaModel | Download csar by UUID |
+| /sdc/v1/catalog/services/toscaModel | Download CSAR by UUID |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
SO
| POST | Create Volume group |
| /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups | |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
-| DELETE | Delete Volume Group |
+| DELETE | Delete Volume group |
| /serviceInstances/v5/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups | |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| POST | Create configuration |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| GET /orchestrationRequests/v5 | Get orchestration status |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
-| GET /tasks/v1 | Get available Manual tasks by request id |
+| GET /tasks/v1 | Get available manual tasks by request id |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| GET | Get all subscribers |
| aai/v11/business/customers?subscriber-type=INFRA&depth=2 | |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
-| GET aai/v11/ | Get data for specific subscriber including its available services |
+| GET aai/v11/ | Get data for a specific subscriber including its available services |
| business/customers/customer/<global_customer_id> | |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| GET | Get all service types |
| aai/v11/service-design-and-creation/services | |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
-| GET | Get services by owning entity id |
+| GET | Get services by owner entity id |
| aai/v11/business/owning-entities?<owning_entitiy_ids> | |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| GET | Get services by project name |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| GET aai/v11/network/zones | Get all AIC zones |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
-| POST search/named-query | Get the data regarding instance and it’s related nodes |
+| POST search/named-query | Get data regarding an instance and the instance's related nodes |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
-| GET aai/v11/ | Get AIC zones for specific service instance |
+| GET aai/v11/ | Get AIC zones for a specific service instance |
| business/customers/customer/<global_customer_id>/ | |
| /service-subscriptions/service-subscription/<service_type>/service-instances/service-instance/<service_instance_id> | |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
-| PUT Aai/v11/query?format=simple(types: | This is custom query and has multiple types (declared in the url line) |
+| 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 human readable version by version id |
+| Aai/v11/ | Get the human readable version by version id |
| service-design-and-creation/models?depth=2 | |
+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| business/customers/customer/<global_customer_id>/service-subscriptions/service-subscription/<service_Subscription_Id>?depth=0 | Get all service subscriptions |
Delivery
========
-VID is delivered as a docker image, and uses MariaDb which also delivered as a docker image. The two images are linked.
+VID is delivered as a Docker image, and uses MariaDb which is also delivered as a Docker image. The two images are linked.
+
+
+- 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 {
- orientation = portrait
- VID -> MariaDb;
- MariaDb -> VID;
- group l1 {
- color = blue;
- VID; MariaDb;
- }
+ 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 | | | |
++------------+------------------------+--------+------+-----------+-------+-------------+--+--+--+
Human Interfaces
================
-The following VID user guides are available in ONAP Wiki:
+User Guides
+------------
+
+
+The following VID user guides are available on the ONAP Wiki:
-- `VID Application overview <https://wiki.onap.org/display/DW/VID>`_
+- `VID Application Overview <https://wiki.onap.org/display/DW/VID>`_
- `Gather and validate data for an infrastructure service/network <https://wiki.onap.org/pages/viewpage.action?pageId=1019313>`_
- `Instantiate an infrastructure service <https://wiki.onap.org/display/DW/Instantiate+an+infrastructure+service>`_
VID is delivered in a Docker image format.
-Using docker image
-------------------
+Installing VID Using a Docker Image
+-----------------------------------
-Please follow the instructions given below, for installing VID using docker image.
+Please follow the instructions given below, for installing VID using a Docker image.
-1. Download the vid & mariadb docker image
+1. Download the vid & mariadb Docker image
.. code-block:: bash
docker login -u docker -p docker nexus3.onap.org:10001
docker pull nexus3.onap.org:10001/openecomp/vid:1.1-STAGING-latest
-2. Install by running following command (Use the path for lf_config folder under VID git repository as CONFIG_PATH)
+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
Logging
=======
-Where to Access Information
----------------------------
+Where to Access Log Information
+--------------------------------
-+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Location | Type | Description |
-+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| /opt/app/vid/logs/vid/application.log | Jetty server log | This log describes inner flows inside VID |
-+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| /opt/app/vid/logs/vid/audit.log | application audit | An audit record is created for some of the operations in VID |
-+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| /opt/app/vid/logs/vid/debug.log | application logging | We can enable higher logging on demand by editing the logback.xml inside the server docker. |
-| | | The file is located under: WEB-INF/classes/logback.xml. |
-| | | This log holds the debug and trace level output of the application. |
-+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| /opt/app/vid/logs/vid/error.log | application logging | This log holds the info and error level output of the application. |
-+------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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. |
++------------------------------------------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-VID API
+Offered APIs
=================
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Entity | Method | Path Info | Description |
+=====================+==========+=======================================================+===========================================================================================================================================================================================+
-| Health Check | GET | /healthCheck | The Health Status of application check the DB connection |
+| Health Check | GET | /healthCheck | The Health Status of the application checks the DB connection. |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | Used by IDNS for redundancy |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | - statusCode Either 200 or 500 |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| | | | - message Additional detail in case of error, empty in case of success. |
+| | | | - The message contains additional detail in the case of an error, and is empty in the case of success. |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of application check the DB connection |
+| Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of the application checks the DB connection |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | - statusCode Either 200 or 500 |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| | | | - message Additional detail in case of error, empty in case of success. |
+| | | | - message contains additional detail in the case of an error, and is empty in the case of success. |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| | | | - date string of current date & time |
+| | | | - date string indicating the current date & time |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Change management | GET | change-management/workflow {vnfStringsList} | Get Workflows details For VNFs list |
+| Change management | GET | change-management/workflow {vnfStringsList} | Get Workflow details for the VNFs list |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Change management | GET | change-management/mso | Get MSO Change Managements |
+| Change management | GET | change-management/mso | Get MSO Change Management details |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Change management | GET | change-management/scheduler | Get Scheduler Change Managements |
+| Change management | GET | change-management/scheduler | Get Scheduler Change Management Details |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | HTTP Code 200 |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| | | | response: scheduler details in json |
+| | | | response: Scheduler details in json |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | |
+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**New Features**
1. Improved TOSCA parser.
-2. Change Management - Provides the Operators one tool to install as well as maintain the services as a self service activity. Ability to schedule and execute change management Workflows(Maintenance activities )for already installed vNFs.
-3. PNF - PNFs are already installed on the edges of the cloud. In order to configure the PNF its required to connect the service to the PNF.
+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 <https://jira.onap.org/browse/VID-78>`_
- VID shows HTML code output whenever customer list is empty (Cosmetic)
+ 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 Amsterdam release).
+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.
===========
docs-logging.rst
docs-installation.rst
docs-configuration.rst
+ docs-administration.rst
docs-humaninterfaces.rst
docs-release-notes.rst
Code Review / vid.git / commitdiff