VID Documentation

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

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
- detailedMsg of the result, in case of failure particular error message

Expected:
{
  "statusCode": 200,
  "detailedMsg": "health check succeeded",
  "date": current date
}

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
- detailedMsg of the result, in case of failure particular error message
- date string indicating the current date & time

Expected:
{
  "statusCode": 200,
  "detailedMsg": "health check succeeded",
  "date": current date
}

Commit Version

GET

/commitInfo

Displays info about the last commit of the running build

return response entity:
- commitId full id of the commit
- commitMessageShort short message from the commit
- commitTime time of the commit

Expected:
{
  "commitId": id of the last commit
  "commitMessageShort": short message of the last commit
  "commitTime": time of the last commit
}

Maintenance APIs

Maintenance: Category Parameters

POST

/maintenance/category_parameter/{categoryName}

Populate VID Project/Owning entity/Line of Business/Platform drop downs

{categoryName} is one of lineOfBusiness, platform, project, owningEntity.

POST body:

{
  "options": [ <list of strings> ]
}

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 /e2eServiceInstances/v3

Create E2E instance

POST /serviceInstances/v6

Create instance

DELETE

/serviceInstances/v6/<instance-id>

Delete instance

POST

/serviceInstances/v6/<service_instance_id>/vnfs

Create VNF

DELETE

/serviceInstances/v6/<service_instance_id>/vnfs/<vnf_id>

Delete VNF

POST

/serviceInstances/v6/<service_instance_id>/vnfs/<vnf_instance_id>/vfModules

Create VF-Module

DELETE

/serviceInstances/v6/<service_instance_id>/vnfs/<vnf_instance_id>/vfModules

Delete VF-Module

POST

/serviceInstances/v6/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups

Create Volume group

DELETE

/serviceInstances/v6/<service_instance_id>/vnfs/<vnf_instance_id>/volumeGroups

Delete Volume group

POST

/serviceInstances/v6/<service_instance_id>/configurations/

Create configuration

DELETE

serviceInstances/v6/<service_instance_id>/configurations/<configuration_id>

Delete configuration

POST

/serviceInstances/v6/<service_instance_id>/networks

Create network

DELETE

/serviceInstances/v6/<service_instance_id>/networks/<network_instance_id>

Delete network (network instance id)

GET /orchestrationRequests/v6

Get orchestration status

GET /tasks/v1

Get available manual tasks by request id

A&AI

GET

aai/v19/business/customers?subscriber-type=INFRA&depth=2

Get all subscribers

GET aai/v19/

business/customers/customer/<global_customer_id>

Get data for a specific subscriber including its available services

GET

aai/v19/service-design-and-creation/services

Get all service types

GET

aai/v19/business/owning-entities?<owning_entitiy_ids>

Get services by owner entity id

GET

aai/v19/business/projects?<project-names>

Get services by project name

GET aai/v19/network/zones

Get all AIC zones

POST search/named-query

Get data regarding an instance and the instance’s related nodes

GET aai/v19/

business/customers/customer/<global_customer_id>/ /service-subscriptions/service-subscription/<service_type>/service-instances/service-instance/<service_instance_id>

Get AIC zones for a specific service instance

PUT aai/v19/query?format=simple(types:

“query/vnfFromModelbyRegion?cloudRegionId”,” vnf-topology-fromServiceInstance”)

This is a custom query and has multiple types(declared in the url line)

aai/v19/

service-design-and-creation/models?depth=2

Get the human readable version by version id

business/customers/customer/<global_customer_id>/service-subscriptions/service-subscription/<service_Subscription_Id>?depth=0

Get all service subscriptions

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.

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.

How to create error report

In case of error appearance a red button with “Create report” on it, will show up.

_images/VID_errorReportButton.png _images/VID_errorReportSDC.png

Pressing that button will show window with data collected from GUI and fetched from API.

_images/VID_errorReportDownloading.png

That data may be download by pressing “download” button. After closing the report window, data may not be available.

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

docker pull mariadb:10
docker login -u docker -p docker nexus3.onap.org:10001
docker pull nexus3.onap.org:10001/onap/vid:7.0.0
  1. Install by running following command (Use the path for the lf_config folder under the VID git repository as CONFIG_PATH and path for .jks files for CERTS_PATH, usually epsdk-app-onap/src/main/webapp/WEB-INF/cert )

#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 /var/lib/mysql -d mariadb:10

