Skip to content

X
xapp_test
Commit e67b02fc authored by Wen Wei Li's avatar Wen Wei Li
Browse files
Options

add README.md

parent b7e5fff2
Hide whitespace changes
Inline Side-by-side
Showing with 266 additions and 31 deletions
Dockerfile
View file @ e67b02fc
from xapp_frame
from prlab/xapp_frame
WORKDIR /xapp
......
README.md 0 → 100644
View file @ e67b02fc
### SAMPLE XAPP
* Build Dockerfile
```bash
docker build -t prlab/xapp_test:1.0.0 .
docker push prlab/xapp_test:1.0.0
```
* Onboard and Install xApp
```
cd xapp-descriptor/
# onboard xapp
# dms_cli onboard {path_to_config} {path_to_schema}
dms_cli onboard config.json schema.json
# check helm chart list
dms_cli get_charts_list
# install xapp
# dms_cli install {xapp_name} {version} -n {k8s namespace}
dms_cli install test 1.0.0 -n ricxapp
```
main.cpp
View file @ e67b02fc
......@@ -3,29 +3,34 @@
long m1000_count = 0; // message counters, one for each type
long m1001_count = 0;
using namespace std;
using namespace xapp;
// callback function that will increase the appropriate counter
void cbf( xapp::Message& mbuf, int mtype, int subid, int len,
xapp::Msg_component payload, void* data ) {
long* counter;
if( (counter = (long *) data) != NULL ) {
(*counter)++;
}
std::cout << *counter << std::endl;
cout << "[INFO] TEST Callback got a message, type=" << mtype << ", length=" << len << endl;
cout << "[INFO] Payload is " << (char*)payload.get() << endl;
cout << *counter << endl;
}
int main( ) {
std::unique_ptr<Xapp> xapp;
char* listen_port = (char *) "4560";
bool wait4table = false;
fprintf( stderr, "[INFO] listening on port %s\n", listen_port );
xapp = std::unique_ptr<Xapp>(
new Xapp( listen_port, wait4table ) );
// register the same callback function for both msg types
xapp->Add_msg_cb( 1000, cbf, (void *) &m1000_count );
xapp->Add_msg_cb( 1001, cbf, (void *) &m1001_count );
// run for 1 threads.
xapp->Run( 1 ); // start the callback driver
}
xapp-descriptor/config.json
View file @ e67b02fc
{
"comment": "test xapp",
"xapp_name": "xapp_test",
"xapp_name": "test",
"version": "1.0.0",
"containers": [
{
"name": "xapp_test",
"name": "test",
"image": {
"registry": "docker.io",
"name": "prlab/xapp_test",
......@@ -13,7 +13,7 @@
"command": [ "/bin/bash", "-c", "--" ],
"args": [ "/xapp/run_xapp.sh" ]
}
],
],
"messaging": {
"ports": [
{
......@@ -21,10 +21,9 @@
"container": "xapp_test",
"port": 4560,
"rxMessages": [
"RIC_UE_CONTEXT_RELEASE",
"TEST_ANOMALY_UPDATE"
"1000"
],
"txMessages": ["TEST_UE_LIST","TEST_ANOMALY_ACK"],
"txMessages": ["1001"],
"policies": [],
"description": "rmr receive data port for xapp_test"
},
......@@ -35,25 +34,5 @@
"description": "rmr route port for test xapp"
}
]
},
"rmr": {
"protPort": "tcp:4560",
"maxSize": 2072,
"numWorkers": 1,
"txMessages": [
"TEST_UE_LIST",
"TEST_ANOMALY_ACK"
],
"rxMessages":[
"RIC_UE_CONTEXT_RELEASE",
"TEST_ANOMALY_UPDATE"
],
"policies": [20008]
}
"controls":{
"test_control_api" : "rest",
"test_control_ep": "http://127.0.0.1:5000/api/echo"
}
}
xapp-descriptor/schema.json 0 → 100644
View file @ e67b02fc
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"title": "The Root Schema",
"required": [
"service_ports",
"rmr",
"envs"
],
"properties": {
"service_ports": {
"$id": "#/properties/service_ports",
"type": "object",
"title": "The Service_ports Schema",
"required": [
"xapp_port",
"rmr_port"
],
"properties": {
"xapp_port": {
"$id": "#/properties/service_ports/properties/xapp_port",
"type": "integer",
"title": "The Xapp_port Schema",
"default": 0,
"examples": [
4560
]
},
"rmr_port": {
"$id": "#/properties/service_ports/properties/rmr_port",
"type": "integer",
"title": "The Rmr_port Schema",
"default": 0,
"examples": [
4561
]
}
}
},
"rmr": {
"$id": "#/properties/rmr",
"type": "object",
"title": "The Rmr Schema",
"required": [
"protPort",
"maxSize",
"numWorkers",
"txMessages",
"rxMessages",
"file_path",
"contents"
],
"properties": {
"protPort": {
"$id": "#/properties/rmr/properties/protPort",
"type": "string",
"title": "The Protport Schema",
"default": "",
"examples": [
"tcp:4560"
],
"pattern": "^(.*)$"
},
"maxSize": {
"$id": "#/properties/rmr/properties/maxSize",
"type": "integer",
"title": "The Maxsize Schema",
"default": 0,
"examples": [
2072
]
},
"numWorkers": {
"$id": "#/properties/rmr/properties/numWorkers",
"type": "integer",
"title": "The Numworkers Schema",
"default": 0,
"examples": [
1
]
},
"txMessages": {
"$id": "#/properties/rmr/properties/txMessages",
"type": "array",
"title": "The Txmessages Schema",
"items": {
"$id": "#/properties/rmr/properties/txMessages/items",
"type": "string",
"title": "The Items Schema",
"default": "",
"examples": [
"RIC_SUB_REQ",
"RIC_SUB_DEL_REQ"
],
"pattern": "^(.*)$"
}
},
"rxMessages": {
"$id": "#/properties/rmr/properties/rxMessages",
"type": "array",
"title": "The Rxmessages Schema",
"items": {
"$id": "#/properties/rmr/properties/rxMessages/items",
"type": "string",
"title": "The Items Schema",
"default": "",
"examples": [
"RIC_SUB_RESP",
"RIC_SUB_FAILURE",
"RIC_SUB_DEL_RESP",
"RIC_SUB_DEL_FAILURE",
"RIC_INDICATION"
],
"pattern": "^(.*)$"
}
},
"file_path": {
"$id": "#/properties/rmr/properties/file_path",
"type": "string",
"title": "The File_path Schema",
"default": "",
"examples": [
"/tmp/routeinfo/routes.txt"
],
"pattern": "^(.*)$"
},
"contents": {
"$id": "#/properties/rmr/properties/contents",
"type": "string",
"title": "The Contents Schema",
"default": "",
"examples": [
"newrt|start\nrte|0|localhost:4560\nrte|2|localhost:4591\nrte|10002|localhost:4560\nrte|10005|localhost:4560\nrte|10003|localhost:4591\nrte|12010|localhost:4591\nrte|12020|localhost:4591\nrte|12011|localhost:4560\nrte|12012|localhost:4560\nrte|12021|localhost:4560\nrte|12022|localhost:4560\nrte|20000|localhost:4560\nrte|20001|localhost:4566\nnewrt|end "
],
"pattern": "^(.*)$"
}
}
},
"envs": {
"$id": "#/properties/envs",
"type": "object",
"title": "The Envs Schema",
"required": [
"gNodeB",
"THREADS",
"VES_SCHEMA_FILE",
"SAMPLE_FILE",
"VES_COLLECTOR_URL",
"VES_MEAUSUREMENT_INTERVAL"
],
"properties": {
"gNodeB": {
"$id": "#/properties/envs/properties/gNodeB",
"type": "string",
"title": "The Gnodeb Schema",
"default": "",
"examples": [
"NYC123"
],
"pattern": "^(.*)$"
},
"THREADS": {
"$id": "#/properties/envs/properties/THREADS",
"type": "string",
"title": "The Threads Schema",
"default": "",
"examples": [
"1"
],
"pattern": "^(.*)$"
},
"VES_SCHEMA_FILE": {
"$id": "#/properties/envs/properties/VES_SCHEMA_FILE",
"type": "string",
"title": "The Ves_schema_file Schema",
"default": "",
"examples": [
"/etc/xapp/ves_schema.json"
],
"pattern": "^(.*)$"
},
"SAMPLE_FILE": {
"$id": "#/properties/envs/properties/SAMPLE_FILE",
"type": "string",
"title": "The Sample_file Schema",
"default": "",
"examples": [
"/etc/xapp/samples.json"
],
"pattern": "^(.*)$"
},
"VES_COLLECTOR_URL": {
"$id": "#/properties/envs/properties/VES_COLLECTOR_URL",
"type": "string",
"title": "The Ves_collector_url Schema",
"default": "",
"examples": [
"127.0.0.1:6350"
],
"pattern": "^(.*)$"
},
"VES_MEAUSUREMENT_INTERVAL": {
"$id": "#/properties/envs/properties/VES_MEAUSUREMENT_INTERVAL",
"type": "string",
"title": "The Ves_meausurement_interval Schema",
"default": "",
"examples": [
"10"
],
"pattern": "^(.*)$"
}
}
}
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment