Table of Contents

Info

title	Casablanca Release

The Network Discovery microservice was first introduced in Casablanca but had no southbound integration. The Dublin release introduces the integration of Network Discovery with the Openstack API.

Overview

The Network Discovery microservice allows clients to initiate audits of get specified network resource instancesinformation. For each request received, the Network Discovery microservice micro service collects information from the network (via other microservicesi.e., OpenStack API) and returns it to the client.

Use in POMBA

The initial use case for the microservice is to provide support for the Network Discovery Context Builder, which was introduced as part of the POMBA project.

Configuration

Application Properties

Warning

title	Update

In current Network Discovery microservice development (Dublin), southbound REST API sends OpenStack API requests instead of AAI Enricher API requestsThe openstack.xxx properties must be adjusted to match your own OpenStack environment.

Code Block

language	bash
title	Application Properties
collapse	true

spring.jersey.type=filter
spring.mvc.urls=swagger,docs,prometheus,auditevents,info,heapdump,autoconfig,beans,loggers,dump,env,trace,health,configprops,mappings,metrics,webjars


server.contextPath=/network-discovery
spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration

#This property is used to set the Tomcat connector attributes.developers can define multiple attributes separated by comma
#tomcat.connector.attributes=allowTrace-true
#The max number of active threads in this pool
server.tomcat.max-threads=200
#The minimum number of threads always kept alive
server.tomcat.min-Spare-Threads=25
#The number of milliseconds before an idle thread shutsdown, unless the number of active threads are less or equal to minSpareThreads
server.tomcat.max-idle-time=60000

#Servlet context parameters
server.context_parameters.p-name=value #context parameter with p-name as key and value as value.

#Enable HTTPS
server.port=8443
server.ssl.key-store=config/auth/client-cert-onap.p12
server.ssl.key-store-password=password(OBF:1y0q1uvc1uum1uvg1pil1pjl1uuq1uvk1uuu1y10)
server.ssl.keyStoreType=JKS
server.ssl.keyAlias=tomcat
server.ssl.client-auth=want
server.ssl.enabled=true
server.ssl.enabled-protocols=TLSv1.1,TLSv1.2

# Basic Authentication
basicAuth.username=admin
basicAuth.password=OBF:1u2a1toa1w8v1tok1u30

openstack.identity.url = http://10.69.36.11:5000/v3/auth/tokens
openstack.identity.user = ralph
openstack.identity.password = OBF:1w951ugg1vun1uha1w8l

openstack.types = vserver, l3-network
openstack.type.vserver.url    = http://10.69.36.11:8774/v2.1/servers/{0}
openstack.type.l3-network.url = http://10.69.36.11:9696/v2.0/networks/{0}

openstack.api.microversion = 2.42

Interfaces/API

URI example

Code Block

title	Network Discovery Micro Service URI example

https://10.69.102.6:30299/network-discovery/v1/network/resource?requestId=88001&resourceType=vserver&resourceId=645a12dc-09b5-45cb-8ab1-a0ce41b7200a

Response example

Code Block

language	xml
title	Network Discovery Micro Service response
collapse	true

{
    "requestId": "88001",
    "code": 200,
    "message": "OK",
    "ackFinalIndicator": true,
    "resources": [

#Enable HTTPS
server.port=8443
server.ssl.key-store=config/auth/client-cert-onap.p12
server.ssl.key-store-password=password(OBF:1y0q1uvc1uum1uvg1pil1pjl1uuq1uvk1uuu1y10)
server.ssl.keyStoreType=JKS
server.ssl.keyAlias=tomcat
server.ssl.client-auth=want
server.ssl.enabled=true
server.ssl.enabled-protocols=TLSv1.1,TLSv1.2

# Basic Authentication
basicAuth.username=admin
basicAuth.password=OBF:1u2a1toa1w8v1tok1u30

openstack.identity.url = http://10.69.36.11:5000/v3/auth/tokens
openstack.identity.user = ralph
openstack.identity.password = OBF:1w951ugg1vun1uha1w8l

openstack.types = vserver, l3-network, port
openstack.type.vserver.url    = http://10.69.100.11:8774/v2.1/servers/{0}
openstack.type.l3-network.url = http://10.69.100.11:9696/v2.0/networks/{0}
openstack.type.port.url = http://10.69.100.11:9696/v2.0/ports/{0}

openstack.api.microversion = 2.42

Swagger API documentation

The swagger UI is available at https://<host>:<port>/swagger/index.html

Info

title	Example URL/port for OOM deployments

https://10.69.102.6:30299/swagger/index.html

Alternatively, copy and paste the following swagger.json into https://editor.swagger.io/ to browse the API documentation offline:

Code Block

title	swagger.json
collapse	true

{
  "swagger" : "2.0",
  "info" : {
    "version" : "1.4.1-SNAPSHOT",
    "title" : "Network Discovery API",
    "termsOfService" : "http://onap.org"
  },
  "basePath" : "/network-discovery",
  "tags" : [ {
    "name" : "resource"
  } ],
  "paths" : {
    "/{version}/network/resource" : {
      "get" : {
        "tags" : [ "resource" ],
        "summary" : "Get Network Information",
        "description" : "Retrieve information from primary data sources",
        "operationId" : "findbyResourceIdAndType",
        {"consumes" : [ "application/json" ],
        "idproduces" : "645a12dc-09b5-45cb-8ab1-a0ce41b7200a"[ "application/json" ],
            "nameparameters" : null,[  {
          "typename" : "vserverversion",
            "dataQualityin" : {
"path",
               "statusrequired" : "ok"true,
                "errorText": null"type" : "string",
          "default" :  }"v1",
          "pattern" : "attributeListv1":,
[          "enum" : [ "v1" ]
  {      }, {
             "name" : "idX-ONAP-PartnerName",
          "in" : "header",
          "valuerequired" : "645a12dc-09b5-45cb-8ab1-a0ce41b7200a"true,
          "type" : "string"
       "dataQuality": }, {
          "name" : "X-ONAP-RequestID",
           "statusin" : "okheader",
          "required" : false,
           "errorTexttype" : null"string"
        }, {
          }"name" : "requestId",
          "in"    }: "query",
          "required" : true,
   {       "type" : "string"
        }, {
 "name": "name",        "name" : "resourceType",
          "valuein" : "norm-d2-k8squery",
          "required" : true,
          "dataQualitytype" : {"string"
             }, {
          "statusname" : "okresourceId",
          "in" :  "query",
          "errorTextrequired" : nulltrue,
          "type" : "array",
       }   "items" : {
           }, "type" : "string"
          },
  {        "collectionFormat" : "multi"
        } ],
"name": "inMaintenance",       "responses" : {
           "value200" : "false",{
            "description" : "Request has completed.",
   "dataQuality": {        "schema" : {
              "status$ref" : "ok#/definitions/NetworkDiscoveryNotification",
            }
          },
"errorText": null         "400" : {
         }   "description" : "Missing mandatory field in the request or HTTP header."
   },       },
         { "401" :  {
                "namedescription" : "imageId",Missing basicAuth header."
          },
         "value": "87e000f6-9a81-4841-b446-5d6751c42c48",
     404" : {
              "dataQualitydescription" : {"Requested resource was not found."
          },
         "status": "ok500", : {
            "description" : "Request failed due to internal error"
  "errorText": null       }
        },
    }    "security" : [ {
         }, "basicAuth" : [ ]
        } ]
  {    }
    }
  },
  "securityDefinitions" : {
   "name": "statusbasicAuth", : {
      "type" : "basic"
    }
  },
 "value": "ACTIVEdefinitions", : {
    "Attribute" : {
      "type" : "object",
      "dataQualityproperties" : {
        "name" :  {
            "statustype" : "okstring",
        },
               "errorText""value" : null{
          "type" : "string"
        },
        "dataQuality" : {
     },     "$ref" : "#/definitions/DataQuality"
        }
{      }
    },
    "DataQuality" : {
      "nametype" : "vmStateobject",
      "properties" : {
        "status" : {
          "valuetype" : "activestring",
          "enum" : [ "ok", "error" ]
    "dataQuality": {   },
        "errorText" : {
          "statustype" : "okstring",
        }
      }
    },
    "errorTextNetworkDiscoveryNotification" : null{
      "type" : "object",
      "properties" : {
  }      "requestId" : {
        },  "type" : "string"
        },
   {     "code" :    {
          "nametype" : "tenantIdinteger",
                    "value""format" : "1130b349e19c4827bf91a29d51256af1int32",
         },
          "dataQualitymessage" : {
          "type" : "string"
           "status": "ok"},
        "ackFinalIndicator" : {
          "type" :  "errorTextboolean":
null        },
        "resources" : {
 }         "type" : "array",
     },     "items" : {
         {   "$ref" : "#/definitions/Resource"
          }
    "name": "hostId",   }
      }
    },
     "valueResource" : "28ae48d6cb907e3d019535563716cfb7ec1f2cecc951439330ed9759",{
      "type"       : "object",
      "dataQualityproperties" : {
        "id" : {
             "statustype" : "okstring",
        },
               "errorText""name" : null{
          "type" : "string"
        },
        "type" : {
     },     "type" : "string"
        },
{        "dataQuality" : {
          "name$ref" : "hostStatus#/definitions/DataQuality",
         },
          "valueattributeList" : "UNKNOWN",{
                    "dataQuality": {"type" : "array",
          "items" : {
            "status$ref" : "ok#/definitions/Attribute",
          }
        }
    "errorText": null }
                   }
         
      }
            ]
        }
    ]
}

}

