{ "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" ] }, { "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-sandbox_api/sandbox_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 sandbox_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-sandbox_api/sandbox_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-sandbox_api/sandbox_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", "execution_count": 1, "metadata": { "scrolled": true }, "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) Apply the python imports" ] }, { "cell_type": "code", "execution_count": 2, "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 re\n", "import logging\n", "import time\n", "import json\n", "import uuid\n", "\n", "import pprint\n", "\n", "import six\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) Initialize of the global constants (cell 3)" ] }, { "cell_type": "code", "execution_count": 3, "metadata": {}, "outputs": [], "source": [ "MEC_SANDBOX_URL = 'https://mec-platform2.etsi.org' # MEC Sandbox host/base URL\n", "MEC_SANDBOX_API_URL = 'https://mec-platform2.etsi.org/sandbox-api/v1' # MEC Sandbox API host/base URL\n", "PROVIDER = 'Jupyter2024' # Login provider value - To skip authorization: 'github'\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 = \"https://yanngarcia.ddns.net/jupyter/sandbox/demo6/v1/\"" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "4) Setup the logger instance and the HTTP REST API (cell 4)" ] }, { "cell_type": "code", "execution_count": 4, "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 to be used to send request to MEC Sandbox API \n", "configuration = swagger_client.Configuration()\n", "configuration.host = MEC_SANDBOX_API_URL\n", "configuration.verify_ssl = False\n", "configuration.debug = True\n", "configuration.logger_format = LOGGER_FORMAT\n", "# Create an instance of ApiClient\n", "sandbox_api = swagger_client.ApiClient(configuration, 'Content-Type', 'application/json')\n", "\n", "# Setup the HTTP REST API configuration to be used to send request to MEC Services\n", "configuration1 = swagger_client.Configuration()\n", "configuration1.host = MEC_SANDBOX_URL\n", "configuration1.verify_ssl = True\n", "configuration1.debug = True\n", "configuration1.logger_format = LOGGER_FORMAT\n", "# Create an instance of ApiClient\n", "service_api = swagger_client.ApiClient(configuration1, 'Content-Type', 'application/json')\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "5) Setup the global variables (cell 5)" ] }, { "cell_type": "code", "execution_count": 5, "metadata": {}, "outputs": [], "source": [ "# 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" ] }, { "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": {}, "source": [ "#### The login function\n", "\n", "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-sandbox_api/v1/login?provide=github' (see PROVIDER constant).\n" ] }, { "cell_type": "code", "execution_count": 6, "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", " \"\"\" \n", "\n", " global PROVIDER, logger\n", "\n", " logger.debug('>>> process_login')\n", "\n", " try:\n", " auth = swagger_client.AuthorizationApi(sandbox_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-sandbox_api/v1/logout?sandbox_name={sandbox_name}'.\n" ] }, { "cell_type": "code", "execution_count": 7, "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 logger\n", "\n", " logger.debug('>>> process_logout: sandbox=' + sandbox)\n", "\n", " try:\n", " auth = swagger_client.AuthorizationApi(sandbox_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, "metadata": {}, "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 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", " # Wait for the MEC Sandbox is running\n", " time.sleep(STABLE_TIME_OUT) # Wait for k8s pods up and running\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": [ "### 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-sandbox_api/v1/sandboxNetworkScenarios?sandbox_name={sandbox_name}'." ] }, { "cell_type": "code", "execution_count": 8, "metadata": {}, "outputs": [], "source": [ "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, logger, configuration\n", "\n", " logger.debug('>>> get_network_scenarios: sandbox=' + sandbox)\n", "\n", " try:\n", " nw = swagger_client.SandboxNetworkScenariosApi(sandbox_api)\n", " result = nw.sandbox_network_scenarios_get(sandbox, async_req = False) # noqa: E501\n", " 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 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", " # Wait for the MEC Sandbox is running\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", " 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": 9, "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": 10, "metadata": {}, "outputs": [], "source": [ "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 logger, configuration, nw_scenarios, nw_scenario_idx\n", "\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(sandbox_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": 11, "metadata": {}, "outputs": [], "source": [ "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", "\n", " logger.debug('>>> deactivate_network_scenario: ' + sandbox)\n", "\n", " try:\n", " nw = swagger_client.SandboxNetworkScenariosApi(sandbox_api)\n", " result = nw.sandbox_network_scenario_delete(sandbox, nw_scenarios[nw_scenario_idx].id, async_req = False) # noqa: E501\n", " 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 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", " # Wait for the MEC Sandbox is running\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", " # 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(30) # Sleep for 30 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", "execution_count": 12, "metadata": {}, "outputs": [], "source": [ "def request_application_instance_id(sandbox: str) -> swagger_client.models.ApplicationInfo:\n", " \"\"\"\n", " \"\"\"\n", "\n", " global MEC_PLTF, logger, configuration\n", "\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(sandbox_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" ] }, { "cell_type": "code", "execution_count": 13, "metadata": {}, "outputs": [], "source": [ "def delete_application_instance_id(sandbox: str, id: str) -> int:\n", " \"\"\"\n", " \"\"\"\n", "\n", " global logger, configuration\n", "\n", " logger.debug('>>> delete_application_instance_id: ' + sandbox)\n", " logger.debug('>>> delete_application_instance_id: ' + id)\n", "\n", " try:\n", " nw = swagger_client.SandboxAppInstancesApi(sandbox_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" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "#### Getting the list of applications" ] }, { "cell_type": "code", "execution_count": 14, "metadata": {}, "outputs": [], "source": [ "def get_applications_list(sandbox: str) -> list:\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(sandbox_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", "- Retrieve the list of the applications instance identifier\n", "- Check the demo application is present in the list of applications\n", "- Delete our application instance identifier\n", "- Deactivate a network scenario\n", "- Logout\n", "- Check that logout is effective\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", " - Request for a new application instance identifier\n", " - Retrieve the list of the applications instance identifier\n", " - Check the demo application is present in the list of applications\n", " - Deactivate a network scenario\n", " - Logout\n", " - Check that logout is effective\n", " \"\"\" \n", " global 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", " # Wait for the MEC Sandbox is running\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 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 applications\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: %s', str(type(app_list)))\n", " logger.info('app_list: %s', str(app_list))\n", " # Check if our application is present in the list of applications\n", " found = False\n", " for item in app_list:\n", " if item.id == app_inst_id.id:\n", " found = True\n", " break\n", " if not found:\n", " logger.error('Failed to retrieve our application instance identifier')\n", "\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", " 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" ] }, { "cell_type": "code", "execution_count": 15, "metadata": {}, "outputs": [], "source": [ "def send_ready_confirmation(sandbox_name: str, app_inst_id: swagger_client.models.application_info.ApplicationInfo) -> int:\n", " global MEC_PLTF, logger\n", "\n", " logger.debug('>>> send_ready_confirmation: ' + app_inst_id.id)\n", " try:\n", " url = '/' + sandbox_name + '/' + MEC_PLTF + '/mec_app_support/v2/applications/' + app_inst_id.id + '/confirm_ready'\n", " logger.debug('send_ready_confirmation: url: ' + url)\n", " header_params = {}\n", " # HTTP header `Accept`\n", " header_params['Accept'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " # HTTP header `Content-Type`\n", " header_params['Content-Type'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " # JSON indication READY\n", " dict_body = {}\n", " dict_body['indication'] = 'READY'\n", " body = json.dumps(dict_body)\n", " logger.debug('send_ready_confirmation: body: ' + body)\n", " result = service_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": "markdown", "metadata": {}, "source": [ "In addition, our MEC application is registering to AppTerminationNotificationSubscription and it needs to delete its subscription when terminating.\n", "\n", "At this stage, it os important to note that all subscription deletion use the same format: / (see ETSI MEC GS 003 [16]). \n", "In this case, it the AppTerminationNotificationSubscription is 'sub-1234', the URIs to do the susbscription and to delete it are:\n", "- MEC_SANDBOX_URL + '/' + sandbox_name + '/' + MEC_PLTF + '/mec_app_support/v2/applications/' + app_inst_id + '/subscriptions'\n", "- MEC_SANDBOX_URL + '/' + sandbox_name + '/' + MEC_PLTF + '/mec_app_support/v2/applications/' + app_inst_id + '/subscriptions/sub-1234'\n", "\n", "So, it will be usefull to create a small function to extract the subscription identifier from either the HTTP Location header or from the Link field found into the reponse body data structure. " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "#### Subscribing to application termination" ] }, { "cell_type": "code", "execution_count": 16, "metadata": {}, "outputs": [], "source": [ "def send_subscribe_termination(sandbox_name: str, app_inst_id: swagger_client.models.application_info.ApplicationInfo) -> int:\n", " global MEC_PLTF, logger\n", "\n", " logger.debug('>>> send_subscribe_termination: ' + app_inst_id.id)\n", " try:\n", " url = '/' + sandbox_name + '/' + MEC_PLTF + '/mec_app_support/v2/applications/' + app_inst_id.id + '/subscriptions'\n", " logger.debug('send_subscribe_termination: url: ' + url)\n", " header_params = {}\n", " # HTTP header `Accept`\n", " header_params['Accept'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " # HTTP header `Content-Type`\n", " header_params['Content-Type'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " # Body\n", " dict_body = {}\n", " dict_body['subscriptionType'] = 'AppTerminationNotificationSubscription'\n", " dict_body['callbackReference'] = 'http://yanngarcia.ddns.net/mec011/v2/termination' # FIXME To be parameterized\n", " dict_body['appInstanceId'] = app_inst_id.id\n", " body = json.dumps(dict_body)\n", " logger.debug('send_subscribe_termination: body: ' + str(body))\n", " (result, status, headers) = service_api.call_api(url, 'POST', header_params=header_params, body=str(body), async_req=False)\n", " logger.debug('send_subscribe_termination: headers: ' + str(headers))\n", " return extract_sub_id(url, headers['Location'])\n", " except ApiException as e:\n", " logger.error('Exception when calling call_api: %s\\n' % e)\n", " return None\n", " # End of function send_subscribe_termination" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "#### Extracting subscription identifier" ] }, { "cell_type": "code", "execution_count": 17, "metadata": {}, "outputs": [], "source": [ "def extract_sub_id(base_url: str, resource_url: str) -> str:\n", " global logger\n", "\n", " logger.debug('>>> extract_sub_id: base_url: ' + base_url)\n", " logger.debug('>>> extract_sub_id: resource_url: ' + resource_url)\n", "\n", " e = re.compile(re.escape(base_url) + '/(?P.*)', re.DOTALL | re.VERBOSE)\n", " m = e.match(resource_url)\n", " if m:\n", " if m.groupdict() != None:\n", " if 'sub_id' in m.groupdict():\n", " return m.groupdict()['sub_id']\n", "\n", " return None\n", " # End of function extract_sub_id" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "#### Delete subscription to application termination" ] }, { "cell_type": "code", "execution_count": 18, "metadata": {}, "outputs": [], "source": [ "def delete_subscribe_termination(sandbox_name: str, app_inst_id: swagger_client.models.application_info.ApplicationInfo, sub_id: str) -> int:\n", " global MEC_PLTF, logger\n", "\n", " logger.debug('>>> delete_subscribe_termination: ' + app_inst_id.id)\n", " try:\n", " url = '/' + sandbox_name + '/' + MEC_PLTF + '/mec_app_support/v2/applications/' + app_inst_id.id + '/subscriptions/' + sub_id\n", " logger.debug('delete_subscribe_termination: url: ' + url)\n", " header_params = {}\n", " # HTTP header `Accept`\n", " header_params['Accept'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " # HTTP header `Content-Type`\n", " header_params['Content-Type'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " service_api.call_api(url, 'DELETE', header_params=header_params, 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 delete_subscribe_termination" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Now, 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", "- Send READY confirmation\n", "- Subscribe to AppTerminationNotificationSubscription\n", "- Check list of services\n", "- Delete AppTerminationNotification subscription\n", "- Delete our application instance identifier\n", "- Deactivate a network scenario\n", "- Logout\n", "- Check that logout is effective\n" ] }, { "cell_type": "code", "execution_count": 19, "metadata": {}, "outputs": [ { "name": "stderr", "output_type": "stream", "text": [ "2024-09-26 18:39:25,473 - __main__ - DEBUG - Starting at 20240926-183925\n", "2024-09-26 18:39:25,474 - __main__ - DEBUG - \t pwd= /home/yann/dev/jupyter/Sandbox/mecapp\n", "2024-09-26 18:39:25,475 - __main__ - DEBUG - >>> process_login\n", "2024-09-26 18:39:25,476 DEBUG Starting new HTTPS connection (1): mec-platform2.etsi.org:443\n", "/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform2.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-09-26 18:39:25,684 DEBUG https://mec-platform2.etsi.org:443 \"POST /sandbox-api/v1/login?provider=Jupyter2024 HTTP/1.1\" 201 48\n", "2024-09-26 18:39:25,686 DEBUG response body: b'{\"user_code\":\"sbx292dvej\",\"verification_uri\":\"\"}'\n", "2024-09-26 18:39:25,687 - __main__ - DEBUG - process_login (step1): oauth: {'user_code': 'sbx292dvej', 'verification_uri': ''}\n", "2024-09-26 18:39:25,688 - __main__ - DEBUG - =======================> DO AUTHORIZATION WITH CODE : sbx292dvej\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "send: b'POST /sandbox-api/v1/login?provider=Jupyter2024 HTTP/1.1\\r\\nHost: mec-platform2.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 201 Created\\r\\n'\n", "header: Date: Thu, 26 Sep 2024 16:39:24 GMT\n", "header: Content-Type: application/json; charset=UTF-8\n", "header: Content-Length: 48\n", "header: Connection: keep-alive\n", "header: Strict-Transport-Security: max-age=15724800; includeSubDomains\n" ] }, { "name": "stderr", "output_type": "stream", "text": [ "/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform2.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-09-26 18:39:28,718 DEBUG https://mec-platform2.etsi.org:443 \"GET /sandbox-api/v1/namespace?user_code=sbx292dvej HTTP/1.1\" 200 29\n", "2024-09-26 18:39:28,719 DEBUG response body: b'{\"sandbox_name\":\"sbx292dvej\"}'\n", "2024-09-26 18:39:28,721 - __main__ - DEBUG - process_login (step2): result: {'sandbox_name': 'sbx292dvej'}\n", "2024-09-26 18:39:28,724 - __main__ - INFO - Sandbox created: sbx292dvej\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "send: b'GET /sandbox-api/v1/namespace?user_code=sbx292dvej HTTP/1.1\\r\\nHost: mec-platform2.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: Thu, 26 Sep 2024 16:39:27 GMT\n", "header: Content-Type: application/json; charset=UTF-8\n", "header: Content-Length: 29\n", "header: Connection: keep-alive\n", "header: Strict-Transport-Security: max-age=15724800; includeSubDomains\n" ] }, { "name": "stderr", "output_type": "stream", "text": [ "2024-09-26 18:39:34,732 - __main__ - DEBUG - >>> get_network_scenarios: sandbox=sbx292dvej\n", "2024-09-26 18:39:34,735 DEBUG Resetting dropped connection: mec-platform2.etsi.org\n", "/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform2.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-09-26 18:39:34,939 DEBUG https://mec-platform2.etsi.org:443 \"GET /sandbox-api/v1/sandboxNetworkScenarios?sandbox_name=sbx292dvej HTTP/1.1\" 200 157\n", "2024-09-26 18:39:34,941 DEBUG response body: b'[{\"id\":\"4g-5g-macro-v2x\"},{\"id\":\"4g-5g-wifi-macro\"},{\"id\":\"4g-macro\"},{\"id\":\"4g-wifi-macro\"},{\"id\":\"dual-mep-4g-5g-wifi-macro\"},{\"id\":\"dual-mep-short-path\"}]'\n", "2024-09-26 18:39:34,944 - __main__ - DEBUG - get_network_scenarios: result: [{'id': '4g-5g-macro-v2x'}, {'id': '4g-5g-wifi-macro'}, {'id': '4g-macro'}, {'id': '4g-wifi-macro'}, {'id': 'dual-mep-4g-5g-wifi-macro'}, {'id': 'dual-mep-short-path'}]\n", "2024-09-26 18:39:34,945 - __main__ - INFO - nw_scenarios: \n", "2024-09-26 18:39:34,947 - __main__ - INFO - nw_scenarios: [{'id': '4g-5g-macro-v2x'}, {'id': '4g-5g-wifi-macro'}, {'id': '4g-macro'}, {'id': '4g-wifi-macro'}, {'id': 'dual-mep-4g-5g-wifi-macro'}, {'id': 'dual-mep-short-path'}]\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "send: b'GET /sandbox-api/v1/sandboxNetworkScenarios?sandbox_name=sbx292dvej HTTP/1.1\\r\\nHost: mec-platform2.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: Thu, 26 Sep 2024 16:39:33 GMT\n", "header: Content-Type: application/json; charset=UTF-8\n", "header: Content-Length: 157\n", "header: Connection: keep-alive\n", "header: Strict-Transport-Security: max-age=15724800; includeSubDomains\n" ] }, { "name": "stderr", "output_type": "stream", "text": [ "2024-09-26 18:39:40,954 - __main__ - DEBUG - >>> activate_network_scenario: sbx292dvej\n", "/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform2.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-09-26 18:39:41,033 DEBUG https://mec-platform2.etsi.org:443 \"POST /sandbox-api/v1/sandboxNetworkScenarios/sbx292dvej?network_scenario_id=4g-5g-macro-v2x HTTP/1.1\" 204 0\n", "2024-09-26 18:39:41,034 DEBUG response body: b''\n", "2024-09-26 18:39:41,035 - __main__ - DEBUG - activate_network_scenario: result: None\n", "2024-09-26 18:39:41,036 - __main__ - INFO - Network scenario activated: 4g-5g-macro-v2x\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "send: b'POST /sandbox-api/v1/sandboxNetworkScenarios/sbx292dvej?network_scenario_id=4g-5g-macro-v2x HTTP/1.1\\r\\nHost: mec-platform2.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: Thu, 26 Sep 2024 16:39:40 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-09-26 18:39:47,043 - __main__ - DEBUG - >>> request_application_instance_id: sbx292dvej\n", "2024-09-26 18:39:47,047 DEBUG Resetting dropped connection: mec-platform2.etsi.org\n", "/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform2.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": [ "{'id': '35576902-5303-454e-afc5-c5d81f3df077',\n", " 'name': 'JupyterMecApp',\n", " 'node_name': 'mep1',\n", " 'persist': None,\n", " 'type': 'USER'}\n", "send: b'POST /sandbox-api/v1/sandboxAppInstances/sbx292dvej HTTP/1.1\\r\\nHost: mec-platform2.etsi.org\\r\\nAccept-Encoding: identity\\r\\nContent-Length: 107\\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'{\"id\": \"35576902-5303-454e-afc5-c5d81f3df077\", \"name\": \"JupyterMecApp\", \"nodeName\": \"mep1\", \"type\": \"USER\"}'\n" ] }, { "name": "stderr", "output_type": "stream", "text": [ "2024-09-26 18:39:47,290 DEBUG https://mec-platform2.etsi.org:443 \"POST /sandbox-api/v1/sandboxAppInstances/sbx292dvej HTTP/1.1\" 201 100\n", "2024-09-26 18:39:47,292 DEBUG response body: b'{\"id\":\"35576902-5303-454e-afc5-c5d81f3df077\",\"name\":\"JupyterMecApp\",\"nodeName\":\"mep1\",\"type\":\"USER\"}'\n", "2024-09-26 18:39:47,295 - __main__ - DEBUG - request_application_instance_id: result: {'id': '35576902-5303-454e-afc5-c5d81f3df077',\n", " 'name': 'JupyterMecApp',\n", " 'node_name': 'mep1',\n", " 'persist': None,\n", " 'type': 'USER'}\n", "2024-09-26 18:39:47,297 - __main__ - INFO - app_inst_id: {'id': '35576902-5303-454e-afc5-c5d81f3df077',\n", " 'name': 'JupyterMecApp',\n", " 'node_name': 'mep1',\n", " 'persist': None,\n", " 'type': 'USER'}\n", "2024-09-26 18:39:47,299 - __main__ - INFO - >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n", "2024-09-26 18:39:47,301 - __main__ - DEBUG - >>> send_ready_confirmation: 35576902-5303-454e-afc5-c5d81f3df077\n", "2024-09-26 18:39:47,303 - __main__ - DEBUG - send_ready_confirmation: url: /sbx292dvej/mep1/mec_app_support/v2/applications/35576902-5303-454e-afc5-c5d81f3df077/confirm_ready\n", "2024-09-26 18:39:47,305 - __main__ - DEBUG - send_ready_confirmation: body: {\"indication\": \"READY\"}\n", "2024-09-26 18:39:47,311 DEBUG Starting new HTTPS connection (1): mec-platform2.etsi.org:443\n", "2024-09-26 18:39:47,427 DEBUG https://mec-platform2.etsi.org:443 \"POST /sbx292dvej/mep1/mec_app_support/v2/applications/35576902-5303-454e-afc5-c5d81f3df077/confirm_ready HTTP/1.1\" 401 172\n", "2024-09-26 18:39:47,428 DEBUG response body: b'\\r\\n401 Authorization Required\\r\\n\\r\\n

