Commit 7d26f6a8 authored by M. Rehan Abbasi's avatar M. Rehan Abbasi
Browse files

clean up README for feature development guide

parent d9a2ac57
Loading
Loading
Loading
Loading
+4 −10
Original line number Original line Diff line number Diff line
@@ -20,14 +20,11 @@ These steps can be summarized as the following sequence of events. More details


## Understanding the Software Architecture
## Understanding the Software Architecture


>**(all experts)**

In order to develop a new feature set for the Sandbox, it is crucial to understand the overall architecture of MEC Sandbox and its components. See [Software Architecture](../Software-Architecture/README.md) for a detailed overview of MEC Sandbox architecture and its components.
In order to develop a new feature set for the Sandbox, it is crucial to understand the overall architecture of MEC Sandbox and its components. See [Software Architecture](../Software-Architecture/README.md) for a detailed overview of MEC Sandbox architecture and its components.


After having gone through the provided documentation, it is recommended to deploy a functional MEC Sandbox instance in a lab environment. A step-by-step procedure on how to deploy your own lab setup for learning purposes is described in this [Learning Guide](./learning-guide.md).
After having gone through the provided documentation, it is recommended to deploy a functional MEC Sandbox instance in a lab environment. A step-by-step procedure on how to deploy your own lab setup for learning purposes is described in this [Learning Guide](./learning-guide.md).


## Feature Development
## Feature Development
>**(yann + hammad + rehan)**


Emulation logic for the MEC service under development will vary from service to service. However, baseline criterion which is applicable for every MEC service is summarized in the [Development Guide](./development-guide.md) here. Main steps for developing a minimal emulation logic are:
Emulation logic for the MEC service under development will vary from service to service. However, baseline criterion which is applicable for every MEC service is summarized in the [Development Guide](./development-guide.md) here. Main steps for developing a minimal emulation logic are:


@@ -38,13 +35,12 @@ Emulation logic for the MEC service under development will vary from service to
- Dockerization
- Dockerization


## Integrating the new microservice in AdvantEDGE
## Integrating the new microservice in AdvantEDGE
>**(yann + hammad + rehan)**


After developing the minimal emulation logic described in [Development Guide](./development-guide.md), the new service can be integrated in the AdvantEDGE as a new microservice. The integration-related aspects can be summarized as below:
After developing the minimal emulation logic described in [Development Guide](./development-guide.md), the new service can be integrated in AdvantEDGE as a new micro-service. The integration-related aspects can be summarized as below:


- Code integration
- Code integration
- meepctl configurations for AdvantEDGE
- _meepctl_ configurations for AdvantEDGE
- meepctl configurations for MEC Sandbox
- _meepctl_ configurations for MEC Sandbox
- Helm charts configurations
- Helm charts configurations
- MEC Sandbox Redeployment
- MEC Sandbox Redeployment
- Validation
- Validation
@@ -52,14 +48,12 @@ After developing the minimal emulation logic described in [Development Guide](./
See [Backend Integration](./backend-integration.md) for details on how to integrate the new feature into AdvantEDGE.
See [Backend Integration](./backend-integration.md) for details on how to integrate the new feature into AdvantEDGE.


## Network Scenario Creation
## Network Scenario Creation
>**(rehan + hammad)**


There may be a need for adding the new feature (MEC service) in an existing network scenario or create a custom network scenario altogether for the new MEC service. See [Network Scenarios](./network-scenarios.md) for details on how to do that.
There may be a need for adding the new feature (MEC service) in an existing network scenario or create a custom network scenario altogether for the new MEC service. See [Network Scenarios](./network-scenarios.md) for details on how to do that.


## Frontend Enhancements
## Frontend Enhancements
>**(rehan + yann)**


There are three main aspects that need to be taken care of regarding MEC Sandbox Frontend for a new MEC service.
There are three main aspects that need to be taken care of regarding MEC Sandbox Frontend for a new MEC service:


- Pull downs for the new service in the frontend
- Pull downs for the new service in the frontend
- Swagger UI integration
- Swagger UI integration