Examples

Query Openstack server

Code Block

title	Network Discovery Micro Service URI example

https://10.69.102.6:30299/network-discovery/v1/network/resource?requestId=88001&resourceType=vserver&resourceId=645a12dc-09b5-45cb-8ab1-a0ce41b7200a

Response example

Code Block

language	xml
title	Network Discovery Micro Service response
collapse	true

{
    "requestId": "88001",
    "code": 200,
    "message": "OK",
    "ackFinalIndicator": true,
    "resources": [
        {
            "id": "645a12dc-09b5-45cb-8ab1-a0ce41b7200a",
            "name": "norm-d2-k8s",
            "type": "vserver",
            "dataQuality": {
                "status": "ok",
                "errorText": null
            },
            "attributeList": [
                {
                    "name": "inMaintenance",
                    "value": "false",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "hostname",
                    "value": "norm-d2-k8s",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "status",
                    "value": "ACTIVE",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "vmState",
                    "value": "active",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "userId",
                    "value": "0aae369d1c874bb7827f61ca4f11edae",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "tenantId",
                    "value": "1130b349e19c4827bf91a29d51256af1",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "hostId",
                    "value": "28ae48d6cb907e3d019535563716cfb7ec1f2cecc951439330ed9759",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "host",
                    "value": "Setup-D2-OTT-A-Master",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "hostStatus",
                    "value": "UP",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                }
            ]
        }
    ]
}

Query Openstack network

Code Block

title	Network Discovery Micro Service URI example

https://10.69.102.6:30299/network-discovery/v1/network/resource?requestId=88001&resourceType=l3-network&resourceId=01e8d84a-17a6-47b5-a167-6a45d1d56603

Response example:

Code Block

language	xml
title	Network Discovery Micro Service response
collapse	true

{
    "requestId": "88001",
    "code": 200,
    "message": "OK",
    "ackFinalIndicator": true,
    "resources": [
        {
            "id": "01e8d84a-17a6-47b5-a167-6a45d1d56603",
            "name": "NET_1106",
            "type": "l3-network",
            "dataQuality": {
                "status": "ok",
                "errorText": null
            },
            "attributeList": [
                {
                    "name": "adminStateUp",
                    "value": "true",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "sharedNetwork",
                    "value": "true",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "status",
                    "value": "ACTIVE",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "subnets",
                    "value": "089c9160-6f7a-4ae0-83b7-33536b4c6672",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "tenantId",
                    "value": "cbd5e07f58d84ea6b795aa9f5f207df0",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                }
            ]
        }
    ]
}

Query Openstack port

Code Block

title	Network Discovery Micro Service URI example

https://10.69.102.6:30299/network-discovery/v1/network/resource?requestId=88001&resourceType=port&resourceId=bcd87883-c92f-4f2b-b5bf-1288948facdd

Response example:

Code Block

language	xml
title	Network Discovery Micro Service response
collapse	true

{
    "requestId": "88001",
    "code": 200,
    "message": "OK",
    "ackFinalIndicator": true,
    "resources": [
        {
            "id": "bcd87883-c92f-4f2b-b5bf-1288948facdd",
            "name": "bcd8",
            "type": "port",
            "dataQuality": {
                "status": "ok",
                "errorText": null
            },
            "attributeList": [
                {
                    "name": "adminStateUp",
                    "value": "true",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "description",
                    "value": "Port description",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                },
                {
                    "name": "macAddress",
                    "value": "fa:16:3e:ff:f7:af",
                    "dataQuality": {
                        "status": "ok",
                        "errorText": null
                    }
                }
            ]
        }
    ]
}

Model Mapping of Openstack attributes

VM (resourceType=vserver, Openstack type = server)

Openstack Attribute	Optional/Mandatory	Name on Network Discovery API	Note
	Mandatory	"type": "vserver"
Id	Mandatory	id
name	Mandatory	name
locked	Mandatory	attributeList[name=inMaintenance]
OS-EXT-SRV-ATTR:hostname	Mandatory	attributeList[name=hostname]	Requires admin-level Openstack API user
image.id	Mandatory	attributeList[name=imageId]
status	Optional	attributeList[name=status]
OS-EXT-STS:vm_state	Optional	attributeList[name=vmState]
user-id	Optional	attributeList[name=userId]
tenant_id	Optional	attributeList[name=tenantId]
hostId	Optional	attributeList[name=hostId]
OS-EXT-SRV-ATTR:host	Optional	attributeList[name=host]	Requires admin-level Openstack API user
host_status	Optional	attributeList[name=hostStatus]	Requires admin-level Openstack API user

Network (resourceType=l3-network, Openstack type = network)

Openstack Attribute	Optional/Mandatory	Name on Network Discovery API	Note
	Mandatory	"type": "l3-network"
Id	Mandatory	id
name	Mandatory	name
admin_state_up	Mandatory	attributeList[name=adminStateUp]
shared	Mandatory	attributeList[name=sharedNetwork]
status	Optional	attributeList[name=status]
subnets	Optional	attributeList[name=subnets]
tenant_id	Optional	attributeList[name=tenantId]

Port (resourceType=port, Openstack type = port)

Openstack Attribute	Optional/Mandatory	Name on Network Discovery API	Note
	Mandatory	"type": "port"
Id	Mandatory	id
name	Mandatory	name
admin_state_up	Mandatory	attributeList[name=adminStateUp]
mac_address	Mandatory	attributeList[name=macAddress]
description	Mandatory	attributeList[name=description]

Versions Compared

Old Version 1

New Version Current

Key

Overview

Use in POMBA

Configuration

Interfaces/API

Swagger API documentation

Examples

Query Openstack server

Query Openstack network

Query Openstack port

Model Mapping of Openstack attributes

VM (resourceType=vserver, Openstack type = server)

Network (resourceType=l3-network, Openstack type = network)

Port (resourceType=port, Openstack type = port)

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Overview

Use in POMBA

Configuration

Interfaces/API

Swagger API documentation

Examples

Query Openstack server

Query Openstack network

Query Openstack port

Model Mapping of Openstack attributes

VM (resourceType=vserver, Openstack type = server)

Network (resourceType=l3-network, Openstack type = network)

Port (resourceType=port, Openstack type = port)