Update demo4-ue docs (9927ff36) · Commits · MEC - Multi-access Edge Computing / ETSI MEC Sandbox

examples/demo4-ue/README.md

+347 −1

Original line number	Diff line number	Diff line
		@@ -125,6 +125,339 @@ The requets `POST /dai/availability/{appcontextid}` provides the location availa
		$ curl -X POST "http://mec-platform.etsi.org:31111/dai/availability/20" -H "accept: application/json"
		```

		#### Postman workspace

		The code below is the the Postman workspace equivalent to the cUrl requests above.

		```json
		{
		"info": {
		"_postman_id": "e8a79bf9-aeba-4869-91a1-45fb6f7320a7",
		"name": "demo4-ue",
		"description": "This collection provides all Curl command supported by the UE appliction demo4-ue",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
		"_exporter_id": "3317208"
		},
		"item": [
		{
		"name": "/info/application",
		"protocolProfileBehavior": {
		"disabledSystemHeaders": {
		"accept": true
		}
		},
		"request": {
		"method": "GET",
		"header": [
		{
		"key": "Accept",
		"value": "application/json",
		"type": "text"
		}
		],
		"url": {
		"raw": "sandbox-mec.etsi.org:31111/info/application",
		"host": [
		"sandbox-mec",
		"etsi",
		"org"
		],
		"port": "31111",
		"path": [
		"info",
		"application"
		],
		"query": [
		{
		"key": "",
		"value": null,
		"disabled": true
		}
		]
		}
		},
		"response": []
		},
		{
		"name": "/info/logs",
		"protocolProfileBehavior": {
		"disabledSystemHeaders": {
		"accept": true
		}
		},
		"request": {
		"method": "GET",
		"header": [
		{
		"key": "Accept",
		"value": "application/json",
		"type": "text"
		}
		],
		"url": {
		"raw": "sandbox-mec.etsi.org:31111/info/logs",
		"host": [
		"sandbox-mec",
		"etsi",
		"org"
		],
		"port": "31111",
		"path": [
		"info",
		"logs"
		],
		"query": [
		{
		"key": "",
		"value": null,
		"disabled": true
		}
		]
		}
		},
		"response": []
		},
		{
		"name": "/dai/apps",
		"protocolProfileBehavior": {
		"disabledSystemHeaders": {
		"accept": true
		}
		},
		"request": {
		"method": "GET",
		"header": [
		{
		"key": "Accept",
		"value": "application/json",
		"type": "text"
		}
		],
		"url": {
		"raw": "sandbox-mec.etsi.org:31111/dai/apps",
		"host": [
		"sandbox-mec",
		"etsi",
		"org"
		],
		"port": "31111",
		"path": [
		"dai",
		"apps"
		],
		"query": [
		{
		"key": "",
		"value": null,
		"disabled": true
		}
		]
		}
		},
		"response": []
		},
		{
		"name": "/dai/instantiate",
		"protocolProfileBehavior": {
		"disabledSystemHeaders": {
		"accept": true
		}
		},
		"request": {
		"method": "POST",
		"header": [
		{
		"key": "Accept",
		"value": "accept: application/json",
		"type": "text"
		}
		],
		"url": {
		"raw": "sandbox-mec.etsi.org:31111/dai/instantiate",
		"host": [
		"sandbox-mec",
		"etsi",
		"org"
		],
		"port": "31111",
		"path": [
		"dai",
		"instantiate"
		]
		}
		},
		"response": []
		},
		{
		"name": "/yannsb/onboarded-demo4/ping",
		"protocolProfileBehavior": {
		"disabledSystemHeaders": {
		"accept": true
		}
		},
		"request": {
		"method": "GET",
		"header": [
		{
		"key": "Accept",
		"value": "accept: application/json",
		"type": "text"
		}
		],
		"url": {
		"raw": "https://195.238.226.94/yannsb/onboarded-demo4/ping",
		"protocol": "https",
		"host": [
		"195",
		"238",
		"226",
		"94"
		],
		"path": [
		"yannsb",
		"onboarded-demo4",
		"ping"
		]
		}
		},
		"response": []
		},
		{
		"name": "/yannsb/onboarded-demo4/terminate",
		"protocolProfileBehavior": {
		"disabledSystemHeaders": {
		"accept": true
		}
		},
		"request": {
		"method": "DELETE",
		"header": [
		{
		"key": "Accept",
		"value": "accept: application/json",
		"type": "text"
		}
		],
		"url": {
		"raw": "https://sandbox-mec.etsi.org/yannsb/onboarded-demo4/ping",
		"protocol": "https",
		"host": [
		"sandbox-mec",
		"etsi",
		"org"
		],
		"path": [
		"yannsb",
		"onboarded-demo4",
		"ping"
		]
		}
		},
		"response": []
		},
		{
		"name": "/dai/doping",
		"protocolProfileBehavior": {
		"disabledSystemHeaders": {
		"accept": true
		}
		},
		"request": {
		"method": "GET",
		"header": [
		{
		"key": "Accept",
		"value": "accept: application/json",
		"type": "text"
		}
		],
		"url": {
		"raw": "sandbox-mec.etsi.org:31111/dai/doping/25",
		"host": [
		"sandbox-mec",
		"etsi",
		"org"
		],
		"port": "31111",
		"path": [
		"dai",
		"doping",
		"25"
		]
		}
		},
		"response": []
		},
		{
		"name": "/dai/delete",
		"protocolProfileBehavior": {
		"disabledSystemHeaders": {
		"accept": true
		}
		},
		"request": {
		"method": "DELETE",
		"header": [
		{
		"key": "Accept",
		"value": "accept: application/json",
		"type": "text"
		}
		],
		"url": {
		"raw": "sandbox-mec.etsi.org:31111/dai/delete/25",
		"host": [
		"sandbox-mec",
		"etsi",
		"org"
		],
		"port": "31111",
		"path": [
		"dai",
		"delete",
		"25"
		]
		}
		},
		"response": []
		},
		{
		"name": "/dai/availability",
		"protocolProfileBehavior": {
		"disabledSystemHeaders": {
		"accept": true
		}
		},
		"request": {
		"method": "POST",
		"header": [
		{
		"key": "Accept",
		"value": "accept: application/json",
		"type": "text"
		}
		],
		"url": {
		"raw": "sandbox-mec.etsi.org:31111/dai/availability/25",
		"host": [
		"sandbox-mec",
		"etsi",
		"org"
		],
		"port": "31111",
		"path": [
		"dai",
		"availability",
		"25"
		]
		}
		},
		"response": []
		}
		]
		}
		```

		### onboarded-demo4

		The MEC application onboarded-demo4 is a basic HTTP REST API "Ping/Pong" application. When it recieves an HTTP GET /ping request, it replies with 200 OK "pong".
		@@ -185,7 +518,20 @@ Therefore, the following steps need to be done prior to running Demo4 applicatio
		Use the same procedure described above for Demo4 with AdvantEDGE.

		#### Create work directory for demo4-ue instance
		Create work directories of your choice on the system of your choosing; we’ll use ~/demo4 for this example.
		Create a work directory of your choice on the system (e.g. ~/tmp/demo4) and copy the files ~/AdvantEDGE/examples/demo4-ue/src/demo-server/demo4-ue-config.yaml and ~/AdvantEDGE/examples/demo4-ue/bin/demo-server/demo-server.

		The structure should look like this:

		```
		~/tmp/demo4
		\|
		\____ demo4-ue-config.yaml
		\|
		\____ demo-server
		```

		Update the configuration file demo4-ue-config.yaml accordingly and launcg the demo application:

		```sh
		$ ./demo-server ./demo4-ue-config.yaml
		```