Page Comparison

Analysis

vFirewall Demo Sequence of Events

All the events during a VF creation so we can understand all the

Purpose: prototype a REST client on top of ONAP - specifically for VF-Module orchestration.

Image Added

Analysis

vFirewall Demo Sequence of Events

All the events during a VF creation so we can understand all the orchestration steps at a granular REST level.

...

PUT aai/v8/service-design-and-creation/services

PUT aai/v8/service-design-and-creation/services

{   "service-id": "${UUID}",
   "service-description": "${service_type}"}

...

07/27/17 12:10:39 HTTP Status: OK (200)
{
  "request": {
    "requestId": "96dcaa23-88cb-41ac-bf8c-e1e5bb423232",
    "startTime": "Wed, 26 Jul 2017 16:10:26 GMT",
    "requestScope": "service",
    "requestType": "createInstance",
    "requestDetails": {
      "modelInfo": {
        "modelCustomizationName": null,
        "modelInvariantId": "43d59b70-8829-4a50-a3f7-d261b220ceef",
        "modelType": "service",
        "modelNameVersionId": "dcb40136-9cec-45be-b080-2a36b31c2f06",
        "modelName": "vfservice",
        "modelVersion": "1.0"
      },
      "requestInfo": {
        "billingAccountNumber": null,
        "callbackUrl": null,
        "correlator": null,
        "orderNumber": null,
        "productFamilyId": null,
        "orderVersion": null,
        "source": "VID",
        "instanceName": "DemoInstance",
        "suppressRollback": false
      },
      "relatedInstanceList": null,
      "subscriberInfo": {
        "globalSubscriberId": "Demonstration",
        "subscriberName": null
      },
      "cloudConfiguration": null,
      "requestParameters": {
        "subscriptionServiceType": "vFW",
        "userParams": []
      }
    },
    "instanceReferences": {
      "serviceInstanceId": "cd2eb659-2463-461b-9c3b-3bf03619c167",
      "serviceInstanceName": "DemoInstance",
      "vnfInstanceId": null,
      "vnfInstanceName": null,
      "vfModuleInstanceId": null,
      "vfModuleInstanceName": null,
      "volumeGroupInstanceId": null,
      "volumeGroupInstanceName": null,
      "networkInstanceId": null,
      "networkInstanceName": null
    },
    "requestStatus": {
      "requestState": "COMPLETE",
      "statusMessage": "Service Instance has been created successfully.",
      "percentProgress": 100,
      "finishTime": "Wed, 26 Jul 2017 16:10:31 GMT"
    }
  }
}

07/27/17 12:10:28 HTTP Status: Accepted (202)
{
  "requestReferences": {
    "instanceId": "cd2eb659-2463-461b-9c3b-3bf03619c167",
    "requestId": "96dcaa23-88cb-41ac-bf8c-e1e5bb423232"
  }
}

...

VNF Creation

07/27/17 12:15:13 HTTP Status: OK (200)
{
  "request": {
    "requestId": "e867be64-e725-4e29-8448-c9eceb51ce3c",
    "startTime": "Wed, 26 Jul 2017 16:15:02 GMT",
    "requestScope": "vnf",
    "requestType": "createInstance",
    "requestDetails": {
      "modelInfo": {
        "modelCustomizationName": "vsp 1",
        "modelInvariantId": "27036887-1053-48e8-a55e-3d2a7264a658",
        "modelType": "vnf",
        "modelNameVersionId": "b63a0b42-a151-460a-9bb2-ba469948622b",
        "modelName": "vsp",
        "modelVersion": "1.0"
      },
      "requestInfo": {
        "billingAccountNumber": null,
        "callbackUrl": null,
        "correlator": null,
        "orderNumber": null,
        "productFamilyId": "03606d31-c2f3-483e-9882-6d050ab3610f",
        "orderVersion": null,
        "source": "VID",
        "instanceName": "DemoVNF",
        "suppressRollback": false
      },
      "relatedInstanceList": [
        {
          "relatedInstance": {
            "instanceName": null,
            "instanceId": "cd2eb659-2463-461b-9c3b-3bf03619c167",
            "modelInfo": {
              "modelCustomizationName": null,
              "modelInvariantId": "43d59b70-8829-4a50-a3f7-d261b220ceef",
              "modelType": "service",
              "modelNameVersionId": "dcb40136-9cec-45be-b080-2a36b31c2f06",
              "modelName": "vfservice",
              "modelVersion": "1.0"
            }
          }
        }
      ],
      "subscriberInfo": null,
      "cloudConfiguration": {
        "aicNodeClli": null,
        "tenantId": "1035021your_tenant_id",
        "lcpCloudRegionId": "DFW"
      },
      "requestParameters": {
        "subscriptionServiceType": null,
        "userParams": []
      }
    },
    "instanceReferences": {
      "serviceInstanceId": "cd2eb659-2463-461b-9c3b-3bf03619c167",
      "serviceInstanceName": null,
      "vnfInstanceId": "110f0e9c-52f9-4b12-8bd8-fa2980e48454",
      "vnfInstanceName": "DemoVNF",
      "vfModuleInstanceId": null,
      "vfModuleInstanceName": null,
      "volumeGroupInstanceId": null,
      "volumeGroupInstanceName": null,
      "networkInstanceId": null,
      "networkInstanceName": null
    },
    "requestStatus": {
      "requestState": "COMPLETE",
      "statusMessage": "Vnf has been created successfully.",
      "percentProgress": 100,
      "finishTime": "Wed, 26 Jul 2017 16:15:03 GMT"
    }
  }
}

07/27/17 12:15:02 HTTP Status: Accepted (202)
{
  "requestReferences": {
    "instanceId": "110f0e9c-52f9-4b12-8bd8-fa2980e48454",
    "requestId": "e867be64-e725-4e29-8448-c9eceb51ce3c"
  }
}

VfModule Preload

VfModule Creation

Closed Loop

Closed Loop

API History

http://{{mso_ip}}:8080/ecomp/mso/infra/orchestrationRequests/v2/?filter=serviceInstanceId%3AEQUALS%3Ac54316d8-464e-4967-bece-8c2b2f458b66

http://{{mso_ip}}:8080/ecomp/mso/infra/orchestrationRequests/v2/?filter=vnfInstanceId%3AEQUALS%3A6229cdee-10f6-4ec4-a5e0-0593154e6d83

http://{{mso_ip}}:8080/ecomp/mso/infra/orchestrationRequests/v2/?filter=vfModuleInstanceId%3AEQUALS%3A5a08199b-4161-4181-9b2d-da29f6df1410

see also

http://{{sdc_ip}}:8080/sdc2/rest/v1/catalog/services/latestversion/notabstract/uidonly?internalComponentType=SERVICE

feeds

http://{{sdc_ip}}:8080/sdc2/rest/v1/catalog/services/378bc9b7-2b7d-4a4f-96d9-1c654c2242fa

Design Issues

DI 1: 20170712: AAI Cert required for HTTPS REST calls

Use postman for adhoc rest calls - but if you want to code up call chains or hammer an endpoint use Spring RestController or the Rest client in JAX-RS 2.0

Calls to AAI such as the following require both the authentication header and an imported certificate.  When running Postman - because it is a Chrome app - this is a simple case of loading a REST url in the browser and importing the certificate after an authentication challenge (AAI:AAI).  However for a java client like a JAX-RS 2.0 client we need the certificate in a keystore (the default or a specially defined one).

Below we import the cert into the default keystore.  Where did I get the cert? by extracting it from Firefox - however it is in the code base - looking it up

...

obrienbiometrics:onap michaelobrien$ ls $JAVA_HOME/jre/lib/security/cacerts

/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib/security/cacerts

