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

restructure network scenario guide and add steps for service inclusion in a scenario

parent ef0c31c1
Loading
Loading
Loading
Loading
+176 KiB
Loading image diff...
+5 −5
Original line number Diff line number Diff line
@@ -2,19 +2,19 @@

This guide contains all frontend-related aspects that need to be enhanced for integrating a new service in the MEC Sandbox. These include:

1- [Pull downs for the new serivce in the frontend](#pull-downs-for-the-new-serivce-in-the-frontend)
1- [Pull downs for the new service in the frontend](#pull-downs-for-the-new-service-in-the-frontend)

2- [Swagger UI integration](#swagger-ui-integration)

3- [Grafana dashboard for monitoring service-related metrics](#grafana-dashboard-for-monitoring-service-related-metrics)

## Pull downs for the new serivce in the frontend
## Pull downs for the new service in the frontend
For adding the new service in the [MEC API dropdown](../Sandbox-User-Interface/README.md#sbox05a), the following file in the [MEC Sandbox repository](https://forge.etsi.org/rep/mec/mec-sandbox/-/tree/master) needs to be modified.

- `mec-sandbox/js-apps/frontend/src/js/util/scenario-utils.js`
  - In the `parseEdgeApps()` function, add an `else if` block for the new service and assign the variables such as path, url, dropDownName etc. with appropriate values<br>**NOTE:** _See the information for existing MEC services in the if-else blocks for reference._
  - In the `parseEdgeApps()` function, add an `else if` block for the new service and assign the variables such as _path_, _url_, _dropDownName_ etc. with appropriate values<br>**NOTE:** _See the information for existing MEC services in the if-else blocks for reference._

This will show the new service in the dropdown if that service is supported by the selected network scenrio upon next MEC Sandbox upgrade.
This will show the new service in the dropdown if that service is supported by the selected network scenario upon next MEC Sandbox upgrade.


## Swagger UI integration
+15 −36
Original line number Diff line number Diff line
# Network Scenarios

TODO

## Provisioning Admin User

Before creating/uploading a network scenario, a GitHub username will need to be provisioned as admin. This can be done using the steps mentioned [here](./learning-guide.md#user-provisioning).
Before creating, uploading or editing a network scenario, a GitHub username will need to be provisioned as admin. This can be done using the steps mentioned [here](./learning-guide.md#user-provisioning).

## Creating a New Network Scenario

After logging into the AdvantEDGE dashboard, follow the following steps to create a new network scenario:

1. Click on `CONFIGURE` tab.

2. Click on the `NEW` button, enter the new network scenario name and click on `OK`.
   > Make sure that the scenario name contains only lowercase alphanumeric characters and "`-`".

3. Click on the `NEW` button under _Element Configuration_.

4. Select _Element Type_ as required and fill up the details as needed.

5. After the details for the element are filled in, click on `APPLY` at the bottom to add that element into the network scenario. The new element will appear on the right in the network view display box.

6. Add all the elements as required.

7. After the network scenario is finalized, click on `SAVE` on the top right, enter the network scenario name and click on `OK`. The network scenario is now created.

8. To verify that the network scenario has been created successfully, go to the MEC Sandbox UI. The new network will be shown in the dropdown menu on the right.
After logging into the AdvantEDGE dashboard, follow the steps mentioned [here](https://interdigitalinc.github.io/AdvantEDGE/docs/usage/usage-first-scenario/) to create a new network scenario.

## Exporting a Saved Network Scenario

To export a network scenario saved on the AdvantEDGE (backend of MEC Sandbox), follow the following steps:

1. Open the AdvantEDGE dashboard ([try-mec.etsi.org/alt](https://try-mec.etsi.org/alt)).

2. Click on `CONFIGURE` tab.

3. Click on the `OPEN` button. Select the network scenario which is to be exported from the drop down list and click on `OK`.

4. Click on the `EXPORT` button, give the name of the file and click on `OK`. A file with the same name as provided will be downloaded.
| Steps                                                                                                                                                                        | Wireframe                                                             |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| Navigate to the `Configure` tab on the AdvantEDGE dashboard ([try-mec.etsi.org/alt](https://try-mec.etsi.org/alt)) and open the network scenario which needs to be exported. | _**Click image to enlarge**_<br>![Open Scenario](open-scenario.png)   |
| Export the scenario using the `Export` button on the top right. A YAML file with the network scenario configurations will be downloaded with the provided name.              | _**Click image to enlarge**_<br>![Open Scenario](export-scenario.png) |

## Uploading an Existing Network Scenario

1. Open [try-mec.etsi.org/alt](https://try-mec.etsi.org/alt) while being signed into the MEC Sandbox UI. This will open the AdvantEDGE dashboard.

2. Click on `CONFIGURE` tab.
To upload an existing network scenario (from YAML file), follow the instructions [here](https://forge.etsi.org/rep/mec/mec-sandbox#configure-scenarios).

3. Click on the `IMPORT` button. Navigate to the _networks_ folder on your local system and upload any valid network scenario file.
## Adding a new service in an existing network scenario

4. Click on the `Save` button. It will ask to name the network scenario. Keep the default name or type a new one.
To add a new MEC service in a an existing network scenario, follow these steps:

5. To verify that the network scenario has been uploaded successfully, go to the MEC Sandbox UI. The new network will be shown in the dropdown menu on the right.
| Steps                                                                                                                                                                                                                                                                                                                                                                                              | Wireframe                                                                   |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| Navigate to the AdvantEDGE dashboard, then to the `Configure` tab and open the scenario in which the new service is to be added.                                                                                                                                                                                                                                                                   | _**Click image to enlarge**_<br>![Open Scenario](open-scenario.png)         |
| Click on `New` and create a new `Edge Application`.<br>Name the application the same as the MEC service specification number e.g. for RNIS, it will be `mec028`. Also, add `meep-docker-registry:30001/meep-<mec-identifier>` as _Container Image Name_.<br>Make sure that the _Parent Node_ is the required MEC Platform.<br>The environment variables should also be the same as other services. | _**Click image to enlarge**_<br>![Service Creation](service-creation.png)   |
| Apply the changes and the new service will be shown under the selected MEC Platform in the Network view on the left..                                                                                                                                                                                                                                                                              | _**Click image to enlarge**_<br>![Service Under MEP](service-under-mep.png) |
| Save the network scenario with the same name as the one which was edited.                                                                                                                                                                                                                                                                                                                          | _**Click image to enlarge**_<br>![Service Under MEP](save-scenario.png)     |
+177 KiB
Loading image diff...
+17.8 KiB
Loading image diff...
Loading