@@ -35,6 +35,7 @@ The steps for integrating a new MEC service into the AdvantEDGE backend can be s
After having restructured the client & server stubs and developing minimal server-side & client-side logic for the new feature using the [development guide](./development-guide.md), move the code files into AdvantEDGE repository or its fork using the following guidelines:
-[Server side](./development-guide.md#server-side) code contained in a separate folder named `meep-<mec-identifier>` will go under `AdvantEDGE/go-apps/` directory
-[Server side (For multiple APIs)](./development-guide.md#server-side-for-multiple-apis) code contained in a separate folder named `meep-<mec-identifier>` will go under `AdvantEDGE/go-apps/` directory
-[Client side](./development-guide.md#client-side) code contained in a folder named `meep-<mec-identifier>-client` will be placed under `AdvantEDGE/go-packages/` directory
-[Testing](./development-guide.md#unit-tests-for-the-new-micro-service) code... (**TODO** _Info about test files to be added later._)
@@ -48,7 +49,16 @@ This file contains the whole configuration of the AdvantEDGE platform, including
### Changes in AdvantEDGE `.meepctl-repocfg.yaml`
The changes that need to be made to `.meepctl-repocfg.yaml` file are:
- Add the new service in `repo.sandbox.go-apps` section
- Add the new service in `repo.sandbox.go-apps` section. In case if a service contains multiple APIs, then rest of the lines will be same. Just add the corresponding APIs information under _api_ tag, as mentioned below:
@@ -81,10 +91,14 @@ The same changes need to be added in this file that were made for AdvantEDGE [he
Additionally for making the Swagger UI available in the Sandbox frontend for the new service, these steps need to be taken:
1. Copy the Swagger or OpenAPI specifications of the new MEC Service from backend (available under `mec-sandbox/go-apps/meep-<mec-identifier>/api/swagger.yaml`) to `mec-sandbox/config/api/` folder and rename the file from `swagger.yaml` to `<mec-identifier>-api.yaml`. Additionally
1. Copy the Swagger or OpenAPI specifications of the new MEC Service from backend (available under `mec-sandbox/go-apps/meep-<mec-identifier>/api/swagger.yaml`) to `mec-sandbox/config/api/` folder and rename the file from `swagger.yaml` to `<mec-identifier>-api.yaml`.
***Note:** In case multiple APIs, copy each Swagger or OpenAPI specifications of the new MEC Service from backend (available under `mec-sandbox/go-apps/meep-<mec-identifier>/api/<api_tag_i>/swagger.yaml`) to `mec-sandbox/config/api/<api_tag_i>/` subfolders.
3. After performing the above, do the following:
- Customize the YAML to hide unnecessary endpoints in the UI
- Add necessary license description in the `info` section
2. Add this location of OAS yaml in the `repo.sandbox.go-apps.<mec-identifier>.user-api` section of `.meepctl-repocfg.yaml` file
4. Add this location of OAS yaml in the `repo.sandbox.go-apps.<mec-identifier>.user-api` section of `.meepctl-repocfg.yaml` file
In addition to `.meepctl-repocfg.yaml` file, the following files will need to be updated when creating a new micro-service:
@@ -96,7 +110,7 @@ In addition to `.meepctl-repocfg.yaml` file, the following files will need to be
All the Helm charts for multiple services are available under the `AdvantEDGE/charts` folder. Once a new service is added, its Helm chart needs to be added in this folder under the name `meep-<mec-identifier>`.
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.
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. In case of multiple APIs scenario, `meep-tm` charts can be consulted.