sudo keytool -import -trustcacerts -alias aai -file /Users/michaelobrien/Dropbox/_amdocs/config/certs/aai/aaiapisimpledemoopenecomporg.cer -keystore $JAVA_HOME/jre/lib/security/cacerts

Running an https rest target using this certificate - if the cert is in a default keystore - you dont need to define it.

...

// require: cert, username, password, headers(X-FromAppId,Accept), Authenticator

public String run(boolean isSSL, String url, String port, String path) {

  String record = null;
  Client client = null;
  WebTarget latestTarget = null;
  WebTarget rootTarget = null;
  if(isSSL) {
    SslConfigurator sslConfig = SslConfigurator.newInstance();
    SSLContext sslContext = sslConfig.createSSLContext();
    HostnameVerifier verifier = new HostnameVerifier() {
    public boolean verify(String hostname, SSLSession sslSession) {
      return true; // TODO: security breach
    }};
    client = ClientBuilder.newBuilder().sslContext(sslContext).hostnameVerifier(verifier).build();
    client.register(new Authenticator("AAI","AAI"));
  } else {

      client = ClientBuilder.newClient();
    }
    rootTarget = client.target(url);
    latestTarget = rootTarget.path(path);
    try {
      try { Thread.sleep(1); } catch (InterruptedException ie) { Thread.currentThread().interrupt(); }
        record = finalTarget.request()
          .header("X-FromAppId", "AAI").header("Accept", "application/json")
          .get(String.class);

...

DI 2: 20170712: Spring Boot Backend Framework

Instead of using a full Tomcat deployment server - we will use an embedded Jetty container.

...

pom.xml 

  <parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>1.5.3.RELEASE</version></parent>

    <dependencies>
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency>       

        <!-- avoid restarts --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><optional>true</optional></dependency>

        <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId></dependency>
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency>
    </dependencies>

    <build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId>
                <!-- may not be required --><configuration><addResources>true</addResources> </configuration></plugin></plugins></build>

DI 3: 20170712: JAX-RS 2.0 API Framework

DI 4: 20170712: 3D Framework: Three js OpenGL 3D wrapper on Canvas

Di 5: 20170712: Javascript Timer Framework

DI 6: 20170712: Three js Listener

DI 7: 20170712: Three js Edges between Nodes

DI 8: 20170712: Three js Click Context

DI 9: 20170712: AJAX JAX-RS Channel

DI 10: 20170712: WebSocket Channel

DI 11: 20170712: React.js Framework

DI 12: 20170712: Three js Text

DI 13: 20170721: Demo Robot REST extraction

Reverse engineer the orchestration rest calls coming out of demo.sh

/testsuite/properties/demo.sh not /testsuite/docker/demo.sh

/testsuite/runtags.sh

/testsuite/resources/demo_preload.robot "Load Customer And Models"

"Create Customer For VNF Demo"

create_customer.robot (aai put /aai/v8//business/customers/customer/)

create_service.robot (aai put /aai/v8/service-design-and-creation/services

"Load Models" | Distribute Model | Model Distribution For Directory in model_test_template.robot | Distribute Model From ASDC in addc_interface.robot

(Add ASDC Catalog Service, Setup ASDC Catalog Resource, Get ASDC Catalog Resource, 

Add ASDC Resource Instance, Get ASDC Catalog Service, Checkin ASDC Catalog Service,

Request Certify ASDC Catalog Service, Start Certify ASDC Catalog Service, Certify ASDC Catalog Service, Approve ASDC Catalog Service, 

Distribute ASDC Catalog Service, Get ASDC Catalog Service, Check Catalog Service Distributed)

Preload VNF:demo.robot (

  Preload User Model:demo_preload.robot (

    Get Service Instance

    Get Relationship Data

    Get Persona Model Id

    Login To VID GUI

    Get Module Names from VID

    Preload Vnf:sdngc_interface.robot(

      Update Module Name

      Preload Vnf Profile(

        Login To SDNGC Admin GUI

goto sdnc:8843/mobility/getVnfProfile

        click add_vnf_profile

inserts directly to the DB from the client (for now)

/sdnc-oam/admportal/mobility.js

router.post('/addVnfNetwork', csp.checkAuth, function(req,res){
 var sql = "INSERT INTO VNF_NETWORKS (vnf_type,network_role) VALUES ("
 + "'" + req.body.nf_vnf_type + "'," + "'" + req.body.nf_network_role + "')";
 tasks.push( function(callback) { dbRoutes.executeSQL(sql,req,res,callback); } );

)

      Preload One Vnf Topology

)))

...

API History

http://{{mso_ip}}:8080/ecomp/mso/infra/orchestrationRequests/v2/?filter=serviceInstanceId%3AEQUALS%3Ac54316d8-464e-4967-bece-8c2b2f458b66

http://{{mso_ip}}:8080/ecomp/mso/infra/orchestrationRequests/v2/?filter=vnfInstanceId%3AEQUALS%3A6229cdee-10f6-4ec4-a5e0-0593154e6d83

http://{{mso_ip}}:8080/ecomp/mso/infra/orchestrationRequests/v2/?filter=vfModuleInstanceId%3AEQUALS%3A5a08199b-4161-4181-9b2d-da29f6df1410

see also

http://{{sdc_ip}}:8080/sdc2/rest/v1/catalog/services/latestversion/notabstract/uidonly?internalComponentType=SERVICE

feeds

http://{{sdc_ip}}:8080/sdc2/rest/v1/catalog/services/378bc9b7-2b7d-4a4f-96d9-1c654c2242fa

Design Issues

DI 1: 20170712: AAI Cert required for HTTPS REST calls

Use postman for adhoc rest calls - but if you want to code up call chains or hammer an endpoint use Spring RestController or the Rest client in JAX-RS 2.0

Calls to AAI such as the following require both the authentication header and an imported certificate.  When running Postman - because it is a Chrome app - this is a simple case of loading a REST url in the browser and importing the certificate after an authentication challenge (AAI:AAI).  However for a java client like a JAX-RS 2.0 client we need the certificate in a keystore (the default or a specially defined one).

Below we import the cert into the default keystore.  Where did I get the cert? by extracting it from Firefox - however it is in the code base - looking it up

CURL commands need the certificate - see Verifying your ONAP Deployment#Postman/CurlRESTcalls

Note: we will need to replace the AAI Certificate before 1 Dec 2017 - 

"AAI_KEYSTORE_PASSWD_X": "OBF:1vn21ugu1saj1v9i1v941sar1ugw1vo0"

Installing the AAI certificate in your own keystore on the Robot VM

Running an https rest target using this certificate - if the cert is in a default keystore - you dont need to define it - otherwise set your own trust/keystore as below.

// require: cert, username, password, headers(X-FromAppId,Accept), Authenticator

public String run(boolean isSSL, String url, String port, String path) {

  String record = null;
  Client client = null;
  WebTarget latestTarget = null;
  WebTarget rootTarget = null;
  if(isSSL) {
    // Use only for default JDK keystore

    // SslConfigurator sslConfig = SslConfigurator.newInstance();

    SSLContext sslContext = sslConfig.createSSLContext();
    HostnameVerifier verifier = new HostnameVerifier() {
    public boolean verify(String hostname, SSLSession sslSession) {
      return true; // TODO: security breach
    }};
    client = ClientBuilder.newBuilder().sslContext(sslContext).hostnameVerifier(verifier).build();
    client.register(new Authenticator("AAI","AAI"));
  } else {

      client = ClientBuilder.newClient();
    }
    rootTarget = client.target(url);
    latestTarget = rootTarget.path(path);
    try {
      try { Thread.sleep(1); } catch (InterruptedException ie) { Thread.currentThread().interrupt(); }
        record = finalTarget.request()
          .header("X-FromAppId", "AAI").header("Accept", "application/json")
          .get(String.class);

public class Authenticator implements ClientRequestFilter {
 private final String user;
 private final String pass;

 public Authenticator(String user, String password) {
      this.user = user; this.pass = password;
 }

 public void filter(ClientRequestContext requestContext) throws IOException {
   MultivaluedMap<String, Object> headMap = requestContext.getHeaders();
 String basicAuth = null;
 try {
         String aToken = user + ":" + pass;
 basicAuth = "BASIC " + DatatypeConverter.printBase64Binary(aToken.getBytes("UTF-8"));
 } catch (UnsupportedEncodingException uee) { throw new IllegalStateException("Encoding with UTF-8 failed", uee);}
   headMap.add("Authorization", basicAuth);
 }
}

Creating a custom keystore on the robot VM

DI 2: 20170712: Spring Boot Backend Framework

Instead of using a full Tomcat deployment server - we will use an embedded Jetty container.

DI 3: 20170712: JAX-RS 2.0 API Framework

DI 4: 20170712: 3D Framework: Three js OpenGL 3D wrapper on Canvas

changing state

Di 5: 20170712: Javascript Timer Framework

DI 6: 20170712: Three js Listener

DI 7: 20170712: Three js Edges between Nodes

DI 8: 20170712: Three js Click Context

DI 9: 20170712: AJAX JAX-RS Channel

Example: getCustomer() from AAI

AJAX client

JAX-RS NBI

JAX-RS SBI

DI 10: 20170712: WebSocket Channel

DI 11: 20170712: React.js Framework

DI 12: 20170712: Three js Text

DI 13: 20170721: Demo Robot REST extraction

Reverse engineer the orchestration rest calls coming out of demo.sh

/testsuite/resources/demo_preload.robot "Load Customer And Models"

"Create Customer For VNF Demo"

(Add ASDC Catalog Service, Setup ASDC Catalog Resource, Get ASDC Catalog Resource, 

Add ASDC Resource Instance, Get ASDC Catalog Service, Checkin ASDC Catalog Service,

Request Certify ASDC Catalog Service, Start Certify ASDC Catalog Service, Certify ASDC Catalog Service, Approve ASDC Catalog Service, 

Distribute ASDC Catalog Service, Get ASDC Catalog Service, Check Catalog Service Distributed)

Preload VNF:demo.robot (

  Preload User Model:demo_preload.robot (

    Get Service Instance

    Get Relationship Data

    Get Persona Model Id

    Login To VID GUI

    Get Module Names from VID

    Preload Vnf:sdngc_interface.robot(

      Update Module Name

      Preload Vnf Profile(

        Login To SDNGC Admin GUI

        click add_vnf_profile

/sdnc-oam/admportal/mobility.js

router.post('/addVnfNetwork', csp.checkAuth, function(req,res){
 var sql = "INSERT INTO VNF_NETWORKS (vnf_type,network_role) VALUES ("
 + "'" + req.body.nf_vnf_type + "'," + "'" + req.body.nf_network_role + "')";
 tasks.push( function(callback) { dbRoutes.executeSQL(sql,req,res,callback); } );

      Preload One Vnf Topology

DI 20: 20170721: Rest API Chaining

DI 21: 20170727: Parse VF-Module IPs from endpoint after VF-Module creation

DI 22: 20170728: Determine Healthcheck for vFW VMs are ready for appc Closed-Loop

The box should be ready for DMaaP TCA events - not just up with a 200.

Check port 667 on the sink vm.

DI 23: 20170728: Add granular Policy healthcheck for PDBD/PAP/PDP

DI 24: 20170728: Add TCA topic event capture between Policy and APPC

DI 25: 20170806: Add jcloud API to query VMs via Nova

http://jclouds.apache.org/guides/openstack/

DI 26: 20170806: Add docker ps parse calls to get docker health

ssh root@aai1 -o StrictHostKeyChecking=no 'docker ps'

will return results to calling server.

Notes

The MSO Rest post workaround to avoid VID for VF-Module creation fixes