Newer
Older
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# How to develop a MEC application using the MEC Sandbox HTTP REST API\n",
"This tutorial introduces the step by step procedure to create a basic MEC appcation following ETSI MEC standards.\n",
"It uses the ETSI MEC Sandbox simulator.\n",
"\n"
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
]
},
{
"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 = 'Jupyter2024' # 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 = 3 #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",
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
"# 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": {},
"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",
"Please, pay attention to the log '=======================> DO AUTHORIZATION WITH CODE :' which indicate you the user code to use for 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",
"execution_count": null,
"outputs": [],
"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",
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
"\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",
"execution_count": 7,
"def get_network_scenarios(sandbox: str) -> 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",
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
" 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",
426
427
428
429
430
431
432
433
434
435
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
"\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",
"execution_count": 8,
"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",
"execution_count": 9,
"def activate_network_scenario(sandbox: str) -> 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",
"execution_count": 10,
"def deactivate_network_scenario(sandbox: str) -> 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",
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
" 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",
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
"\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 identifier. 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",
"def request_application_instance_id(sandbox: str) -> swagger_client.models.ApplicationInfo:\n",
" global MEC_SANDBOX_API_URL, MEC_PLTF, logger, configuration\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"
"def delete_application_instance_id(sandbox: str, id: str) -> int:\n",
" global MEC_SANDBOX_API_URL, logger, configuration\n",
" logger.debug(\">>> delete_application_instance_id: \" + sandbox)\n",
" logger.debug(\">>> delete_application_instance_id: \" + id)\n",
"\n",
" try:\n",
" nw = swagger_client.SandboxAppInstancesApi(api)\n",
" result = nw.sandbox_app_instances_delete(sandbox, id, async_req = False) # noqa: E501\n",
" logger.debug(\"delete_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"
]
},
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### Getting the list of applications"
]
},
{
"cell_type": "code",
"execution_count": 19,
"metadata": {},
"outputs": [],
"source": [
"def get_applications_list(sandbox: str) -> dict:\n",
" \"\"\"\n",
" \"\"\"\n",
"\n",
" global MEC_SANDBOX_API_URL, logger, configuration\n",
"\n",
" logger.debug(\">>> get_applications_list: \" + sandbox)\n",
"\n",
" try:\n",
" nw = swagger_client.SandboxAppInstancesApi(api)\n",
" result = nw.sandbox_app_instances_get(sandbox, async_req = False) # noqa: E501\n",
" logger.debug(\"get_applications_list: result: \" + str(result))\n",
" return result\n",
" except ApiException as e:\n",
" logger.error(\"Exception when calling SandboxAppInstancesApi->get_applications_list: %s\\n\" % e)\n",
"\n",
" return None \n",
" # End of function delete_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 identifier\n",
"- Check the demo application is present in the list of application\n",
"- Delete our application instance identifier\n",
"- Deactivate a network scenario\n",
"- Logout\n",
"- Check that logout is effective\n"
]
},
{
"cell_type": "code",
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"2024-07-05 10:09:55,221 - __main__ - DEBUG - Starting at 20240705-100955\n",
"2024-07-05 10:09:55,223 - __main__ - DEBUG - \t pwd= /home/yann/dev/jupyter/Sandbox/mecapp\n",
"2024-07-05 10:09:55,223 - __main__ - DEBUG - >>> process_login\n",
"2024-07-05 10:09:55,224 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",
"2024-07-05 10:09:55,395 DEBUG https://mec-platform.etsi.org:443 \"POST /sandbox-api/v1/login?provider=Jupyter2024 HTTP/1.1\" 404 21\n",
"2024-07-05 10:09:55,397 DEBUG response body: b'default backend - 404'\n",
"2024-07-05 10:09:55,400 - __main__ - ERROR - Exception when calling AuthorizationApi->login: (404)\n",
"Reason: Not Found\n",
"HTTP response headers: HTTPHeaderDict({'Date': 'Fri, 05 Jul 2024 08:09:55 GMT', 'Content-Type': 'text/plain; charset=utf-8', 'Content-Length': '21', 'Connection': 'keep-alive', 'Strict-Transport-Security': 'max-age=15724800; includeSubDomains'})\n",
"HTTP response body: b'default backend - 404'\n",
"\n",
"\n",
"2024-07-05 10:09:55,402 - __main__ - ERROR - Failed to instanciate a MEC Sandbox\n"
]
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"send: b'POST /sandbox-api/v1/login?provider=Jupyter2024 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",
"reply: 'HTTP/1.1 404 Not Found\\r\\n'\n",
"header: Date: Fri, 05 Jul 2024 08:09:55 GMT\n",
"header: Content-Type: text/plain; charset=utf-8\n",
"header: Content-Length: 21\n",
"header: Connection: keep-alive\n",
"header: Strict-Transport-Security: max-age=15724800; includeSubDomains\n"
]
}
],
"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 the demo application is present in the list of application\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",
" # Request for a new application instance identifier\n",
" app_inst_id = request_application_instance_id(sandbox)\n",
" if app_inst_id == None:\n",
" logger.error(\"Failed to request an application instance identifier\")\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 the demo application is present in the list of application\n",
" app_list = get_applications_list(sandbox)\n",
" if app_list is None:\n",
" logger.error(\"Failed to request the list of applications\")\n",
" else:\n",
" logger.info(app_list)\n",
" # Delete the application instance identifier\n",
" if delete_application_instance_id(sandbox, app_inst_id.id) == -1:\n",
" logger.error(\"Failed to delete the application instance identifier\")\n",
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
" 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",
"metadata": {},
"outputs": [],
"source": [
"def send_ready_confirmation(sandbox_name: str, app_inst_id: str) -> int:\n",
" global MEC_SANDBOX_URL, MEC_PLTF, logger\n",
"\n",
" try:\n",
" url = MEC_SANDBOX_URL + '/' + sandbox_name + '/' + 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",
" except ApiException as e:\n",
" logger.error(\"Exception when calling call_api: %s\\n\" % e)\n",
" return -1\n",
" # End of function send_ready_confirmation"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
"In addition, our MEC application is registering to "
]
},
{
"cell_type": "code",
"execution_count": 22,
"metadata": {},
"outputs": [],
"source": [
"def send_subscribe_termination(sandbox_name: str, app_inst_id: str) -> int:\n",
" global MEC_SANDBOX_URL, MEC_PLTF, logger\n",
"\n",
" try:\n",
" url = MEC_SANDBOX_URL + '/' + sandbox_name + '/' + MEC_PLTF + '/mec_app_support/v2/applications/' + app_inst_id + '/subscriptions'\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 = '{\\\"subscriptionType\\\":\\\"AppTerminationNotificationSubscription\\\",\\\"callbackReference\\\":\\\"' + subscribe_termination_callbacks + '\\\",\\\"_links\\\":null,\\\"appInstanceId\\\":\\\"' + app_inst_id + '\\\"}'\n",
" result = api.call_api(url, 'POST', header_params=header_params, body=body, async_req=False)\n",
" return 0\n",
" except ApiException as e:\n",
" logger.error(\"Exception when calling call_api: %s\\n\" % e)\n",
" return -1\n",
" # End of function send_ready_confirmation"