-[2. Communication with the common message bus](#2-communication-with-the-common-message-bus)
-[3. Successful responses from the service API](#3-successful-responses-from-the-service-api)
-[4. Swagger UI for the new service](#4-swagger-ui-for-the-new-service)
-[2. Service not being shown as App. Instance](#2-service-not-being-shown-as-app-instance)
-[3. Communication with the common message bus](#3-communication-with-the-common-message-bus)
-[4. Successful responses from the service API](#4-successful-responses-from-the-service-api)
-[5. Swagger UI for the new service](#5-swagger-ui-for-the-new-service)
[AdvantEDGE repository](https://github.com/InterDigitalInc/AdvantEDGE) or its fork is used for the backend part during a MEC Sandbox deployment. Therfore, it is recommended to use a fork of AdvantEDGE repo during feature development and then clone that fork instead of the main AdvantEDGE repo during testing or deployment.
The steps for integrating a new MEC service into the AdvantEDGE backend can be summarized as below:
1. Code integration
1. meepctl configurations for AdvantEDGE
1. meepctl configurations for MEC Sandbox
1._meepctl_ configurations for AdvantEDGE
1._meepctl_ configurations for MEC Sandbox
1. Helm charts configurations
1. _meep-applications_ configuration
1. MEC Sandbox Redeployment
1. Validation
@@ -95,6 +98,10 @@ All the Helm charts for multiple services are available under the `AdvantEDGE/ch
The template for the Helm chart for the new service can be obtained from any other micro-service like `meep-rnis`, `meep-wais` etc. The service name in each of the files for the template will need to be changed to reflect the name of the new service.
## _meep-applications_ Configuration
To make the new service be properly recognizable by the MEC Sandbox frontend, it will need to be added in the `SysAppNames` variable in `AdvantEDGE/go-packages/go-applications/application.store.go` file. This will make sure that the new service is recognized as a service and not as an application instance.
## Upgrade MEC Sandbox
After making all the necessary changes in the AdvantEDGE code and MEC Sandbox configuration files (preferably on their respective repositories), MEC Sandbox instance (whether production or testbed/staging area environment) can be upgraded with the new feature set using this [upgrade procedure](https://forge.etsi.org/rep/mec/mec-sandbox#upgrade-mec-sandbox).
@@ -112,13 +119,16 @@ After the MEC Sandbox has been redeployed using the upgrade steps mentioned abov
- On the Sandbox VM console/terminal, check if the pod for the new service is in _Running_ state for the new sandbox instance after it is instantiated.
### 2. Communication with the common message bus
### 2. Service not being shown as App. Instance
After the correct network scenario is selected in the MEC Sandbox UI, make sure that the new MEC service is not being shown in the [box](../Sandbox-User-Interface/README.md#sbox04) under _MEC App. Instance IDs_.
### 3. Communication with the common message bus
Check the logs of the container running the microservice and see it is sending and receving messages on the common message bus. If there is no logic for sending messages through SBI, at least the service should be receiving periodic "SCENARIO-UPDATE" messages for different events related to UE mobility etc.
### 3. Successful responses from the service API
### 4. Successful responses from the service API
Send a request to the exposed endpoints of the new service using _curl_, _Postman_ or any other tool to verify that the service is returning valid responses through its NBI accroding to the developed emulation logic.
### 4. Swagger UI for the new service
### 5. Swagger UI for the new service
Follow these steps to validate successful Swagger UI generation for the new service:
- Create a user sandbox instance with a network scenario that supports the newly added MEC service
- After successful sandbox creation, access `https://try-mec.etsi.org/<user-sandbox-id>/api/` or `http://<Sandbox-VM-IP>/<user-sandbox-id>/api/` _(for local deployment)_ from browser
@@ -20,7 +20,7 @@ For adding the new service in the [MEC API dropdown](../Sandbox-User-Interface/R
This will show the new service in the dropdown if that service is supported by the selected network scenario upon next MEC Sandbox upgrade.
To make the service appear in the [API console](./Sandbox-User-Interface#sbox05b), make the following changes in [MEC Sandbox repository](https://forge.etsi.org/rep/mec/mec-sandbox)to the files mentioned:
To properly integrate the new servive with the MEC Sandbox front end e.g. to make the service appear in the [API console](../Sandbox-User-Interface/README.md#sbox05b), following changes in [MEC Sandbox repository](https://forge.etsi.org/rep/mec/mec-sandbox)will need to be made:
