Manual Configurations for Option2

1. UUI Configuration

Configure CST template UUID and Invariant UUID in slicing.properties file of uui-server microservice

In uui-server microservice, modify the following configuration file, /home/UUI/config/slicing.properties

Add or update the parameters slicing.serviceInvariantUuid and parameter slicing.serviceUuid.

The values of these two parameters come from CST template which can be find on SDC page.

2. MSB Configuration

Register so-orchestrationTasks and so-serviceInstances interface to MSB.

Interface registration can be done through portal.

Steps(Portal):

Link: https://{{master server ip}}:30284/iui/microservices/default.html

 1.Select ‘Service Discover’ in the left pane

 2. Click 'Service Register' button.

 3. Input the basic info as the picture shows(also refer to the registration info provided above)

4. Click Add Host button.

    Input IP Address and Port then click the 'SAVE' button. （Use cmd ’kubectl get svc -n onap so‘ to confirm IP and port.）

5.  Input the basic info as the picture shows for so-orchestrationTasks (also refer to the registration info provided above)

6. You should add a  aai-business service for MSB.
Steps:

• Got to msb https://{{master server ip}}:30284/iui/microservices/default.html
• Select "Service Discover" from left panel
• Click "Service Register" button
  • ADD the following info:
    Service Name: aai-business
    Url: /aai/v13/business
    Protocol: REST
    Enable SSL to True
    Version: v13
    Load balancer: round-robin
    Visualranfe: InSystem
  • Add host:
    AAI service ip and port (8443)
• Save all

3. AAI Configuration

Create customer id  : 

curl --user AAI:AAI -X PUT -H "X-FromAppId:AAI" -H  "X-TransactionId:get_aai_subscr" -H "Accept:application/json" -H "Content-Type:application/json" -k -d '{ 

"global-customer-id":"5GCustomer", 

"subscriber-name":"5GCustomer", 

"subscriber-type":"INFRA" 

}' "https://<worker-vm-ip>:30233/aai/v21/business/customers/customer/5GCustomer" 

Create service type:

curl --user AAI:AAI -X PUT -H "X-FromAppId:AAI" -H  "X-TransactionId:get_aai_subscr" -H "Accept:application/json" -H "Content-Type:application/json" -k https://<worker-vm-ip>:30233/aai/v21/business/customers/customer/5GCustomer/service-subscriptions/service-subscription/5G

4. SO

Copy subnetCapability.json to SO-API Handler pod to configure subnet capabilities at run time.

Sample subnetCapability.json

{
"AN_NF": {
"latency": 5,
"maxNumberofUEs": 200,
"maxThroughput": 90,
"termDensity": 40
},
"AN": {
"latency": 20,
"maxNumberofUEs": 100,
"maxThroughput": 150,
"termDensity": 50
},
"CN": {
"latency": 10,
"maxThroughput": 50,
"maxNumberofConns": 100
},
"TN_FH": {
"latency": 10,
"maxThroughput": 90
},
"TN_MH": {
"latency": 5,
"maxThroughput": 90
},
"TN_BH": {
"latency": 10,
"maxThroughput": 100
}
}

You can copy the file to the pod using the following command

SO Database Update

Insert ORCHESTRATION_URI into service_recipe,  SERVICE_MODEL_UUID replaced by CST.ModelId.

Insert ORCHESTRATION_URI into service_recipe,  SERVICE_MODEL_UUID is ServiceProfile.ModelId

5. OOF Configuration - Policy Creation Steps

Refer Optimization Policy Creation Steps for optimization policy creation and deployment steps

Please find the policies for Option2 below, generate the policies outside the OOF pod and push the policies from inside OOF pod, since it has python3 and necessary libraries already installed 

policies_option2.zip

Copy the policy files

unzip policies_option2.zip

kubectl cp policies_option2 -n onap <oof-pod-name>:/opt/osdf

kubectl exec -ti -n onap <oof-pod-name> bash

cd policies_option2/

python3 policy_utils.py create_policy_types policy_types

python3 policy_utils.py create_and_push_policies nst_policies

python3 policy_utils.py generate_nsi_policies NSTO2

python3 policy_utils.py create_and_push_policies gen_nsi_policies

python3 policy_utils.py generate_nssi_policies EmbbAn_NF minimize latency

python3 policy_utils.py create_and_push_policies gen_nssi_policies

python3 policy_utils.py generate_nssi_policies Tn_ONAP_internal_BH  minimize latency

python3 policy_utils.py create_and_push_policies gen_nssi_policies

NOTE: 

For NST Selection based on latency constraint, please make sure you have updated the latency constraint as property in the design time template of NST as below,

Updated slice/service profile mapping - slicing_config.yaml

HAS-API/HAS-DATA - Add data dictionary 

Go to (/opt/has/conductor/conductor/data/plugins/inventory_provider/candidates/slice_profiles_candidate.py) in OOF HAS pod 
update the following :
    "max_bandwidth": copy_first,
    "jitter": sum,
    "sst": copy_first,
    "latency": sum,
    "resource_sharing_level": copy_first,
    "s_nssai": copy_first,
    "s_nssai_list": copy_first,
    "plmn_id_list": copy_first,
    "plmn_id_List": copy_first,
    "availability": copy_first,
    "throughput": min,
    "reliability": copy_first,
    "max_number_of_ues": copy_first,
    "exp_data_rate_ul": copy_first,
    "exp_data_rate_dl": copy_first,
    "ue_mobility_level": copy_first,
    "activity_factor": copy_first,
    "survival_time": copy_first,
    "max_number_of_conns": copy_first,
    "coverage_area_ta_list": copy_first,
    "max_number_of_pdu_session": copy_first,
    "max_throughput": copy_first,
    "perf_req": copy_first,
    "terminal_density": copy_first

update those and restart the container

NOTE:

• The service name given for creating the policy must match with the service name in the request
• The scope fields in the policies should match with the value in the resourceSharingLevel(non-shared/shared). Do modify the policy accordingly.
• Check the case of the attributes with the OOF request with the attribute map (camel to snake and snake to camel) in config/slicing_config.yaml, if any mismatch found modify the attribute map accordingly.

• You need to restart the OOF docker container once you updated the slicing_config.yaml, you can do it using the following steps,

  • Login to the worker VM where the OOF container is running. You can find the worker node by running (kubectl get pods -n onap -o wide | grep dev-oof)
  • Find the container using docker ps | grep optf-osdf
  • Restart the container using docker restart <container id>

6. External RAN NSSMF Simulator

Deployment Guide for External RAN NSSMF Simulator

1. Download:

2. Environment Setup (Optional):

1) The default listening port of RESTful API is 8443, and you can set environment variable RAN_NSSMF_REST_PORT to change it, such as:

2) The default username and password are in RanNssmfSimulator/etc/auth.json, and you can edit the file to change them or add new ones.

3. Install and Run:

There are two options to run the simulator:

Option 1. Directly run it in the current directory:

Option 2. Install it using setuptools, and run it in any directory:

Register to ONAP ESR

Add an esr-thirdparty-sdnc and esr-system-info to ESR:

Where, ip-address is the IP address or hostname which runs the External RAN NSSMF Simulator, port is the listening port of RESTful API of the simulator,

user-name and password are set in config file RanNssmfSimulator/etc/auth.json of the simulator.

7. External CORE NSSMF Simulator

Installation Steps:

 There are two ways to run Core NSSMF simulator. One is to start via jar package(External Core NSSMF Simulator Use Guide) and the other is to start via docker-compose.

Start by docker-compose

This is the package:

simulator.tar.gz

1. Extract the downloaded cn-nssmf-simulator-docker-compose.tar.gz

tar xf cn-nssmf-simulator-docker-compose.tar.gz -C .
cd cn-nssmf-simulator-docker-compose

2. modify application.properties

# vi application.properties
server.port=11111
notifyurl=http://192.168.235.25:30472/v1/pm/notification
ftppath=sftp://root:oom@192.168.235.25:22/home/ubuntu/dcae/PM.tar.gz
fixeddelay=900000
#Configure the output files generated in docker.
filepath=/app/dcae
amffilepath=/app/dcae/AMF.xml.gz
upffilepath=/app/dcae/UPF.xml.gz

3. modify docker-compose.yml

# vi docker-compose.yml
version: '3'
services:
cn-simulator-docker-compose:
image: openjdk:8-jre-slim
container_name: cn-simulator-test-1
ports:
- "11111:11111"
restart: always
# mount the cn-nssmf-simulator-docker-compose directory of the host machine to the /app directory of the container
# If you need to modify the simulator's configuration file application.properties later,
# you can directly modify the host's cn-nssmf-simulator-docker-compose/application.properties to synchronize to the container
volumes:
- ./:/app
working_dir: /app
entrypoint: java -jar simulator-0.0.1-SNAPSHOT.jar

4. start up the application by running " docker-compose up"

Register to ONAP ESR

Add an esr-thirdparty-sdnc and esr-system-info to ESR:

Where, ip-address is the IP address or hostname which runs the External RAN NSSMF Simulator, port is the listening port of RESTful API of the simulator.

9. ACTN Simulator

Refer ACTN Simulator User Guide to setup ACTN-simulator or follow the below steps to launch and initialize domain controllers,

Step 1. Fetch the simulator docker image

First, pull down the simulator image from public docker hub.

