You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »


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 get specified network resource information. For each request received, the Network Discovery micro service collects information from the network (i.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

Update

The openstack.xxx properties must be adjusted to match your own OpenStack environment.

Application Properties 
spring.jersey.type=filter

#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

Swagger API documentation


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

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:

swagger.json 
{
  "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" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "version",
          "in" : "path",
          "required" : true,
          "type" : "string",
          "default" : "v1",
          "pattern" : "v1",
          "enum" : [ "v1" ]
        }, {
          "name" : "X-ONAP-PartnerName",
          "in" : "header",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "X-ONAP-RequestID",
          "in" : "header",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "requestId",
          "in" : "query",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "resourceType",
          "in" : "query",
          "required" : true,
          "type" : "string"
        }, {
          "name" : "resourceId",
          "in" : "query",
          "required" : true,
          "type" : "array",
          "items" : {
            "type" : "string"
          },
          "collectionFormat" : "multi"
        } ],
        "responses" : {
          "200" : {
            "description" : "Request has completed.",
            "schema" : {
              "$ref" : "#/definitions/NetworkDiscoveryNotification"
            }
          },
          "400" : {
            "description" : "Missing mandatory field in the request or HTTP header."
          },
          "401" : {
            "description" : "Missing basicAuth header."
          },
          "404" : {
            "description" : "Requested resource was not found."
          },
          "500" : {
            "description" : "Request failed due to internal error"
          }
        },
        "security" : [ {
          "basicAuth" : [ ]
        } ]
      }
    }
  },
  "securityDefinitions" : {
    "basicAuth" : {
      "type" : "basic"
    }
  },
  "definitions" : {
    "Attribute" : {
      "type" : "object",
      "properties" : {
        "name" : {
          "type" : "string"
        },
        "value" : {
          "type" : "string"
        },
        "dataQuality" : {
          "$ref" : "#/definitions/DataQuality"
        }
      }
    },
    "DataQuality" : {
      "type" : "object",
      "properties" : {
        "status" : {
          "type" : "string",
          "enum" : [ "ok", "error" ]
        },
        "errorText" : {
          "type" : "string"
        }
      }
    },
    "NetworkDiscoveryNotification" : {
      "type" : "object",
      "properties" : {
        "requestId" : {
          "type" : "string"
        },
        "code" : {
          "type" : "integer",
          "format" : "int32"
        },
        "message" : {
          "type" : "string"
        },
        "ackFinalIndicator" : {
          "type" : "boolean"
        },
        "resources" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/Resource"
          }
        }
      }
    },
    "Resource" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "name" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string"
        },
        "dataQuality" : {
          "$ref" : "#/definitions/DataQuality"
        },
        "attributeList" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/Attribute"
          }
        }
      }
    }
  }
}


Examples


URI example

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

Network Discovery Micro Service response 
{
    "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
                    }
                }
            ]
        }
    ]
}

Model Mapping of Openstack attributes

VM (resourceType=vserver, Openstack type = server)


Openstack AttributeOptional/Mandatory

Name on Network Discovery API

Note

Mandatory"type": "vserver"
IdMandatoryid
nameMandatoryname
lockedMandatoryattributeList[name=inMaintenance]
OS-EXT-SRV-ATTR:hostnameMandatoryattributeList[name=hostname]Requires admin-level Openstack API user
image.idMandatoryattributeList[name=imageId]
statusOptionalattributeList[name=status]
OS-EXT-STS:vm_state OptionalattributeList[name=vmState]
user-idOptionalattributeList[name=userId]
tenant_idOptionalattributeList[name=tenantId]
hostIdOptionalattributeList[name=hostId]
OS-EXT-SRV-ATTR:hostOptionalattributeList[name=host]Requires admin-level Openstack API user
host_statusOptionalattributeList[name=hostStatus]Requires admin-level Openstack API user


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

Openstack AttributeOptional/MandatoryName on Network Discovery APINote

Mandatory"type": "l3-network"
IdMandatoryid
nameMandatoryname
admin_state_upMandatoryattributeList[name=adminState]
sharedMandatoryattributeList[name=sharedNetwork]
statusOptionalattributeList[name=status]
subnetsOptionalattributeList[name=subnets]
tenant_idOptionalattributeList[name=tenantId]
  • No labels