401 Authorization Required

\\r\\n
nginx
\\r\\n\\r\\n\\r\\n'\n", "2024-09-26 18:39:47,429 - __main__ - ERROR - Exception when calling call_api: (401)\n", "Reason: Unauthorized\n", "HTTP response headers: HTTPHeaderDict({'Date': 'Thu, 26 Sep 2024 16:39:46 GMT', 'Content-Type': 'text/html', 'Content-Length': '172', 'Connection': 'keep-alive', 'Strict-Transport-Security': 'max-age=15724800; includeSubDomains'})\n", "HTTP response body: b'\\r\\n401 Authorization Required\\r\\n\\r\\n

401 Authorization Required

\\r\\n
nginx
\\r\\n\\r\\n\\r\\n'\n", "\n", "\n", "2024-09-26 18:39:47,429 - __main__ - ERROR - Failed to send confirm_ready\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "reply: 'HTTP/1.1 201 Created\\r\\n'\n", "header: Date: Thu, 26 Sep 2024 16:39:46 GMT\n", "header: Content-Type: application/json; charset=UTF-8\n", "header: Content-Length: 100\n", "header: Connection: keep-alive\n", "header: Strict-Transport-Security: max-age=15724800; includeSubDomains\n", "send: b'POST /sbx292dvej/mep1/mec_app_support/v2/applications/35576902-5303-454e-afc5-c5d81f3df077/confirm_ready HTTP/1.1\\r\\nHost: mec-platform2.etsi.org\\r\\nAccept-Encoding: identity\\r\\nContent-Length: 29\\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'\"{\\\\\"indication\\\\\": \\\\\"READY\\\\\"}\"'\n", "reply: 'HTTP/1.1 401 Unauthorized\\r\\n'\n", "header: Date: Thu, 26 Sep 2024 16:39:46 GMT\n", "header: Content-Type: text/html\n", "header: Content-Length: 172\n", "header: Connection: keep-alive\n", "header: Strict-Transport-Security: max-age=15724800; includeSubDomains\n" ] }, { "name": "stderr", "output_type": "stream", "text": [ "2024-09-26 18:39:53,435 - __main__ - INFO - ***************************************************************************************\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "curl --verbose -X POST \"https://mec-platform2.etsi.org/sbx292dvej/mep1/mec_app_support/v2/applications/35576902-5303-454e-afc5-c5d81f3df077/confirm_ready\" -H\"Accept: application/json\" -H\"Content-Type: application/json\" -d\"{\\\"indication\\\": \\\"READY\\\"}\"\n" ] }, { "name": "stderr", "output_type": "stream", "text": [ "2024-09-26 18:40:53,497 - __main__ - INFO - ***************************************************************************************\n", "2024-09-26 18:40:53,499 - __main__ - DEBUG - >>> delete_application_instance_id: sbx292dvej\n", "2024-09-26 18:40:53,501 - __main__ - DEBUG - >>> delete_application_instance_id: 35576902-5303-454e-afc5-c5d81f3df077\n", "2024-09-26 18:40:53,504 DEBUG Resetting dropped connection: mec-platform2.etsi.org\n", "/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform2.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-09-26 18:40:53,691 DEBUG https://mec-platform2.etsi.org:443 \"DELETE /sandbox-api/v1/sandboxAppInstances/sbx292dvej/35576902-5303-454e-afc5-c5d81f3df077 HTTP/1.1\" 204 0\n", "2024-09-26 18:40:53,693 DEBUG response body: b''\n", "2024-09-26 18:40:53,695 - __main__ - DEBUG - delete_application_instance_id: result: None\n", "2024-09-26 18:40:53,697 - __main__ - INFO - app_inst_id deleted: 35576902-5303-454e-afc5-c5d81f3df077\n", "2024-09-26 18:40:53,699 - __main__ - DEBUG - >>> deactivate_network_scenario: sbx292dvej\n", "/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform2.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-09-26 18:40:53,737 DEBUG https://mec-platform2.etsi.org:443 \"DELETE /sandbox-api/v1/sandboxNetworkScenarios/sbx292dvej/4g-5g-macro-v2x HTTP/1.1\" 204 0\n", "2024-09-26 18:40:53,738 DEBUG response body: b''\n", "2024-09-26 18:40:53,739 - __main__ - DEBUG - deactivate_network_scenario: result: None\n", "2024-09-26 18:40:53,740 - __main__ - INFO - Network scenario deactivated: 4g-5g-macro-v2x\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "send: b'DELETE /sandbox-api/v1/sandboxAppInstances/sbx292dvej/35576902-5303-454e-afc5-c5d81f3df077 HTTP/1.1\\r\\nHost: mec-platform2.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: Thu, 26 Sep 2024 16:40:52 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", "send: b'DELETE /sandbox-api/v1/sandboxNetworkScenarios/sbx292dvej/4g-5g-macro-v2x HTTP/1.1\\r\\nHost: mec-platform2.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: Thu, 26 Sep 2024 16:40:52 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-09-26 18:40:59,747 - __main__ - DEBUG - >>> process_logout: sandbox=sbx292dvej\n", "2024-09-26 18:40:59,750 DEBUG Resetting dropped connection: mec-platform2.etsi.org\n", "/usr/lib/python3/dist-packages/urllib3/connectionpool.py:1020: InsecureRequestWarning: Unverified HTTPS request is being made to host 'mec-platform2.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-09-26 18:40:59,885 DEBUG https://mec-platform2.etsi.org:443 \"POST /sandbox-api/v1/logout?sandbox_name=sbx292dvej HTTP/1.1\" 204 0\n", "2024-09-26 18:40:59,886 DEBUG response body: b''\n", "2024-09-26 18:40:59,886 - __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-09-26 18:40:59,887 - __main__ - DEBUG - Stopped at 20240926-184059\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "send: b'POST /sandbox-api/v1/logout?sandbox_name=sbx292dvej HTTP/1.1\\r\\nHost: mec-platform2.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: Thu, 26 Sep 2024 16:40:58 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 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", " - Request for a new application instance identifier\n", " - Send READY confirmation\n", " \n", " - Subscribe to AppTermination Notification\n", " - Send Termination\n", " - Delete AppTerminationNotification subscription\n", " - Delete our application instance identifier\n", " - Deactivate a network scenario\n", " - Logout\n", " - Check that logout is effective\n", " \"\"\" \n", " global 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", " # Wait for the MEC Sandbox is running\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 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(app_inst_id))\n", "\n", " # Send READY confirmation\n", " logger.info('>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>')\n", " sub_id = None\n", " if send_ready_confirmation(sandbox, app_inst_id) == -1:\n", " logger.error('Failed to send confirm_ready')\n", " else:\n", " # Subscribe to AppTerminationNotificationSubscription\n", " sub_id = send_subscribe_termination(sandbox, app_inst_id)\n", " if sub_id == None:\n", " logger.error('Failed to do the subscription')\n", " else:\n", " logger.info('sub_id: %s', sub_id)\n", "\n", " # Any processing here\n", " time.sleep(STABLE_TIME_OUT)\n", " logger.info('***************************************************************************************')\n", " print('curl --verbose -X POST \"https://mec-platform2.etsi.org/'+ sandbox + '/mep1/mec_app_support/v2/applications/' + app_inst_id.id + '/confirm_ready\" -H\"Accept: application/json\" -H\"Content-Type: application/json\" -d\"{\\\\\"indication\\\\\": \\\\\"READY\\\\\"}\"')\n", " time.sleep(60) # Sleep for 30 seconds\n", " logger.info('***************************************************************************************')\n", "\n", " # Delete AppTerminationNotification subscription\n", " if sub_id is not None:\n", " if delete_subscribe_termination(sandbox, app_inst_id, sub_id) == -1:\n", " logger.error('Failed to delete the application instance identifier')\n", " else:\n", " logger.info('app_inst_id deleted: ' + app_inst_id.id)\n", "\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", " 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": [ "### Conclusion: Create two procedures for the setup and the termination of our MEC application\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "#### The procedure for the setup of a MEC application\n", "\n", "This function provides the steps to setup a MEC application and to be ready to use the MEC service exposed by the created MEC Sandbox.\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "def mec_app_setup():\n", " \"\"\"\n", " This function provides the steps to setup a MEC application:\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", " - Send READY confirmation\n", " - Subscribe to AppTermination Notification\n", " \"\"\"\n", " global logger, nw_scenarios\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", " # Wait for the MEC Sandbox is running\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 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", " # Send READY confirmation\n", " sub_id = None\n", " if send_ready_confirmation(sandbox, app_inst_id) == -1:\n", " logger.error('Failed to send confirm_ready')\n", " else:\n", " # Subscribe to AppTerminationNotificationSubscription\n", " sub_id = send_subscribe_termination(sandbox, app_inst_id)\n", " if sub_id == None:\n", " logger.error('Failed to do the subscription')\n", " else:\n", " logger.info('sub_id: %s', sub_id)\n", "\n", " # Subscribe to AppTerminationNotificationSubscription\n", " sub_id = send_subscribe_termination(sandbox, app_inst_id)\n", " if sub_id == None:\n", " logger.error('Failed to do the subscription')\n", " else:\n", " logger.info('sub_id: %s', sub_id)\n", "\n", " return (sandbox, app_inst_id, sub_id)\n", " # End of function mec_app_setup" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "#### The procedure for the termination of a MEC application\n", "\n", "This function provide the steps to terminate a MEC application.\n", "\n", "NOTE: All subscriptions done outsid to the mec_app_setup function are not deleted." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "def mec_app_termination(sandbox: str, app_inst_id:swagger_client.models.ApplicationInfo, sub_id: str):\n", " \"\"\"\n", " This function provides the steps to setup a MEC application:\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", " - Send READY confirmation\n", " - Subscribe to AppTermination Notification\n", " \"\"\"\n", " # Delete AppTerminationNotification subscription\n", " if sub_id is not None:\n", " if delete_subscribe_termination(sandbox, app_inst_id, sub_id) == -1:\n", " logger.error('Failed to delete the application instance identifier')\n", " else:\n", " logger.info('app_inst_id deleted: ' + app_inst_id.id)\n", "\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", " 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", " # End of function mec_app_termination" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Create our second MEC application: how to use MEC Services\n", "\n", "After doing the logging, network scenario activation, MEC appliction instance creation steps, we are ready to exploit the MEC services exposed by the MEC Sandbox.\n", "\n", "In this clause, we use the following functionalities provided by MEC-030:\n", "- Getting UU unicast provisioning information (ETSI GS MEC 030 Clause 5.5.1)\n", "- Subscribe to V2X message distribution server (ETSI GS MEC 030 Clause 5.5.7)\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Getting UU unicast provisioning information\n", "\n", "The purpose is to query provisioning information for V2X communication over Uu unicast." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "def send_uu_unicast_provisioning_info(sandbox_name: str, ecgi: str) -> int:\n", " global MEC_SANDBOX_URL, MEC_PLTF, logger\n", "\n", " try:\n", " url = MEC_SANDBOX_URL + '/' + sandbox_name + '/' + MEC_PLTF + '/vis/v2/queries/uu_unicast_provisioning_info?location_info=ecgi,' + ecgi\n", " logger.debug('send_uu_unicast_provisioning_info: url: ' + url)\n", " header_params = {}\n", " # HTTP header `Accept`\n", " header_params['Accept'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " # HTTP header `Content-Type`\n", " header_params['Content-Type'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " result = service_api.call_api(url, 'POST', header_params=header_params, async_req=False)\n", " logger.debug('send_uu_unicast_provisioning_info: result\" + result)\n", " return result\n", " except ApiException as e:\n", " logger.error('Exception when calling call_api: %s\\n' % e)\n", " return Node\n", " # End of function send_uu_unicast_provisioning_info" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "let's create the our second MEC application.\n", "The sequence is the following:\n", "- Mec application setup\n", "- Get UU unicast provisioning information\n", "- Mec application termination" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "def process_main():\n", " \"\"\"\n", " This is the second sprint of our skeleton of our MEC application:\n", " - Mec application setup\n", " - Get UU unicast provisioning information\n", " - Mec application termination\n", " \"\"\" \n", " global 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, app_inst_id, sub_id) = mec_app_setup()\n", "\n", " ecgi = \"268708941961,268711972264\" # List of ecgi spearated by a ','\n", " result = send_uu_unicast_provisioning_info(sandbox_name, ecgi)\n", " if result is None:\n", " logger.error('Failed to get UU unicast provisioning information')\n", " else:\n", " logger.info('UU unicast provisioning information: \", result)\n", "\n", " mec_app_termination(sandbox, app_inst_id, sub_id)\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": [ "### Subscribing to V2X message distribution server\n", "\n", "Here, we need to come back to the MEC 030 standard to create the type V2xMsgSubscription. It involves the creation of a set of basic types described below.\n", "\n", "Note: These new type shall be 'JSON\"serializable. It means that they have to implement the following methods:\n", "```python\n", "to_dict()\n", "to_str()\n", "__repr__()\n", "__eq__()\n", "__ne__()\n", "```\n", "`\r\n", "}\r\n", "\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "class LinkType(object):\n", " swagger_types = {'href': 'str'}\n", " attribute_map = {'href': 'href'}\n", " def __init__(self, href=None): # noqa: E501\n", " self._href = href\n", " @property\n", " def href(self):\n", " return self._href\n", " @href.setter\n", " def href(self, href):\n", " self._href = href\n", " def to_dict(self):\n", " result = {}\n", " for attr, _ in six.iteritems(self.swagger_types):\n", " value = getattr(self, attr)\n", " if isinstance(value, list):\n", " result[attr] = list(map(\n", " lambda x: x.to_dict() if hasattr(x, \"to_dict') else x,\n", " value\n", " ))\n", " elif hasattr(value, \"to_dict'):\n", " result[attr] = value.to_dict()\n", " elif isinstance(value, dict):\n", " result[attr] = dict(map(\n", " lambda item: (item[0], item[1].to_dict())\n", " if hasattr(item[1], \"to_dict') else item,\n", " value.items()\n", " ))\n", " else:\n", " result[attr] = value\n", " if issubclass(LinkType, dict):\n", " for key, value in self.items():\n", " result[key] = value\n", " return result\n", " def to_str(self):\n", " return pprint.pformat(self.to_dict())\n", " def __repr__(self):\n", " return self.to_str()\n", " def __eq__(self, other):\n", " if not isinstance(other, LinkType):\n", " return False\n", " return self.__dict__ == other.__dict__\n", " def __ne__(self, other):\n", " return not self == other\n", "\n", "class Links(object):\n", " swagger_types = {'self': 'LinkType'}\n", " attribute_map = {'self': 'self'}\n", " def __init__(self, self_=None): # noqa: E501\n", " self._self = self_\n", " @property\n", " def self_(self):\n", " return self._self\n", " @self_.setter\n", " def self_(self, self_):\n", " self._self = self_\n", " def to_dict(self):\n", " result = {}\n", " for attr, _ in six.iteritems(self.swagger_types):\n", " value = getattr(self, attr)\n", " if isinstance(value, list):\n", " result[attr] = list(map(\n", " lambda x: x.to_dict() if hasattr(x, \"to_dict') else x,\n", " value\n", " ))\n", " elif hasattr(value, \"to_dict'):\n", " result[attr] = value.to_dict()\n", " elif isinstance(value, dict):\n", " result[attr] = dict(map(\n", " lambda item: (item[0], item[1].to_dict())\n", " if hasattr(item[1], \"to_dict') else item,\n", " value.items()\n", " ))\n", " else:\n", " result[attr] = value\n", " if issubclass(Links, dict):\n", " for key, value in self.items():\n", " result[key] = value\n", " return result\n", " def to_str(self):\n", " return pprint.pformat(self.to_dict())\n", " def __repr__(self):\n", " return self.to_str()\n", " def __eq__(self, other):\n", " if not isinstance(other, Links):\n", " return False\n", " return self.__dict__ == other.__dict__\n", " def __ne__(self, other):\n", " return not self == other\n", "\n", "class TimeStamp(object):\n", " swagger_types = {'seconds': 'int', 'nano_seconds': 'int'}\n", " attribute_map = {'seconds': 'seconds', 'nano_seconds': 'nanoSeconds'}\n", " def __init__(self, seconds=None, nano_seconds=None): # noqa: E501\n", " self._seconds = seconds\n", " self._nano_seconds = nano_seconds\n", " @property\n", " def seconds(self):\n", " return self._seconds\n", " @seconds.setter\n", " def seconds(self, seconds):\n", " self._seconds = seconds\n", " @property\n", " def nano_seconds(self):\n", " return self._nano_seconds\n", " @nano_seconds.setter\n", " def nano_seconds(self, nano_seconds):\n", " self._nano_seconds = nano_seconds\n", " def to_dict(self):\n", " result = {}\n", " for attr, _ in six.iteritems(self.swagger_types):\n", " value = getattr(self, attr)\n", " if isinstance(value, list):\n", " result[attr] = list(map(\n", " lambda x: x.to_dict() if hasattr(x, \"to_dict') else x,\n", " value\n", " ))\n", " elif hasattr(value, \"to_dict'):\n", " result[attr] = value.to_dict()\n", " elif isinstance(value, dict):\n", " result[attr] = dict(map(\n", " lambda item: (item[0], item[1].to_dict())\n", " if hasattr(item[1], \"to_dict') else item,\n", " value.items()\n", " ))\n", " else:\n", " result[attr] = value\n", " if issubclass(TimeStamp, dict):\n", " for key, value in self.items():\n", " result[key] = value\n", " return result\n", " def to_str(self):\n", " return pprint.pformat(self.to_dict())\n", " def __repr__(self):\n", " return self.to_str()\n", " def __eq__(self, other):\n", " if not isinstance(other, TimeStamp):\n", " return False\n", " return self.__dict__ == other.__dict__\n", " def __ne__(self, other):\n", " return not self == other" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Subscribing to V2X message distribution server\n", "\n", "The cell bellow implements the V2xMsgSubscription data structure.\"`\r\n", "}\r\n", "\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "class V2xMsgSubscription(object):\n", " swagger_types = {'links': 'Links', 'callback_reference': 'str', 'filter_criteria': 'V2xMsgSubscriptionFilterCriteria', 'request_test_notification': 'bool', 'subscription_type': 'str'}\n", " attribute_map = {'links': 'Links', 'callback_reference': 'callbackReference', 'filter_criteria': 'filterCriteria', 'request_test_notification': 'requestTestNotification', 'subscription_type': 'subscriptionType'}\n", " def __init__(self, links=None, callback_reference=None, filter_criteria=None, request_test_notification=None): # noqa: E501\n", " self._links = None\n", " self._callback_reference = None\n", " self._filter_criteria = None\n", " self._request_test_notification = None\n", " self._subscription_type = \"V2xMsgSubscription\"\n", " if links is not None:\n", " self.links = links\n", " if callback_reference is not None:\n", " self.callback_reference = callback_reference\n", " if filter_criteria is not None:\n", " self.filter_criteria = filter_criteria\n", " if request_test_notification is not None:\n", " self.request_test_notification = request_test_notification\n", " @property\n", " def links(self):\n", " return self._links\n", " @links.setter\n", " def links(self, links):\n", " self_.links = links\n", " @property\n", " def callback_reference(self):\n", " return self._callback_reference\n", " @callback_reference.setter\n", " def callback_reference(self, callback_reference):\n", " self._callback_reference = callback_reference\n", " @property\n", " def links(self):\n", " return self._links\n", " @links.setter\n", " def links(self, links):\n", " self._links = links\n", " @property\n", " def filter_criteria(self):\n", " return self._filter_criteria\n", " @filter_criteria.setter\n", " def filter_criteria(self, filter_criteria):\n", " self._filter_criteria = filter_criteria\n", " @property\n", " def request_test_notification(self):\n", " return self._request_test_notification\n", " @request_test_notification.setter\n", " def request_test_notification(self, request_test_notification):\n", " self._request_test_notification = request_test_notification\n", " @property\n", " def subscription_type(self):\n", " return self._subscription_type\n", " def to_dict(self):\n", " result = {}\n", " for attr, _ in six.iteritems(self.swagger_types):\n", " value = getattr(self, attr)\n", " if isinstance(value, list):\n", " result[attr] = list(map(\n", " lambda x: x.to_dict() if hasattr(x, \"to_dict') else x,\n", " value\n", " ))\n", " elif hasattr(value, \"to_dict'):\n", " result[attr] = value.to_dict()\n", " elif isinstance(value, dict):\n", " result[attr] = dict(map(\n", " lambda item: (item[0], item[1].to_dict())\n", " if hasattr(item[1], \"to_dict') else item,\n", " value.items()\n", " ))\n", " else:\n", " result[attr] = value\n", " if issubclass(V2xMsgSubscription, dict):\n", " for key, value in self.items():\n", " result[key] = value\n", " return result\n", " def to_str(self):\n", " return pprint.pformat(self.to_dict())\n", " def __repr__(self):\n", " return self.to_str()\n", " def __eq__(self, other):\n", " if not isinstance(other, V2xMsgSubscription):\n", " return False\n", " return self.__dict__ == other.__dict__\n", " def __ne__(self, other):\n", " return not self == other\n", "\n", "class V2xMsgSubscriptionFilterCriteria(object):\n", " swagger_types = {'msg_type': 'list[str]', 'std_organization': 'str'}\n", " attribute_map = {'msg_type': 'MsgType', 'std_organization': 'stdOrganization'}\n", " def __init__(self, msg_type, std_organization): # noqa: E501\n", " self._msg_type = None\n", " self._std_organization = None\n", " self.msg_type = msg_type\n", " self.std_organization = std_organization\n", " @property\n", " def msg_type(self):\n", " return self._msg_type\n", " @msg_type.setter\n", " def msg_type(self, msg_type):\n", " self._msg_type = msg_type\n", " @property\n", " def std_organization(self):\n", " return self._std_organization\n", " @std_organization.setter\n", " def std_organization(self, std_organization):\n", " self._std_organization = std_organization\n", " def to_dict(self):\n", " result = {}\n", " for attr, _ in six.iteritems(self.swagger_types):\n", " value = getattr(self, attr)\n", " if isinstance(value, list):\n", " result[attr] = list(map(\n", " lambda x: x.to_dict() if hasattr(x, \"to_dict') else x,\n", " value\n", " ))\n", " elif hasattr(value, \"to_dict'):\n", " result[attr] = value.to_dict()\n", " elif isinstance(value, dict):\n", " result[attr] = dict(map(\n", " lambda item: (item[0], item[1].to_dict())\n", " if hasattr(item[1], \"to_dict') else item,\n", " value.items()\n", " ))\n", " else:\n", " result[attr] = value\n", " if issubclass(V2xMsgSubscriptionFilterCriteria, dict):\n", " for key, value in self.items():\n", " result[key] = value\n", " return result\n", " def to_str(self):\n", " return pprint.pformat(self.to_dict())\n", " def __repr__(self):\n", " return self.to_str()\n", " def __eq__(self, other):\n", " if not isinstance(other, V2xMsgSubscriptionFilterCriteria):\n", " return False\n", " return self.__dict__ == other.__dict__\n", " def __ne__(self, other):\n", " return not self == other" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Here is the V2X message subscription function. The body contains a 'JSON' serialized instance of the class V2xMsgSubscription." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "def subscribe_v2x_message(sandbox_name: str, v2xMsgSubscription: V2xMsgSubscription) -> int:\n", " global MEC_SANDBOX_URL, MEC_PLTF, CALLBACK_URI, logger\n", "\n", " try:\n", " url = MEC_SANDBOX_URL + '/' + sandbox_name + '/' + MEC_PLTF + '/vis/v2/subscriptions'\n", " logger.debug('subscribe_v2x_message: url: ' + url)\n", " header_params = {}\n", " # HTTP header `Accept`\n", " header_params['Accept'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " # HTTP header `Content-Type`\n", " header_params['Content-Type'] = service_api.select_header_accept(['application/json']) # noqa: E501\n", " # Subscription body\n", " body = json.dumps(v2xMsgSubscription.to_dict())\n", " logger.debug('subscribe_v2x_message: body: ' + body)\n", " (result, status, headers) = sandbox_api.call_api(url, 'POST', header_params=header_params, body=body, async_req=False)\n", " logger.debug('subscribe_v2x_message: result: ' + result)\n", " logger.debug('subscribe_v2x_message: status: ' + status)\n", " logger.debug('subscribe_v2x_message: headers: ' + headers)\n", " return (result, status, headers)\n", " except ApiException as e:\n", " logger.error('Exception when calling call_api: %s\\n' % e)\n", " return -1\n", " # End of function subscribe_v2x_message" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Finally, here is how to implement the V2XMessage subscription:" ] }, { "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", " - Mec application setup\n", " - Subscribe to V2XMessage\n", " - Mec application termination\n", " \"\"\" \n", " global MEC_SANDBOX_URL, MEC_PLTF, CALLBACK_URI, 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, app_inst_id, sub_id) = mec_app_setup()\n", "\n", " filter_criteria = V2xMsgSubscriptionFilterCriteria(['1', '2'], 'ETSI')\n", " v2xMsgSubscription = V2xMsgSubscription(callback_reference = CALLBACK_URI + '/vis/v2/v2x_msg_notification', filter_criteria = filter_criteria)\n", " result = subscribe_v2x_message(sandbox, v2xMsgSubscription)\n", " if result is None:\n", " logger.error('Failed to get UU unicast provisioning information')\n", " else:\n", " logger.info('UU unicast provisioning information: \", result)\n", "\n", " mec_app_termination(sandbox, app_inst_id, sub_id)\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": [ "### Notification support\n", "\n", "To recieve notifcation, our MEC application is required to support an HTTP listenener to recieve POST request from the MEC Sandbox and replto repry to them: this is the notification mechanism.\n", "\n", "The class HTTPRequestHandler (see cell below) provides the suport of such mechanism.\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "class HTTPRequestHandler(BaseHTTPRequestHandler):\n", "\n", " def do_POST(self):\n", " if re.search(CALLBACK_URI, self.path):\n", " ctype, pdict = _parse_header(self.headers.get('content-type'))\n", " if ctype == \"application/json\":\n", " length = int(self.headers.get('content-length'))\n", " rfile_str = self.rfile.read(length).decode('utf8')\n", " data = parse.parse_qs(rfile_str, keep_blank_values=True)\n", " record_id = self.path.split('/')[-1]\n", " LocalData.records[record_id] = data\n", " print('addrecord %s: %s' % (record_id, data))\n", " self.send_response(HTTPStatus.OK)\n", " else:\n", " self.send_response(HTTPStatus.BAD_REQUEST, 'Only application/json is supported')\n", " else:\n", " self.send_response(HTTPStatus.BAD_REQUEST, 'Unsupported URI')\n", " self.end_headers()\n", "\n", " def do_GET(self):\n", " self.send_response(HTTPStatus.BAD_REQUEST)\n", " self.end_headers()\n", " # End of class HTTPRequestHandler\n", "\n", "class LocalData(object):\n", " records = {}\n", " # End of class LocalData" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Put all together\n", "\n", "let's add a subscription the our previous MEC application.\n", "The sequence is the following:\n", "- Mec application setup\n", "- Get UU unicast provisioning information\n", "- Add subscription\n", "- Mec application termination" ] }, { "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", " - Mec application setup\n", " - Get UU unicast provisioning information\n", " - Add subscription\n", " - Mec application termination\n", " \"\"\" \n", " global 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, app_inst_id, sub_id) = mec_app_setup()\n", "\n", " ecgi = \"268708941961,268711972264\" # List of ecgi spearated by a ','\n", " result = send_uu_unicast_provisioning_info(sandbox_name, ecgi)\n", " if result is None:\n", " logger.error('Failed to get UU unicast provisioning information')\n", " else:\n", " logger.info('UU unicast provisioning information: \", result)\n", "\n", " # Start notification server in a daemonized thread\n", " notification_server = threading.Thread(name='notification_server', target=start_server, args=(LISTENER_IP, LISTENER_PORT))\n", " notification_server.setDaemon(True) # Set as a daemon so it will be killed once the main thread is dead.\n", " notification_server.start()\n", " # Continue\n", " subscribe_v2x_message()\n", "\n", " # Wait for notification\n", " time.sleep(STABLE_TIME_OUT)\n", "\n", " delete_subscribe_v2x_message()\n", "\n", " mec_app_termination(sandbox, app_inst_id, sub_id)\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": [ "# Annexes\n", "\n", "## Annex A: How to use an existing MEC sandbox instance\n", "\n", "This case is used when the MEC Sandbox API is not used. The procedure is the following:\n", "- Log to the MEC Sandbox using a WEB browser\n", "- Select a network scenario\n", "- Create a new application instance\n", "\n", "When it is done, the newly created application instance is used by your application when required. This application instance is usually pass to your application in command line or using a confoiguation file\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Bibliography\n", "\n", "1. ETSI GS MEC 002 (V2.2.1) (01-2022): \"Multi-access Edge Computing (MEC); Phase 2: Use Cases and Requirements\".\n", "2. ETSI GS MEC 010-1 (V1.1.1) (10-2017): \"Mobile Edge Computing (MEC); Mobile Edge Management; Part 1: System, host and platform management\".\n", "3. ETSI GS MEC 010-2 (V2.2.1) (02-2022): \"Multi-access Edge Computing (MEC); MEC Management; Part 2: Application lifecycle, rules and requirements management\".\n", "4. ETSI GS MEC 011 (V3.1.1) (09-2022): \"Multi-access Edge Computing (MEC); Edge Platform Application Enablement\".\n", "5. ETSI GS MEC 012 (V2.2.1) (02-2022): \"Multi-access Edge Computing (MEC); Radio Network Information API\".\n", "6. ETSI GS MEC 013 (V2.2.1) (01-2022): \"Multi-access Edge Computing (MEC); Location API\".\n", "7. ETSI GS MEC 014 (V2.1.1) (03-2021): \"Multi-access Edge Computing (MEC); UE Identity API\".\n", "8. ETSI GS MEC 015 (V2.1.1) (06-2020): \"Multi-Access Edge Computing (MEC); Traffic Management APIs\".\n", "9. ETSI GS MEC 016 (V2.2.1) (04-2020): \"Multi-access Edge Computing (MEC); Device application interface\".\n", "10. ETSI GS MEC 021 (V2.2.1) (02-2022): \"Multi-access Edge Computing (MEC); Application Mobility Service API\".\n", "11. ETSI GS MEC 028 (V2.3.1) (07-2022): \"Multi-access Edge Computing (MEC); WLAN Access Information API\".\n", "12. ETSI GS MEC 029 (V2.2.1) (01-2022): \"Multi-access Edge Computing (MEC); Fixed Access Information API\".\n", "13. ETSI GS MEC 030 (V3.2.1) (05-2022): \"Multi-access Edge Computing (MEC); V2X Information Service API\".\n", "14. ETSI GR MEC-DEC 025 (V2.1.1) (06-2019): \"Multi-access Edge Computing (MEC); MEC Testing Framework\".\n", "15. ETSI GR MEC 001 (V3.1.1) (01-2022): \"Multi-access Edge Computing (MEC); Terminology\".\n", "16. ETSI GR MEC 003 (V3.1.1): Multi-access Edge Computing (MEC); \n", "Framework and Reference Architecture\n", "17. [The Wiki MEC web site](https://www.etsi.org/technologies/multi-access-edge-computing)\n" ] } ], "metadata": { "kernelspec": { "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.10.12" } }, "nbformat": 4, "nbformat_minor": 4 }