Newer
Older
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# How to develop a MEC application using the MEC Sandbox HTTP REST API\n",
"\n",
"## Table of contents\n",
"\r\n",
"1. What is a MEC applicationn](what_is_a_mec_applicationn)\r\n",
"2. The basics of developing a MEC applicationh](the_basics_of_developing_a_mec_application)\n",
"3. [Use the MEC Sandbox HTTP REST API models and code](#use_the_mec_sandbox_http_rest_api_models_and_code)\n",
"4. [Create our first MEC application](#create_our_first_mec_application)\n",
" 4.1. [The login function](#the_login_function)\n",
" 4.2. [The logout function](#the_logout_function)\n",
"5. [Second step: Retrieve the list of network scenarios](#second_step_retrieve_the_list_of_network_scenarios)\n",
"6. [Third step: Activate and deactivate a network scenario](#third_step_activate_and_deactivate_a_network_scenario)\n",
" 6.1. [The activate function](#the_activate_function)\n",
" 6.2. [The deactivate function](#thedeactivate_function)\n",
"7. [Fourth step: Create and delete an appliction instance id](#fourth_step_create_and_delete_an_appliction_instance_id)\n",
"8. [MEC Registration and the READY indication](#mec_registration_and_the_ready_indication)\n",
"9. [Annexes](#annexes)\n",
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## What is a MEC application\n",
"\n",
"See [The Wiki MEC web site](https://www.etsi.org/technologies/multi-access-edge-computing)\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## The basics of developing a MEC application\n",
"\n",
"The developement of a MEC application follows a strict process in order to access the ETSI MEC services and provides valueable services to the customers.\n",
"Mainly, this process can be split in several steps:\n",
"1. Global initializations (constant, variables...)\n",
"2. Create of a new instance of a MEC Sandbox (Note that using an existing one could be a solution too (see Annex A)\n",
"3. Activate a network scenario in order to access the ETSI MEC services\n",
"4. Create a new application identifier\n",
"5. Register our MEC application and subscribe to service termination (see MEC 011)\n",
"6. Use MEC services in order to provide valueable services to the customers\n",
" 6.1. Apply MEC services required subscriptions (e.g. MEC 013 location subscription)\n",
"7. Terminate the MEC application\n",
" 7.1. Remove MEC services subscriptions\n",
" 7.2. Deactivate the current network scenario\n",
" 7.3. Delete the instance of the MEC Sandbox\n",
"8. Release all the MEC application resources\n",
"\n",
"## Use the MEC Sandbox HTTP REST API models and code\n",
"\n",
"The MEC sandbox provides a piece of code (the python sub) that shall be used to develop the MEC applicationand interact with the MEC Sandbox. This piece of code mainly contains swagger models to serialize/deserialize JSON data structures and HTTP REST API call functions.\n",
"The openApi file is availabe [here](https://forge.etsi.org/rep/mec/AdvantEDGE/-/blob/Task2_PoC/go-apps/meep-sandbox-api/api/swagger.yaml) and the [Swagger editor](https://editor-next.swagger.io/) is used to generate the python sub.\n",
"\n",
"The project architecture is describe [here](images/project_arch.jpg).\n",
"\n",
"The api folder contains the python implementation of the HTTP REST API definitions introduced by the openApi [file](https://forge.etsi.org/rep/mec/AdvantEDGE/-/blob/Task2_PoC/go-apps/meep-sandbox-api/api/swagger.yaml).\n",
"The model folder contains the python implementation of the data type definitions introduced by the openApi [file](https://forge.etsi.org/rep/mec/AdvantEDGE/-/blob/Task2_PoC/go-apps/meep-sandbox-api/api/swagger.yaml).\n",
"irectory:"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Before to create our MEC ap[plication skeleton, the following steps shall be done:\n",
"1) Change the working directory (see the project architecture)"
]
},
{
"cell_type": "code",
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"/home/yann/dev/jupyter/Sandbox/mecapp\n"
]
}
],
"source": [
"import os\n",
"os.chdir(os.path.join(os.getcwd(), '../mecapp'))\n",
"print(os.getcwd())"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"2) Do the python import"
]
},
{
"cell_type": "code",
"metadata": {},
"outputs": [],
"source": [
"from __future__ import division # Import floating-point division (1/4=0.25) instead of Euclidian division (1/4=0)\n",
"\n",
"import os\n",
"import sys\n",
"import logging\n",
"import time\n",
"import json\n",
"import uuid\n",
"\n",
"from pprint import pprint\n",
"\n",
"import swagger_client\n",
"from swagger_client.rest import ApiException\n",
"\n",
"from http import HTTPStatus\n",
"from http.server import BaseHTTPRequestHandler, HTTPServer\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"3) to initialize the global constants (cell 3)"
]
},
{
"cell_type": "code",
"MEC_SANDBOX_URL = 'https://mec-platform.etsi.org' # MEC Sandbox host/base URL\n",
"MEC_SANDBOX_API_URL = 'https://mec-platform.etsi.org/sandbox-api/v1' # MEC Sandbox API host/base URL\n",
"PROVIDER = 'github' # Login provider value\n",
"MEC_PLTF = 'mep1' # MEC plateform name. Linked to the network scenario\n",
"LOGGER_FORMAT = '%(asctime)s - %(name)s - %(levelname)s - %(message)s' # Logging format\n",
"STABLE_TIME_OUT = 6 # Timer to wait for MEC Sndbox reaches its stable state (K8S pods in running state)\n",
"LOGIN_TIMEOUT = 30 # Timer to wait for user to authorize from GITHUB\n",
"LISTENER_IP = '0.0.0.0' # Listener IPv4 address for notification callback calls\n",
"LISTENER_PORT = 32100 # Listener IPv4 port for notification callback calls\n",
"CALLBACK_URI = \"/jupyter/sandbox/demo6/v1/\""
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"4) to setup a logger instance and initialize the global variables (cell 4)"
]
},
{
"cell_type": "code",
"metadata": {},
"outputs": [],
"source": [
"# Initialize the logger\n",
"logger = logging.getLogger(__name__)\n",
"logger.setLevel(logging.DEBUG)\n",
"logging.basicConfig(filename='/tmp/' + time.strftime(\"%Y%m%d-%H%M%S\") + '.log')\n",
"l = logging.StreamHandler()\n",
"l.setFormatter(logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))\n",
"logger.addHandler(l)\n",
"\n",
"# Setup the HTTP REST API configuration\n",
"configuration = swagger_client.Configuration()\n",
"configuration.verify_ssl = False\n",
"configuration.debug = True\n",
"configuration.logger_format = LOGGER_FORMAT\n",
"\n",
"# Create an instance of ApiClient to be used before each request\n",
"api = swagger_client.ApiClient(configuration, 'Content-Type', 'application/json')\n",
"\n",
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
"# Initialize the global variables\n",
"nw_scenarios = [] # The list of available network scenarios\n",
"nw_scenario_idx = -1 # The network scenario idx to activate (deactivate)\n",
"app_inst_id = None # The requested application instance identifier\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Create our first MEC application\n",
"\n",
"The first step to develop a MEC application is to create the application skeleton which contains the minimum steps below:\n",
" \n",
"- Login to instanciate a MEC Sandbox\n",
"- Logout to delete a existing MEC Sandbox"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### First steps: the login/logout\n",
"\n",
"Here is the first squeleton with the following sequence:\n",
"- Login\n",
"- Print sandbox identifier\n",
"- Logout\n",
"- Check that logout is effective\n"
]
},
{
"cell_type": "markdown",
"metadata": {
"jp-MarkdownHeadingCollapsed": true
},
"To log to the MEC Sandbox, \n",
"The login process is done in two step. In step 1, a user code is requested to GITHUB. In step 2, the user has to enter this user code to https://github.com/login/device and proceed to the authorization. \n",
"\n",
"It uses the HTTP POST request with the URL 'POST /sandbox-api/v1/login?provide=github' (see PROVIDER constant).\n"
"metadata": {},
"outputs": [],
"source": [
"# Login\n",
"def process_login() -> str:\n",
" \"\"\"\n",
" Authenticate and create a new MEC Sandbox instance.\n",
"\n",
" :return: The sandbox instance identifier on success, None otherwise\n",
" global PROVIDER, MEC_SANDBOX_API_URL, logger, configuration\n",
"\n",
" logger.debug(\">>> process_login\")\n",
"\n",
" try:\n",
" auth = swagger_client.AuthorizationApi(api)\n",
" oauth = auth.login(PROVIDER, async_req = False)\n",
" logger.debug(\"process_login (step1): oauth: \" + str(oauth))\n",
" # Wait for the MEC Sandbox is running\n",
" logger.debug(\"=======================> DO AUTHORIZATION WITH CODE : \" + oauth.user_code)\n",
" time.sleep(LOGIN_TIMEOUT) # Wait for Authirization from user side\n",
" namespace = auth.get_namespace(oauth.user_code)\n",
" logger.debug(\"process_login (step2): result: \" + str(namespace))\n",
" return namespace.sandbox_name\n",
" except ApiException as e:\n",
" logger.error(\"Exception when calling AuthorizationApi->login: %s\\n\" % e)\n",
"\n",
" return None\n",
" # End of function process_login\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### The logout function\n",
"\n",
"It uses the HTTP POST request with the URL 'POST /sandbox-api/v1/logout?sandbox_name={sandbox_name}'.\n"
]
},
{
"cell_type": "code",
"metadata": {},
"outputs": [],
"source": [
"# Logout\n",
"def process_logout(sandbox: str) -> int:\n",
" \"\"\"\n",
" Delete the specified MEC Sandbox instance.\n",
"\n",
" :param sandbox: The MEC Sandbox to delete\n",
" :return: 0 on success, -1 otherwise\n",
" \"\"\"\n",
"\n",
" global PROVIDER, MEC_SANDBOX_API_URL, logger, configuration\n",
" logger.debug(\">>> process_logout: sandbox=\" + sandbox)\n",
"\n",
" try:\n",
" auth = swagger_client.AuthorizationApi(api)\n",
" result = auth.logout(sandbox, async_req = False) # noqa: E501\n",
" return 0\n",
" except ApiException as e:\n",
" logger.error(\"Exception when calling AuthorizationApi->logout: %s\\n\" % e)\n",
" return -1\n",
" # End of function process_logout\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Now, let put in action our Login/Logout functions:"
]
},
{
"cell_type": "code",
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"2024-06-11 14:56:42,375 - __main__ - DEBUG - Starting at 20240611-145642\n",
"2024-06-11 14:56:42,379 - __main__ - DEBUG - \t pwd= /home/yann/dev/jupyter/Sandbox/mecapp\n",
"2024-06-11 14:56:42,381 - __main__ - DEBUG - >>> process_login\n",
"2024-06-11 14:56:42,385 DEBUG Starting new HTTPS connection (1): mec-platform.etsi.org:443\n",
"/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform.etsi.org'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings\n",
" warnings.warn(\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"send: b'POST /sandbox-api/v1/login?provider=github HTTP/1.1\\r\\nHost: mec-platform.etsi.org\\r\\nAccept-Encoding: identity\\r\\nContent-Length: 2\\r\\nAccept: application/json\\r\\nContent-Type: application/json\\r\\nUser-Agent: Swagger-Codegen/1.0.0/python\\r\\n\\r\\n'\n",
"send: b'{}'\n"
]
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"2024-06-11 14:56:42,743 DEBUG https://mec-platform.etsi.org:443 \"POST /sandbox-api/v1/login?provider=github HTTP/1.1\" 201 78\n",
"2024-06-11 14:56:42,746 DEBUG response body: b'{\"user_code\":\"616D-2A2D\",\"verification_uri\":\"https://github.com/login/device\"}'\n",
"2024-06-11 14:56:42,748 - __main__ - DEBUG - process_login (step1): oauth: {'user_code': '616D-2A2D',\n",
" 'verification_uri': 'https://github.com/login/device'}\n",
"2024-06-11 14:56:42,751 - __main__ - DEBUG - =======================> DO AUTHORIZATION WITH CODE : 616D-2A2D\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"reply: 'HTTP/1.1 201 Created\\r\\n'\n",
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
"header: Date: Tue, 11 Jun 2024 12:56:42 GMT\n",
"header: Content-Type: application/json; charset=UTF-8\n",
"header: Content-Length: 78\n",
"header: Connection: keep-alive\n",
"header: Strict-Transport-Security: max-age=15724800; includeSubDomains\n"
]
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"2024-06-11 14:57:12,782 DEBUG Resetting dropped connection: mec-platform.etsi.org\n",
"/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform.etsi.org'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings\n",
" warnings.warn(\n",
"2024-06-11 14:57:12,973 DEBUG https://mec-platform.etsi.org:443 \"GET /sandbox-api/v1/namespace?user_code=616D-2A2D HTTP/1.1\" 200 29\n",
"2024-06-11 14:57:12,975 DEBUG response body: b'{\"sandbox_name\":\"sbx2ghznh4\"}'\n",
"2024-06-11 14:57:12,977 - __main__ - DEBUG - process_login (step2): result: {'sandbox_name': 'sbx2ghznh4'}\n",
"2024-06-11 14:57:12,979 - __main__ - INFO - Sandbox created: sbx2ghznh4\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"send: b'GET /sandbox-api/v1/namespace?user_code=616D-2A2D HTTP/1.1\\r\\nHost: mec-platform.etsi.org\\r\\nAccept-Encoding: identity\\r\\nAccept: application/json\\r\\nContent-Type: application/json\\r\\nUser-Agent: Swagger-Codegen/1.0.0/python\\r\\n\\r\\n'\n",
"reply: 'HTTP/1.1 200 OK\\r\\n'\n",
"header: Date: Tue, 11 Jun 2024 12:57:12 GMT\n",
"header: Content-Type: application/json; charset=UTF-8\n",
"header: Connection: keep-alive\n",
"header: Strict-Transport-Security: max-age=15724800; includeSubDomains\n"
]
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"2024-06-11 14:57:18,987 - __main__ - DEBUG - >>> process_logout: sandbox=sbx2ghznh4\n",
"/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform.etsi.org'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings\n",
" warnings.warn(\n",
"2024-06-11 14:57:19,021 DEBUG https://mec-platform.etsi.org:443 \"POST /sandbox-api/v1/logout?sandbox_name=sbx2ghznh4 HTTP/1.1\" 204 0\n",
"2024-06-11 14:57:19,023 DEBUG response body: b''\n",
"2024-06-11 14:57:19,025 - __main__ - DEBUG - To check that logout is effective, verify on the MEC Sandbox server that the MEC Sandbox is removed (kubectl get pods -A\n",
"2024-06-11 14:57:19,027 - __main__ - DEBUG - Stopped at 20240611-145719\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"send: b'POST /sandbox-api/v1/logout?sandbox_name=sbx2ghznh4 HTTP/1.1\\r\\nHost: mec-platform.etsi.org\\r\\nAccept-Encoding: identity\\r\\nContent-Length: 2\\r\\nContent-Type: application/json\\r\\nUser-Agent: Swagger-Codegen/1.0.0/python\\r\\n\\r\\n'\n",
"send: b'{}'\n",
"reply: 'HTTP/1.1 204 No Content\\r\\n'\n",
"header: Date: Tue, 11 Jun 2024 12:57:18 GMT\n",
"header: Content-Type: application/json; charset=UTF-8\n",
"header: Connection: keep-alive\n",
"header: Strict-Transport-Security: max-age=15724800; includeSubDomains\n"
]
}
],
"source": [
"def process_main():\n",
" \"\"\"\n",
" This is the skeleton of our MEC application:\n",
" - Login\n",
" - Print sandbox identifier\n",
" - Logout\n",
" - Check that logout is effective\n",
" This skeleton will be the bas of the next sprint in order to achieve a full implementation of a MEC application\n",
" \"\"\" \n",
"\n",
" global PROVIDER, MEC_SANDBOX_API_URL, logger\n",
"\n",
" logger.debug(\"Starting at \" + time.strftime(\"%Y%m%d-%H%M%S\"))\n",
" logger.debug(\"\\t pwd= \" + os.getcwd())\n",
"\n",
" # Login\n",
" sandbox = process_login()\n",
" if sandbox is None:\n",
" return\n",
"\n",
" # Print sandbox identifier\n",
" logger.info(\"Sandbox created: \" + sandbox)\n",
" time.sleep(STABLE_TIME_OUT) # Wait for k8s pods up and running\n",
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
"\n",
" # Logout\n",
" process_logout(sandbox)\n",
"\n",
" # Check that logout is effective\n",
" logger.debug(\"To check that logout is effective, verify on the MEC Sandbox server that the MEC Sandbox is removed (kubectl get pods -A\")\n",
" \n",
" logger.debug(\"Stopped at \" + time.strftime(\"%Y%m%d-%H%M%S\"))\n",
" # End of function process_main\n",
"\n",
"if __name__ == '__main__':\n",
" process_main()\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Second step: Retrieve the list of network scenarios\n",
"\n",
"Let's go futhur and see how we can retrieve the list of the network scenarios available in order to activate one of them and access the MEC services exposed such as MEC 013 or MEC 030.\n",
"\n",
"The sequence will be:\n",
"- Login\n",
"- Print sandbox identifier\n",
"- Print available network scenarios\n",
"- Logout\n",
"- Check that logout is effective\n",
"\n",
"The login and logout functions are described in cell 3 and 4.\n",
"\n",
"To retrieve the list of the network scenarios, let's create a new function called 'get_network_scenarios'. It uses the HTTP GET request with the URL '/sandbox-api/v1/sandboxNetworkScenarios?sandbox_name={sandbox_name}'."
]
},
{
"cell_type": "code",
"metadata": {},
"outputs": [],
"source": [
"def get_network_scenarios(sandbox: swagger_client.Sandbox) -> list:\n",
" \"\"\"\n",
" Retrieve the list of the available network scenarios.\n",
"\n",
" :param sandbox: The MEC Sandbox instance to use\n",
" :return: The list of the available network scenarios on success, None otherwise\n",
" \"\"\"\n",
"\n",
" global PROVIDER, MEC_SANDBOX_API_URL, logger, configuration\n",
" logger.debug(\">>> get_network_scenarios: sandbox=\" + sandbox)\n",
"\n",
" try:\n",
" nw = swagger_client.SandboxNetworkScenariosApi(api)\n",
" result = nw.sandbox_network_scenarios_get(sandbox, async_req = False) # noqa: E501\n",
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
" logger.debug(\"get_network_scenarios: result: \" + str(result))\n",
" return result\n",
" except ApiException as e:\n",
" logger.error(\"Exception when calling SandboxNetworkScenariosApi->sandbox_network_scenarios_get: %s\\n\" % e)\n",
"\n",
" return None\n",
" # End of function get_network_scenarios\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Putting everything together:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"def process_main():\n",
" \"\"\"\n",
" This is the first sprint of our skeleton of our MEC application:\n",
" - Login\n",
" - Print sandbox identifier\n",
" - Print available network scenarios\n",
" - Logout\n",
" - Check that logout is effective\n",
" \"\"\" \n",
" global PROVIDER, MEC_SANDBOX_API_URL, logger, nw_scenarios \n",
"\n",
" logger.debug(\"Starting at \" + time.strftime(\"%Y%m%d-%H%M%S\"))\n",
" logger.debug(\"\\t pwd= \" + os.getcwd())\n",
"\n",
" # Login\n",
" sandbox = process_login()\n",
" if sandbox is None:\n",
" logger.error(\"Failed to instanciate a MEC Sandbox\")\n",
" return\n",
"\n",
" # Print sandbox identifier\n",
" logger.info(\"Sandbox created: \" + sandbox)\n",
" time.sleep(STABLE_TIME_OUT) # Wait for k8s pods up and running\n",
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
"\n",
" # Print available network scenarios\n",
" nw_scenarios = get_network_scenarios(sandbox)\n",
" if nw_scenarios is None:\n",
" logger.error(\"Failed to retrieve the list of network scenarios\")\n",
" elif len(nw_scenarios) != 0:\n",
" logger.info(\"nw_scenarios: %s\", str(type(nw_scenarios[0])))\n",
" logger.info(\"nw_scenarios: %s\", str(nw_scenarios))\n",
" else:\n",
" logger.info(\"nw_scenarios: No scenario available\")\n",
"\n",
" # Logout\n",
" process_logout(sandbox)\n",
"\n",
" # Check that logout is effective\n",
" logger.debug(\"To check that logout is effective, verify on the MEC Sandbox server that the MEC Sandbox is removed (kubectl get pods -A\")\n",
" \n",
" logger.debug(\"Stopped at \" + time.strftime(\"%Y%m%d-%H%M%S\"))\n",
" # End of function process_main\n",
"\n",
"if __name__ == '__main__':\n",
" process_main()\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Third step: Activate and deactivate a network scenario\n",
"\n",
"Having a list of network scenarion, the next step is to actvate (and deactivate) a network scenario. This step is mandatory to create a new application instance id and access the MEC services.\n",
"\n",
"In this section, we will arbitrary activate the network scenario called '4g-5g-macro-v2x', which is at the index 0 of the nw_scenarios. "
]
},
{
"cell_type": "code",
"metadata": {},
"outputs": [],
"source": [
"def select_network_scenario_based_on_criteria(criterias_list: list) -> int:\n",
" \"\"\"\n",
" Select the network scenario to activate based of the provided list of criterias.\n",
"\n",
" :param criterias_list: The list of criterias to select the correct network scenario\n",
" :return: 0 on success, -1 otherwise\n",
" \"\"\"\n",
" return 0 # The index of the '4g-5g-macro-v2x' network scenario - Hard coded"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### The activate function\n",
"\n",
"The process to activate a scenario is based on an HTTP POST request with the URL '/sandboxNetworkScenarios/{sandbox_name}?network_scenario_id={network_scenario_id}'.\n"
]
},
{
"cell_type": "code",
"metadata": {},
"outputs": [],
"source": [
"def activate_network_scenario(sandbox: swagger_client.Sandbox) -> int:\n",
" \"\"\"\n",
" Activate the specified network scenario.\n",
"\n",
" :param sandbox: The MEC Sandbox instance to use\n",
" :return: 0 on success, -1 otherwise\n",
" \"\"\"\n",
"\n",
" global MEC_SANDBOX_API_URL, logger, configuration, nw_scenarios, nw_scenario_idx\n",
" logger.debug(\">>> activate_network_scenario: \" + sandbox)\n",
"\n",
" nw_scenario_idx = select_network_scenario_based_on_criteria([])\n",
" if nw_scenario_idx == -1:\n",
" logger.error(\"activate_network_scenario: Failed to select a network scenarion\")\n",
" return -1\n",
"\n",
" try:\n",
" nw = swagger_client.SandboxNetworkScenariosApi(api)\n",
" result = nw.sandbox_network_scenario_post(sandbox, nw_scenarios[nw_scenario_idx].id, async_req = False) # noqa: E501\n",
" logger.debug(\"activate_network_scenario: result: \" + str(result))\n",
" return result\n",
" except ApiException as e:\n",
" logger.error(\"Exception when calling SandboxNetworkScenariosApi->activate_network_scenario: %s\\n\" % e)\n",
"\n",
" return -1\n",
" # End of function activate_network_scenario\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### The deactivate function\n",
"\n",
"The process to deactivate a scenario is based on an HTTP DELETE request with the URL '/sandboxNetworkScenarios/{sandbox_name}?network_scenario_id={network_scenario_id}'.\n"
]
},
{
"cell_type": "code",
"metadata": {},
"outputs": [],
"source": [
"def deactivate_network_scenario(sandbox: swagger_client.Sandbox) -> int:\n",
" \"\"\"\n",
" Deactivate the current network scenario.\n",
"\n",
" :param sandbox: The MEC Sandbox instance to use\n",
" :return: 0 on success, -1 otherwise\n",
" \"\"\"\n",
"\n",
" global MEC_SANDBOX_API_URL, logger, configuration, nw_scenarios, nw_scenario_idx\n",
" logger.debug(\">>> deactivate_network_scenario: \" + sandbox)\n",
"\n",
" try:\n",
" nw = swagger_client.SandboxNetworkScenariosApi(api)\n",
" result = nw.sandbox_network_scenario_delete(sandbox, nw_scenarios[nw_scenario_idx].id, async_req = False) # noqa: E501\n",
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
" logger.debug(\"deactivate_network_scenario: result: \" + str(result))\n",
" return result\n",
" except ApiException as e:\n",
" logger.error(\"Exception when calling SandboxNetworkScenariosApi->deactivate_network_scenario: %s\\n\" % e)\n",
"\n",
" return -1\n",
" # End of function deactivate_network_scenario\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Now, it is time to create the second iteration of our MEC application.\n",
"\n",
"The sequence is the following:\n",
"- Login\n",
"- Print sandbox identifier\n",
"- Print available network scenarios\n",
"- Activate a network scenario\n",
"- Check that the network scenario is activated and the MEC services are running\n",
"- Deactivate a network scenario\n",
"- Logout\n",
"- Check that logout is effective\n",
"\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"def process_main():\n",
" \"\"\"\n",
" This is the second sprint of our skeleton of our MEC application:\n",
" - Login\n",
" - Print sandbox identifier\n",
" - Print available network scenarios\n",
" - Activate a network scenario\n",
" - Check that the network scenario is activated and the MEC services are running\n",
" - Deactivate a network scenario\n",
" - Logout\n",
" - Check that logout is effective\n",
" \"\"\" \n",
" global PROVIDER, MEC_SANDBOX_API_URL, logger, nw_scenarios \n",
"\n",
" logger.debug(\"Starting at \" + time.strftime(\"%Y%m%d-%H%M%S\"))\n",
" logger.debug(\"\\t pwd= \" + os.getcwd())\n",
"\n",
" # Login\n",
" sandbox = process_login()\n",
" if sandbox is None:\n",
" logger.error(\"Failed to instanciate a MEC Sandbox\")\n",
" return\n",
"\n",
" # Print sandbox identifier\n",
" logger.info(\"Sandbox created: \" + sandbox)\n",
" time.sleep(STABLE_TIME_OUT) # Wait for k8s pods up and running\n",
"\n",
" # Print available network scenarios\n",
" nw_scenarios = get_network_scenarios(sandbox)\n",
" if nw_scenarios is None:\n",
" logger.error(\"Failed to retrieve the list of network scenarios\")\n",
" elif len(nw_scenarios) != 0:\n",
" logger.info(\"nw_scenarios: %s\", str(type(nw_scenarios[0])))\n",
" logger.info(\"nw_scenarios: %s\", str(nw_scenarios))\n",
" # Wait for the MEC Sandbox is running\n",
" time.sleep(STABLE_TIME_OUT) # Wait for k8s pods up and running\n",
" else:\n",
" logger.info(\"nw_scenarios: No scenario available\")\n",
"\n",
" # Activate a network scenario based on a list of criterias (hard coded!!!)\n",
" if activate_network_scenario(sandbox) == -1:\n",
" logger.error(\"Failed to activate network scenario\")\n",
" else:\n",
" logger.info(\"Network scenario activated: \" + nw_scenarios[nw_scenario_idx].id)\n",
" # Wait for the MEC services are running\n",
" time.sleep(STABLE_TIME_OUT) # Wait for k8s pods up and running\n",
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
"\n",
" # Check that the network scenario is activated and the MEC services are running \n",
" logger.info(\"To check that the network scenario is activated, verify on the MEC Sandbox server that the MEC services are running (kubectl get pods -A\")\n",
" time.sleep(60) # Sleep for 3 seconds\n",
"\n",
" # Deactivate a network scenario based on a list of criterias (hard coded!!!)\n",
" if deactivate_network_scenario(sandbox) == -1:\n",
" logger.error(\"Failed to deactivate network scenario\")\n",
" else:\n",
" logger.info(\"Network scenario deactivated: \" + nw_scenarios[nw_scenario_idx].id)\n",
" # Wait for the MEC services are terminated\n",
" time.sleep(STABLE_TIME_OUT)\n",
"\n",
" # Logout\n",
" process_logout(sandbox)\n",
"\n",
" # Check that logout is effective\n",
" logger.debug(\"To check that logout is effective, verify on the MEC Sandbox server that the MEC Sandbox is removed (kubectl get pods -A\")\n",
" \n",
" logger.debug(\"Stopped at \" + time.strftime(\"%Y%m%d-%H%M%S\"))\n",
" # End of function process_main\n",
"\n",
"if __name__ == '__main__':\n",
" process_main()\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Fourth step: Create and delete an appliction instance id\n",
"\n",
"To enable our MEC application to be part of the activated network scenario, we need to request the MEC sandbox to create a new application instance identifer. Our MEC application will use this identifier to register to the MEC Sandbox according to MEC 011.\n",
"\n",
"#### The appliction instance id creation function\n",
"\n"
]
},
{
"cell_type": "code",
"metadata": {},
"outputs": [],
"source": [
"def request_application_instance_id(sandbox: swagger_client.Sandbox) -> swagger_client.models.ApplicationInfo:\n",
" \"\"\"\n",
" \"\"\"\n",
"\n",
" global MEC_SANDBOX_API_URL, logger, configuration, app_inst_id\n",
" logger.debug(\">>> request_application_instance_id: \" + sandbox)\n",
"\n",
" # Create a instance of our MEC application\n",
" a = swagger_client.models.ApplicationInfo(id=str(uuid.uuid4()), name='JupyterMecApp', node_name=MEC_PLTF, type='USER') # noqa: E501\n",
" print(a)\n",
" \n",
" try:\n",
" nw = swagger_client.SandboxAppInstancesApi(api)\n",
" result = nw.sandbox_app_instances_post(a, sandbox, async_req = False) # noqa: E501\n",
" logger.debug(\"request_application_instance_id: result: \" + str(result))\n",
" return result\n",
" except ApiException as e:\n",
" logger.error(\"Exception when calling SandboxAppInstancesApi->sandbox_app_instances_post: %s\\n\" % e)\n",
"\n",
" return None\n",
" # End of function request_application_instance_id"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### The appliction instance id deletion function\n",
"\n"
]
},
{
"cell_type": "code",
"def delete_application_instance_id(sandbox: swagger_client.Sandbox) -> int:\n",
" global MEC_SANDBOX_API_URL, logger, configuration, app_inst_id\n",
" logger.debug(\">>> deletet_application_instance_id: \" + sandbox)\n",
"\n",
" try:\n",
" nw = swagger_client.SandboxAppInstancesApi(api)\n",
" result = nw.sandbox_app_instances_delete(sandbox, app_inst_id.id, async_req = False) # noqa: E501\n",
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
" logger.debug(\"deletet_application_instance_id: result: \" + str(result))\n",
" return result\n",
" except ApiException as e:\n",
" logger.error(\"Exception when calling SandboxAppInstancesApi->sandbox_app_instances_delete: %s\\n\" % e)\n",
"\n",
" return -1\n",
" # End of function deletet_application_instance_id"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"It is time now to create the our third iteration of our MEC application.\n",
"\n",
"The sequence is the following:\n",
"- Login\n",
"- Print sandbox identifier\n",
"- Print available network scenarios\n",
"- Activate a network scenario\n",
"- Request for a new application instance identifer\n",
"- Check \n",
"- Delete our application instance identifer\n",
"- Deactivate a network scenario\n",
"- Logout\n",
"- Check that logout is effective\n"
]
},
{
"cell_type": "code",
"source": [
"def process_main():\n",
" \"\"\"\n",
" This is the second sprint of our skeleton of our MEC application:\n",
" - Login\n",
" - Print sandbox identifier\n",
" - Print available network scenarios\n",
" - Activate a network scenario\n",
" - Check that the network scenario is activated and the MEC services are running\n",
" - Deactivate a network scenario\n",
" - Logout\n",
" - Check that logout is effective\n",
" \"\"\" \n",
" global PROVIDER, MEC_SANDBOX_API_URL, logger, nw_scenarios\n",
"\n",
" logger.debug(\"Starting at \" + time.strftime(\"%Y%m%d-%H%M%S\"))\n",
" logger.debug(\"\\t pwd= \" + os.getcwd())\n",
"\n",
" # Login\n",
" sandbox = process_login()\n",
" if sandbox is None:\n",
" logger.error(\"Failed to instanciate a MEC Sandbox\")\n",
" return\n",
"\n",
" # Print sandbox identifier\n",
" logger.info(\"Sandbox created: \" + sandbox)\n",
" time.sleep(STABLE_TIME_OUT) # Wait for k8s pods up and running\n",
"\n",
" # Print available network scenarios\n",
" nw_scenarios = get_network_scenarios(sandbox)\n",
" if nw_scenarios is None:\n",
" logger.error(\"Failed to retrieve the list of network scenarios\")\n",
" elif len(nw_scenarios) != 0:\n",
" logger.info(\"nw_scenarios: %s\", str(type(nw_scenarios[0])))\n",
" logger.info(\"nw_scenarios: %s\", str(nw_scenarios))\n",
" # Wait for the MEC Sandbox is running\n",
" time.sleep(STABLE_TIME_OUT) # Wait for k8s pods up and running\n",
" else:\n",
" logger.info(\"nw_scenarios: No scenario available\")\n",
"\n",
" # Activate a network scenario based on a list of criterias (hard coded!!!)\n",
" if activate_network_scenario(sandbox) == -1:\n",
" logger.error(\"Failed to activate network scenario\")\n",
" else:\n",
" logger.info(\"Network scenario activated: \" + nw_scenarios[nw_scenario_idx].id)\n",
" # Wait for the MEC services are running\n",
" time.sleep(STABLE_TIME_OUT) # Wait for k8s pods up and running\n",
"\n",
" # Request for a new application instance identifer\n",
" app_inst_id = request_application_instance_id(sandbox)\n",
" if app_inst_id == None:\n",
" logger.error(\"Failed to request an application instance identifer\")\n",
" else:\n",
" logger.info(\"app_inst_id: %s\", str(type(app_inst_id)))\n",
" logger.info(\"app_inst_id: %s\", str(app_inst_id))\n",
"\n",
" # Check that the network scenario is activated and the MEC services are running \n",
" logger.info(\"To check that the app_inst_id is created, verify on the MEC Sandbox server that the MEC services are running (kubectl get pods -A\")\n",
" time.sleep(3) # Sleep for 3 seconds\n",
"\n",
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
" if delete_application_instance_id(sandbox) == -1:\n",
" logger.error(\"Failed to delete the application instance identifer\")\n",
" else:\n",
" logger.info(\"app_inst_id deleted: \" + app_inst_id.id)\n",
"\n",
" # Deactivate a network scenario based on a list of criterias (hard coded!!!)\n",
" if deactivate_network_scenario(sandbox) == -1:\n",
" logger.error(\"Failed to deactivate network scenario\")\n",
" else:\n",
" logger.info(\"Network scenario deactivated: \" + nw_scenarios[nw_scenario_idx].id)\n",
" # Wait for the MEC services are terminated\n",
" time.sleep(STABLE_TIME_OUT)\n",
"\n",
" # Logout\n",
" process_logout(sandbox)\n",
"\n",
" # Check that logout is effective\n",
" logger.debug(\"To check that logout is effective, verify on the MEC Sandbox server that the MEC Sandbox is removed (kubectl get pods -A\")\n",
" \n",
" logger.debug(\"Stopped at \" + time.strftime(\"%Y%m%d-%H%M%S\"))\n",
" # End of function process_main\n",
"\n",
"if __name__ == '__main__':\n",
" process_main()\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## MEC Registration and the READY confirmation\n",
"\n",
"Having an application instance identifier allows us to register to the MEC Sandbox and interacts with it (e.g. to send service queries, to subscribe to events and to recieve notifications...).\n",
"\n",
"The standard MEC 011 Clause 5.2.2 MEC application start-up describes the start up process. Basically, our MEC application has to:\n",
"1. Indicates that it is running by sending a Confirm Ready message\n",
"2. Retrieve the list of MEC services \n",
"\n",
"To do so, a MEC application need to be able to send request but also to recieve notifications (POST requests) and to reply to them."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Fifth step: Send the READY confirmation\n",
"\n",
"Sending READY confirmation is described by MEC 011 Clause 5.2.2 MEC application start-up.\n",
"\n",
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"def send_ready_confirmation(app_inst_id: str) -> int:\n",
" global MEC_SANDBOX_URL, MEC_PLTF, logger\n",
"\n",
" try:\n",
" url = MEC_SANDBOX_URL + '/' + MEC_PLTF + '/mec_app_support/v2/applications/' + app_inst_id + '/confirm_ready'\n",
" header_params = {}\n",
" # HTTP header `Accept`\n",
" header_params['Accept'] = self.api_client.select_header_accept(['application/json']) # noqa: E501\n",
" # HTTP header `Content-Type`\n",
" header_params['Content-Type'] = self.api_client.select_header_accept(['application/json']) # noqa: E501\n",
" body = '{\\\"indication\\\":\\\"READY\\\"}'\n",
" result = api.call_api(url, 'POST', header_params=header_params, body=body, async_req=False)\n",
" return 0\n",