#start VID server
docker run -e VID_MYSQL_DBNAME=vid_openecomp_epsdk -e VID_MYSQL_PASS=YOUR_PASSWORD -v CERTS_PATH:/opt/app/vid/etc --name vid-server -p 8080:8080 --link vid-mariadb:vid-mariadb-docker-instance -d nexus3.onap.org:10001/onap/vid:7.0.0

Or use docker-compose:

docker-compose up

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

role_management_activated

Role management activation flag, “false” by defauly. Change to “true” in order to activate this feature.

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

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).
  • Populate VID Project/Owning entity/Line of Business/Platform drop downs
    VID administrator has to populate this drop downs with at least one option each. This gets done easily by a POST request. In the following example we add a “Demonstration” option to the Line of Business drop down:

    curl -X POST 'http://vid.api.simpledemo.onap.org:8080/vid/maintenance/category_parameter/lineOfBusiness' -H 'Content-Type:application/json' -d '{"options":["Demonstration"]}'

    (Replace lineOfBusiness with: platform, project, owningEntity - in order to add Demonstration to all other drop downs as well)

  • Deprecated: Set change management workflows support for a VNF
    No manual administration is needed. Available workflows are controlled in Workflow Designer (WFD).
  • VoLTE E2E services deployment support
    VID supports VoLTE E2E services deployment. In order to trigger the E2E flow, the service category in the model (as SDC generates it) has to be set to “E2E Service”.
  • Role management support
    VID supports role management for its users with AAF integration. This feature is turned off by default. In order to activate it, update “role_management_activated” value in system.properties to “true”.

Human Interfaces

User Guides

The following VID user guides are available on the ONAP Wiki:

Instantiate Service, VNF, VF modules and Network

Overview

Using VID with A-La-Carte method means that the user needs to performed by himself the instantiation of each object: service, VNF(s), VF module(s), network(s).

ONAP to VIM interactions will occurs when instantiating/deleting VF module(s) or Network(s). In case of an Openstack VIM, Heat Stack(s) will be created/deleted.

In the following description, the service model in SDC was composed of 1 VF and 1 Virtual Link (Generic Neutron Network)

Note

For doing this make sure that while Service Design drag the created VF and Generic NetronNet Virtual Link (under Generic/Network Elemntes list) from the Elements palette to the canvas then connect as mentoned in Create Service section of Service Design under Composition

To be able to instantiate VF-module or Network object, some data need to be declared in ONAP SDNC using SDNC Rest API. It is the place where to put the instance specific values such as an IP address value specific to the VNF instance for example.

In VID, terminologies are sometimes different than in other components:

VNF in VID = VF in SDC

Node instance = VF in SDC

Network = Virtual Link in SDC

Pre-requisites

Pre-instantiation operations must have been performed in AAI and VID, via Rest API, to declare some values for:

  • Subscriber Name (= customer in AAI)

  • Service Type or product family (= service subscription in AAI)

  • Project

  • Owning Entity

  • Line Of Business

  • Platform

  • LCP Region (= CloudOwner/RegionId in AAI)

  • Tenant

See, in the ONAP User Guides, section about adding a CloudSite and section about pre-instantiation Operations

Note

Robot demo script will be used to populate demo models automatically with Demonstration as Subscriber Name in VID by running “demo-k8s.sh onap init”

Access to VID portal
_images/onap-portal.png

Select the VID icon

_images/vid-icon-on-portal.png

Here after, the VID Home page starts

_images/home.png
SDNC API selection

Select the API for “A-la-carte”

There are two choices:

  • VNF_API (old) : VID will use the (old) “VNF” SDNC API to get/check some parameters

  • GR_API (new) : VID will use the “Generic Resource” SDNC API to get/check some parameters

_images/API_selection.png
Instantiate Service in “A-la-carte” mode

Click Browse SDC Service Models and search for the service to instantiate.

The view show only service models in the DISTRIBUTED state.

_images/browse-service-models.png

Select a service and click Deploy.

A dialog box displays.

Complete the fields indicated by the red star and click Confirm.

_images/create-service-instance-alacarte.png

A status box appears that shows the ONAP SO instantiation progress as well as any messages associated with the process.

_images/create-service-instance-alacarte-success.png

A Service object is created in ONAP.

Click Close and next screen should appear. It will allow to declare VNF(s) and Network(s) that are part of the service model composition.

_images/create-service-instance-alacarte-VNF-network.png
Instantiate a VNF

From previous screen, it is possible to declare a VNF: click on “Add node instance” and select the VNF you want to instantiate in the list

The following screen should appear:

_images/create-vnf-instance-alacarte.png

Complete the fields indicated by the red star and click Confirm.

A VNF object will be declared in ONAP.

Once, ONAP SO process is finished, click on close button.

The following screen then should appear:

_images/create-service-instance-alacarte-after-vnf-instantiated.png

Warning: a this step, no VNF instance (e.g. VM) is created on the Cloud Platform.

Click on “i” blue button to obtain VNF instance display information.

From this screen, it will be possible to get:

  • the service instance id value

  • the VNF Type value

Those information will be necessary for the “SDNC preload” step to instantiate the VF module

Close that screen

Instantiate VF Module

It is now possible to declare a VF Module: click on “Add VF-Module” and select the VF-module you want to instantiate in the list

The following screen should appear:

_images/create-vfmodule-instance-alacarte.png

From this screen, it will be possible to get:

  • “Model Name” value

At this step, with this “A-La-Carte” method, it is necessary to declare some information in ONAP SDNC.

SDNC needs to be aware about the VNF before trying to use ONAP SO to instantiate the VF-module.

This group of data is usually called “SDNC preload” and will contain:

  • vf-module instance Name

  • vnf instance Name

  • service instance id

  • the list of vnf parameters with values, when not using the default values

Note

Get all the required vnf-parameters values as listed in HEAT package and populate all the key-values in an example SDNC preload curl command to run

Some of the vnf-parameters in SDNC preload are related to openstack. Follow the below steps on openstack to get the values and update those values in SDNC preload template accordingly.

  • download the image from cloud images (ubuntu-14.04 as per HEAT env) and create an image

  • create the flavor with m1.medium (suggested as per HEAT env)

  • create OAM_NETWORK ID & OAM_SUBNET ID (use subnet range from base_vfw.env file)

  • execute openstack security group rule to open all ports for onap

Here is an example of SDNC preload for VNF, using “curl” tool to push those data using SDNC Rest API:

curl -k -X POST \
https://sdnc.api.simpledemo.onap.org:30267/restconf/operations/VNF-API:preload-vnf-topology-operation \
-H 'Accept: application/json' \
-H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \
-H 'Content-Type: application/json' \
-H 'X-FromAppId: API client' \
-H 'X-TransactionId: 0a3f6713-ba96-4971-a6f8-c2da85a3176e' \
-H 'cache-control: no-cache' \
-d '{
    "input": {
        "request-information": {
            "notification-url": "onap.org",
            "order-number": "1",
            "order-version": "1",
            "request-action": "PreloadVNFRequest",
            "request-id": "test"
        },
        "sdnc-request-header": {
            "svc-action": "reserve",
            "svc-notification-url": "http:\/\/onap.org:8080\/adapters\/rest\/SDNCNotify",
            "svc-request-id": "test"
        },
        "vnf-topology-information": {
            "vnf-assignments": {
                "availability-zones": [],
                "vnf-networks": [],
                "vnf-vms": []
            },
            "vnf-parameters": [
                {
                    "vnf-parameter-name": "oam_net_id",
                    "vnf-parameter-value": "oam_network_tXWW"
                }
            ],
            "vnf-topology-identifier": {
                "generic-vnf-name": "my-vnf-instance-01",
                "generic-vnf-type": "Service-model-with-VNF-and-Virtual-Link/FreeRadius_VF 0",
                "service-type": "09f9ffad-1069-43fa-97e8-da7b9a439601",
                "vnf-name": "my_vf_module-instance-01",
                "vnf-type": "FreeradiusVf..base_freeRadius..module-0"
            }
        }
    }
}'

Data mapping between ONAP SDNC terminology and ONAP SO

  • “generic-vnf-name” value must be equal to the VNF instance name value (see VNF instance detail screen)

  • “generic-vnf-type” value must be equal to VNF Type value (see VNF instance detail screen)

  • “service-type” value must be equal to the service instance id value (see VNF instance detail screen)

  • “vnf-name” value must be equal to the VF module instance name value

  • “vnf-type” value must be equal to the “Model Name” value (see create VF module screen)

If there is a need for an instance specific value of a VNF parameter (for example : an OAM network id value, specific to this VNF instance), the “vnf-parameters” must be completed with a list of name/value.

Once the “SDNC preload” is completed, send it to SDNC using any Rest API Tool.

Then, continue on VID and complete the fields indicated by the red star and click “Confirm”.

Warning : be very careful to use exactly the same VF module instance name on this screen and in the “SDNC preload”

Wait for success and close the popup screen.

The following screen should appear:

_images/create-service-instance-alacarte-after-vfmodule-instantiated.png

At that point, the VNF is now instantiated in the cloud platform.

Instantiate Network

Instantiating a network is quite similar to vf-module instantiation (there is also the need for a “SDNC preload”)

Click on “Add Network” and select the Network you want to instantiate in the list

The following screen should appear:

_images/create-network-instance-alacarte.png

Prepare the “SDNC preload” with:

  • “network-role”: provide any value,

  • “network-technology”: use “neutron” as this example will instantiate a network using openstack neutron application

  • “service-type”: value must be equal to “Service Name” (=service model name) displayed on VID screen

  • “network-name”: value must be equal to the desired network instance name,

  • “network-type”: value must be equal to “Model Name””Generic NeutronNet” displayed on VID screen

In addition:

  • in “provider-network-information” section, it is possible to indicate some network characteristics

  • it is possible to add a section about “subnets”

Here after, an “SDNC preload” example that can be use for Network instantiation.

curl -k -X POST \
https://sdnc.api.simpledemo.onap.org:30267/restconf/operations/VNF-API:preload-network-topology-operation \
-H 'Accept: application/json' \
-H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \
-H 'Content-Type: application/json' \
-H 'X-FromAppId: API client' \
-H 'X-TransactionId: 0a3f6713-ba96-4971-a6f8-c2da85a3176e' \
-H 'cache-control: no-cache' \
-d '{
"input": {
    "request-information": {
    "request-id": "postman001",
    "notification-url": "http://so.onap.org",
    "order-number": "postman001",
    "request-sub-action": "SUPP",
    "request-action": "PreloadNetworkRequest",
    "source": "postman",
    "order-version": "1.0"
    },
    "network-topology-information": {
    "network-policy": [],
    "route-table-reference": [],
    "vpn-bindings": [],
    "network-topology-identifier": {
        "network-role": "integration_test_net",
        "network-technology": "neutron",
        "service-type": "Service-model-with-VNF-and-Virtual-Link",
        "network-name": "my-network-instance-001",
        "network-type": "Generic NeutronNet"
    },
    "provider-network-information": {
        "is-external-network": "false",
        "is-provider-network": "false",
        "is-shared-network": "false"
    },
    "subnets": [
        {
        "subnet-name": "my-sub_network-instance-001",
        "subnet-role": "OAM",
        "start-address": "192.168.90.0",
        "cidr-mask": "24",
        "ip-version": "4",
        "dhcp-enabled": "Y",
        "dhcp-start-address": "",
        "dhcp-end-address": "",
        "gateway-address": "192.168.90.1",
        "host-routes":[]
        }
            ]
    },
    "sdnc-request-header": {
    "svc-action": "reserve",
    "svc-notification-url": "http://so.onap.org",
    "svc-request-id": "postman001"
    }
}
}
'

Once the “SDNC preload” is completed, send it to SDNC using any Rest API Tool.

Then, continue on VID and complete the fields indicated by the red star and click “Confirm”.

Warning : be very careful to use exactly the same network instance name on this screen and in the “SDNC preload”

Wait for success and close the popup screen.

The following screen should appear:

_images/create-network-instance-alacarte-after-instantiated.png

At that point, the Network and subnets are now instantiated in the cloud platform.

Also, all those network information are available in ONAP AAI, under the terminology “l3-network”, with the “neutron-network-id” and the “neutron-subnet-id” provided by the openstack platform.

Deleting Network, VF module, VNF, Service

To delete a service instance using VID, it is necessary to delete objects in the following sequence:

  • delete VF module(s)

  • delete VNF instance(s)

  • delete Network(s)

  • delete service instance

To proceed those deletion, from VID Home screen

  • search for existing service instance

  • edit/view the service instance you want to delete

  • click on red button with white cross and confirm for each object

Instantiate Service, “Macro” mode (PNF example)

Overview

Using VID with Macro method means that all the service model resources are deployed in a single SO API call. Macro orchestration model can be used to orchestrate service models, which contain PNFs and VNFs.

Pre-requisites

Note