Step 2. Start the simulator container(s)

After compiling the pnc-simulator image locally or fetching the docker image from remote registry, execute the command below to start the container:

For demonstration purposes, two domain controllers are required, in our case we use 18181 as SERVER_PORT for domain1 and 18182 for domain2.

After starting the container, you should be able to verify the running container by:

Step 3. Initialize the simulator(s)

The simulator offers a set of administrative APIs which are designed for initialization and management purposes.

To initialize the simulator for each domain:

For demonstration purposes, two domain controllers are required, both need to be properly launched and initialized. The initialization payloads are attached below.

pnc-init-payload-1-r9.jsonpnc-init-payload-2-r9.json

ESR Registration using AAI ESR Url:

Once a third-party controller is being registered in ONAP, a "Topology Discovery" operation need be triggered and the domain controller will be called in order to retrieve the topology. SDNC then, will store the topology in AAI. Please execute the below curl command for the ESR registration of initialized two domain controllers,

NOTE: Replace <simulator-ip> and <simulator-port> with the IP Address and port of initialized simulators.

curl -k -X PUT "https://AAI:AAI@<worker-vmIp>:30233/aai/v23/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/ff9ef162-951d-4e14-9ce6-b4fa0adf896b" \
-H 'Accept: application/json' \
-H 'X-FromAppId: AAI' \
-H 'X-TransactionId: 1' \
-H 'Content-Type: application/json' \
-d '{
"thirdparty-sdnc-id":"ff9ef162-951d-4e14-9ce6-b4fa0adf896b",
    "location": "edge",
    "product-name": "TSDN",
	 "esr-system-info-list":{"esr-system-info":[{
"esr-system-info-id": "7c29b9df-feef-4fa7-b56d-3e39f5ef4a90",
"system-name": "sdnc2",
"vendor": "HUAWEI",
"type": "WAN",
"version": "v1.0",
"service-url": "http://<simulator-ip>:<simulator-port>",
"user-name": "onos",
"password": "rocks",
"system-type": "thirdparty_SDNC",
"protocol": "restconf"
}]}
}' 

E2E network slicing test(using resource occupancy details)

Before creating shared communication service for testing NSI/NSSI selection using resource occupancy details, below manual configurations must be done:

Deployment Prerequisite/dependencies

1. VES, PM mapper and DataFile Collector, dcae-mongodb, Datalake Extraction Service(DES) and Datalake-feeder services should be running.

Datalake Extraction Service(DES):

1. Build presto image and push the images to a exsting repository
   1. Download and extract presto package version v0.0.2: presto-v0.0.2.tar.gz
   2. docker build -t presto:v0.0.2 .
   3. docker tag presto:v0.0.2 registry.baidubce.com/onap/presto:v0.0.2
   4. docker push registry.baidubce.com/onap/presto:v0.0.2
   5. Note： Replace the repository path with your own repository.
2. Install presto service
   1. kubectl -n onap run dl-presto --image=presto:v0.0.2 --env="MongoDB_IP=dcae-mongohost" --env="MongoDB_PORT=27017" --image-pull-policy=IfNotPresent
   2. kubectl expose pod dl-presto --name=dl-presto --port=9000 --target-port=9000 --type=NodePort -n onap
3. Login to the dev-dcae-datalake-postgres-primary container and execute following sql commands:
   1. datalake sql data Expand source

      delete from map_db_topic;
      delete from map_db_design;
      delete from db;
      delete from data_exposure ;
      insert into db (id, db_type_id, enabled, encrypt, name,host,port,database_name) values (2, 'MONGO', true, true, 'MongoDB 1','dcae-mongohost',27017,'datalake');
      insert into map_db_topic(db_id,topic_id) select db.id, topic.id from db_type, db, topic where db.db_type_id=db_type.id and db_type.tool=false;
      update kafka set secure=true, pass='admin_secret' where id=1;
      insert into topic_name (id) values ('unauthenticated.PERFORMANCE_MEASUREMENTS');
      insert into topic(id, topic_name_id,correlate_cleared_message,enabled, message_id_path,data_format) values (6, 'unauthenticated.PERFORMANCE_MEASUREMENTS',true,true,'/event/commonEventHeader','JSON');
      insert into data_exposure(id, note,sql_template,db_id) values ('pm_data','pm_message', 'SELECT json_format(CAST( event.perf3gppFields.measDataCollection.measInfoList[1].measTypes.sMeasTypesList AS JSON)) AS sMeasTypesList, json_format(CAST( event.perf3gppFields.measDataCollection.measInfoList[1].measValuesList AS JSON)) AS measValuesList FROM unauthenticatedperformancemeasurements WHERE any_match(event.perf3gppFields.measDataCollection.measInfoList[1].measTypes.sMeasTypesList, e -> e like ''${snssai}'') AND event.commonEventHeader.startEpochMicrosec >= ${time}',2); //db_id refers to mongodb in table db, this template filters PM data based on snssai and startEpochMicrosec;

   2. Load sample data in mongo db(refer DCAE mongodb section)

   3. Execute below request to verify: curl --header "Content-type: application/json" --request POST --data '{"snssai":"SM.PrbUsedDl.01-910EF6","time":"1649853949111"}' http://dl-des:1681/datalake/v1/exposure/pm_data -i

Datalake Feeder:

1. Restart datalake-feeder container after loading above configurations in the DB.

RANSIM :

1. RANSIM and honeycomb containers should be running
2. You can update/add/delete data(throughput, PRBs, maxNoConns etc) in mariadb container(credentials in docker-compose file) if required before generation of PM data.
3. RANSIM must contain 'plmninfo' of the service which is to be shared with other services. Then generate closed-loop PM data which will be stored in mongo-db by datalake-feeder.
4. Sample closed loop data: closed-loop-data.txt
5. Run the following command to generate Closed Loop PM data:
   1. curl -X POST http://localhost:8081/ransim/api/generateClosedLoopPmData -i
6. Run the following command to stop Closed Loop PM data(When enough PM data is generated): 
   1. curl -X GET http://localhost:8081/ransim/api/stopClosedLoopPmData -i
7. Access the DU honeycomb containers to view the logs:
   1. docker container logs -f 110
8. Check the folder(where SFTP setup is done) to view the generated PM data files.
9. Access VES, data file collector, dmaap-dr, PM mapper and slice-analysis logs to verify.

DCAE-MONGO DB:

1. Login to dcae-mongodb container and execute following commands to check if PM data was saved in DB:
   1. mongo
   2. use datalake
   3. db.unauthenticatedperformancemeasurements.find({})
   4. to load sample data:
   5. sample mongodb data Expand source

      db.unauthenticatedperformancemeasurements.insert({
         "event":{
            "commonEventHeader":{
               "domain":"perf3gpp",
               "eventId":"95e79282-2876-4000-8192-b514ad7f399a",
               "sequence":0,
               "eventName":"perf3gpp_RnNode-Slicing_pmMeasResult",
               "sourceName":"220",
               "reportingEntityName":"",
               "priority":"Normal",
               "startEpochMicrosec":1651216762867,
               "lastEpochMicrosec":1651216762868,
               "version":"4.0",
               "vesEventListenerVersion":"7.1",
               "timeZoneOffset":"UTC+05:30"
            },
            "perf3gppFields":{
               "perf3gppFieldsVersion":"1.0",
               "measDataCollection":{
                  "granularityPeriod":900,
                  "measuredEntityUserName":"",
                  "measuredEntityDn":"220",
                  "measuredEntitySoftwareVersion":"r0.1",
                  "measInfoList":[
                     {
                        "measInfoId":{
                           "sMeasInfoId":"measInfoIsVal"
                        },
                        "measTypes":{
                           "sMeasTypesList":[
                              "SM.PrbUsedDl.01-3C5C90",
                              "SM.PrbUsedUl.01-3C5C90"
                           ]
                        },
                        "measValuesList":[
                           {
                              "measObjInstId":"15155",
                              "suspectFlag":"false",
                              "measResults":[
                                 {
                                    "p":1,
                                    "sValue":"5"
                                 },
                                 {
                                    "p":2,
                                    "sValue":"7"
                                 }
                              ]
                           },
                           {
                              "measObjInstId":"15174",
                              "suspectFlag":"false",
                              "measResults":[
                                 {
                                    "p":1,
                                    "sValue":"6"
                                 },
                                 {
                                    "p":2,
                                    "sValue":"7"
                                 }
                              ]
                           },
                           {
                              "measObjInstId":"15175",
                              "suspectFlag":"false",
                              "measResults":[
                                 {
                                    "p":1,
                                    "sValue":"15"
                                 },
                                 {
                                    "p":2,
                                    "sValue":"4"
                                 }
                              ]
                           },
                           {
                              "measObjInstId":"15176",
                              "suspectFlag":"false",
                              "measResults":[
                                 {
                                    "p":1,
                                    "sValue":"5"
                                 },
                                 {
                                    "p":2,
                                    "sValue":"14"
                                 }
                              ]
                           },
                           {
                              "measObjInstId":"15825",
                              "suspectFlag":"false",
                              "measResults":[
                                 {
                                    "p":1,
                                    "sValue":"0"
                                 },
                                 {
                                    "p":2,
                                    "sValue":"14"
                                 }
                              ]
                           }
                        ]
                     }
                  ]
               }
            }
         }
      })