To be able to orchestrate services in “Macro” mode, the VID ModernUI needs to be enabled. Review settings in VID container`s /usr/local/tomcat/webapps/vid/WEB-INF/conf/onap.features.properties file. Flags below must be set to “true”:

FLAG_ENABLE_WEBPACK_MODERN_UI = true

FLAG_EXTENDED_MACRO_PNF_CONFIG = true

Access to VID portal
Instantiate Service in “Macro” mode

A Service Model, which contains a PNF resource will be used to demonstrate the “Macro” orchestration mode.

Click “Browse SDC Service Models” and search for the service to instantiate.

The view show only service models in the DISTRIBUTED state.

_images/browse-service-models-pnf.png

Select a service and click Deploy.

Complete the mandatory fields indicated by the red star and click “Set”.

_images/new-service-instance-popup-pnf.png

Add a new object to the service instance.

Note

The blue button for adding objects to the service instance appears when you hover over the object model.

_images/service-instance-pnf.png

Complete the mandatory fields indicated by the red star and click “Set”.

Note

The PNF instance name must be unique

_images/new-pnf-instance.png

To deploy the selected configuration, click “DEPLOY” button in the top right corner.

_images/service-instance-pnf-deploy.png

If the service instance with selected objects is deployed correctly, you will be redirected to the page where you can check the instantiation status.

_images/instantiation-status.png

Note

In case of Service Models, which contain PNF resources, to complete the deployment of the service instance with PNF object, send a “pnfRegistration” event to VES. No additional actions are needed for VNFs/CNFs.

Instantiation Status

The “Instantiation Status” contains information about all deployed service instances.

To check detailed information, click the ellipsis on the right side of the selected service instance.

_images/instantiation-status-complete.png
_images/service-information.png
Deleting Service Instances previous orchestrated in “macro” model

To delete a previously created “Macro” instance using VID, the entire service instance must be deleted.

To proceed with a service instance removal, from VID Home screen:

  • search for existing service instance

  • edit/view the service instance you want to delete

  • click on red button with white cross

  • confirm deletion of the service instance

VID Release Notes

Version: Honolulu (8.0.x)

In a nutshell…

The following areas have received improvements in Honolulu Release

  • VID development (back-end for SO BB). In R6/R7 SO BB were implemented for more streamlined processing of W/F. BPMN to BB. Completed in R7. Modern UI for PNFs in VID was not rendering the models (empty UI). This is now built. Introduced VNF GUI to fit the SO BB work using SO API from R7.

    More details at: https://jira.onap.org/browse/REQ-430

  • Place-Geolocation Development for PnP completed in VID: Please see for more details https://wiki.onap.org/display/DW/Proposed+Location+Model

Security Issues

This section is empty.

Bug fixes

This section is empty.

Known Issues

VID-983: Two issues where encountered when attempting to deploy in OKD resulting in deployment failure. These issues have not been reported in OOM deployments; however, we cannot say for certain that they will not be encountered in OOM. If encountered, please note the issue and workarounds:
  • Default VID mariadb-password has special character ‘/’ in the password. Change the default password to remove special characters. Workaround: Override the ‘userPassword’ in the values.yaml file.

  • VID default user ‘onap’ doesn’t have permissions to create directory /opt/app/vid/cache. Make necessary changes in the docker file. Workaround: run the vid pod with root privileges.

  • See https://jira.onap.org/browse/VID-983 for more details.

Resolved Issues

https://jira.onap.org/browse/VID-890 https://jira.onap.org/browse/VID-902 https://jira.onap.org/browse/VID-917 https://jira.onap.org/browse/VID-922 https://jira.onap.org/browse/VID-694 https://jira.onap.org/browse/VID-921 https://jira.onap.org/browse/VID-924 https://jira.onap.org/browse/VID-925 https://jira.onap.org/browse/VID-695 https://jira.onap.org/browse/VID-927 https://jira.onap.org/browse/VID-928 https://jira.onap.org/browse/VID-903 https://jira.onap.org/browse/VID-943 https://jira.onap.org/browse/VID-944 https://jira.onap.org/browse/VID-945 https://jira.onap.org/browse/VID-970 https://jira.onap.org/browse/VID-679

Security Notes

Fixed Security Issues

This section is empty.

Known Security Issues

This section is empty.

Version: Guilin (7.0.x)

In a nutshell…

The following areas have received improvements in Guilin Release

Pause:
  • Pause/Stop on Failures.

  • Pause Point Addition on Edit window inside the drawing board.

  • Pause Point removal feature.

Audit Info:
  • Overhauling of the Audit Info screen popup.

  • MSO Status table can now be exported and viewed as .csv files (in Excel and other type software)

  • Audit Info page is also refreshable now. New status from MSO will arrive upon pressing the refresh button.
    • More detailed info fetched from MSO now in Additional Info column, most recent request to be displayed at the top.

VF Module Sequencing and Base Module Related Rules:
  • The sequence of VF Modules can now be changed by dragging up and down in the drawing board.

  • A sequence number box is introduced bearing the current position of the VF Module in the the list.

  • Various rules have been put in place for special check on the Base module in the drawing board.

Security Issues

This section is empty.

Bug fixes

This section is empty.

Known Issues

This section is empty.

Resolved Issues

Security Notes

Fixed Security Issues

This section is empty.

Known Security Issues

This section is empty.

Version: Frankfurt (6.0.x)

In a nutshell…

For an end-user VID is easier to use.

For a system admin, VID is easier to deploy and manage.

Security

  • Adherence to ONAP Logging Spec v1.2

  • Update to Portal SDK v2.6

  • Use common secret template to generate DB credentials

  • Java 11 migration from JDK 8

  • And more…

Bug fixes

  • Refresh after Add VF Module fails

  • Generates different VF module name during scale out

  • And many more…

Known Issues

This section is empty.

Resolved Issues

Security Notes

Fixed Security Issues

This section is empty.

Known Security Issues

This section is empty.

Version: El-Alto (5.0.x)

Known Issues

Resolved Issues

Security Notes

Fixed Security Issues

Known Security Issues

Version: 4.3.2

Resolved Issues

Reverted the soft-delete feature, to resolve this:
  • VID-503 Delete VF module does not trigger any action

Version: 4.3.0

Release Date

2019-05-25

New Features

  • [VID-246] - Centralized Representation and Consistent ID of Cloud Regions

  • [VID-397] - Change Management - Flexible Designer & Orchestrator: Utilize SO as a repository of workflows, instead of VID’s workflows’ configuration

Security Notes

Fixed Security Issues

Known Security Issues

  • In default deployment VID (vid) exposes HTTP port 30238 outside of cluster. [OJSI-119]

Known Vulnerabilities in Used Modules

Version: 3.2.3

Release Date

2019-03-28

Notes

It’s v3.2.2, but repackaged with a new certificate valid until March 12, 2020.

Resolved Issues

VID certificates have been renewed to extend their expiry dates

Version: 3.2.2

Release Date

2018-11-30

New Features

  1. PNF plug & play services instantiation.

  2. HTTPS support.

  3. Manual vNF Scale Out enhancements.

Epics

Stories

  • [VID-166] - Improve CSIT coverage

  • [VID-203] - PNF Plug & Play use case with vCPE flow

  • [VID-236] - Align OOM templates

  • [VID-249] - Change Manual Scaling Use Case to use the same SO API that Policy is using in Auto Scaling

  • [VID-250] - Remove Controller Type from the VID GUI and from the request sent to SO

  • [VID-256] - Add tutorials/user guides

  • [VID-257] - AAF integration

  • [VID-260] - Use HTTPS for external interfaces

  • [VID-261] - Use HTTPS for internal interfaces

Security Notes

VID code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The VID open Critical security vulnerabilities and their risk assessment have been documented as part of the project.

Quick Links:

Other

In order to work properly, VID needs a working instance of SDC, A&AI and SO.

Version: 2.0.0

Release Date

2018-06-07

New Features

  1. VoLTE E2E services instantiation.

  2. Change Management - invoking vNF In-Place SW Update without a scheduler.

  3. Manual vNF Scale Out.

Epics

  • [VID-101] - Port Mirroring

  • [VID-106] - Cancel “Pending” workflows

  • [VID-110] - Owning Entity

  • [VID-114] - Preload Automation

  • [VID-116] - Tenant Isolation

  • [VID-120] - Active/Deactivate service type transport

  • [VID-124] - Agnostic vNF In-Place SW Update

  • [VID-127] - Agnostic vNF Configuration Update

  • [VID-131] - Port mirroring - pProbe configuration

  • [VID-136] - Support for pProbes

  • [VID-139] - Refactor Scheduler

  • [VID-148] - Non-Functional requirements - Resiliency

  • [VID-154] - Non-Functional requirements - Stability

  • [VID-157] - Non-Functional requirements - Performance

  • [VID-158] - Non-Functional requirements - Usability

  • [VID-160] - Non-Functional requirements - Scalability

  • [VID-161] - Non-Functional requirements - Security (CII passing badge + 50% test coverage)

  • [VID-162] - OOM integration

  • [VID-179] - Change management - working without scheduler

  • [VID-180] - Support manual scale out

  • [VID-192] - Verify features merged from ECOMP 1802

Stories

  • [VID-16] - Replace any remaining openecomp reference by onap

  • [VID-86] - Migrate to org.onap

  • [VID-102] - Create “Port mirror” configuration - Attach Source & collector VNFs

  • [VID-103] - Create “Port mirror” configuration - General Required Fields

  • [VID-104] - Configuration supporting actions

  • [VID-105] - Create “Port mirror” configuration - Get model information

  • [VID-107] - 3rd party simulator

  • [VID-108] - Cancel Scheduled workflows

  • [VID-109] - Change information of columns in the “Pending” section of the “dashboard”

  • [VID-111] - New properties logic

  • [VID-112] - Filter service instance by new properties

  • [VID-113] - Implement new properties & their values

  • [VID-115] - Resume VF- module (after pause)

  • [VID-117] - Create Application ENV

  • [VID-118] - Deploy Services on VID operational

  • [VID-119] - Activate/Deactivate Application ENV

  • [VID-121] - Deactivate a Transport service logic

  • [VID-122] - Service Instance Deactivate - API MSO

  • [VID-123] - “Activate” avilable only for service instance from type= transport

  • [VID-125] - VNF In Place Software Update API - MSO

  • [VID-126] - Support new workflow “Agnostic vNF In-Place SW Update”

  • [VID-128] - Support workflow “vnf Config Update”

  • [VID-129] - Rules For Converting Payload Spreadsheet To JSON

  • [VID-130] - VNF Config Update - API MSO

  • [VID-132] - Get pnf-fromModel-byRegion - A&AI API

  • [VID-133] - pProbe config create request - MSO API

  • [VID-134] - Associate PNF instance to port mirroring configuration by policy

  • [VID-135] - Get Port Mirroring Configuration By Policy Node type

  • [VID-137] - Associate PNF instance to service instance

  • [VID-138] - Disassociate PNF instance from service instance

  • [VID-140] - New function to support Scheduler in widget

  • [VID-151] - ONAP Support

  • [VID-174] - Change management: bypassing scheduler for immediate operations

  • [VID-185] - UI changes for working without scheduler

  • [VID-186] - docker alignment analyzes

  • [VID-188] - UI for Scale Out workflow

  • [VID-189] - VoLTE use case support

  • [VID-191] - Changes to API to SO for Manual scale out use case

  • [VID-197] - Reach 50% unit test coverage

  • [VID-201] - User inteface for invoking upgrade workflow

  • [VID-202] - Verify R1 and R2 features - integration and regression tests

  • [VID-216] - Update ReadTheDocs docs folder

Security Notes

VID code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The VID open Critical security vulnerabilities and their risk assessment have been documented as part of the project.

Quick Links:

Other

In order to work properly, VID needs a working instance of SDC, A&AI and SO.

Version: 1.1.1

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 Instantiation - 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.

Epics

  • [VID-25] - Role management: Global Read only role

  • [VID-26] - Role management: Support VID specific Roles

  • [VID-27] - Change management: Schedule workflow

  • [VID-28] - Change management: Status of workflow

  • [VID-29] - Change management: Manual intervention

  • [VID-30] - PNF instantiation: Trigger PNF service information to SO

  • [VID-31] - PNF Instantiation: support service type PNF & display new fields

Stories

  • [VID-44] - Implement change management phase 1

  • [VID-48] - Change management: Schedule workflow

  • [VID-49] - Change management: Status of workflow

  • [VID-50] - Change management: Manual intervention

  • [VID-51] - Trigger PNF service information to MSO

  • [VID-52] - support service type PNF & display new fields

Bug Fixes

  • [VID-20] - Failed to get service models from ASDC in VID

  • [VID-59] - VID Fails Robot Health Check

  • [VID-62] - VID healthcheck failure in RS ORD ONAP 1.1.0

  • [VID-64] - Got 500 from role/user API call

  • [VID-79] - Not able to create service instance using VID portal

  • [VID-82] - Create VF module with SDNC preload is throwing exception

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