Clean the repository structure (omec-project#472)

patriciareinoso · Feb 11, 2022 · b735938 · b735938
1 parent 8f41cfb
commit b735938
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 24 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -52,12 +52,12 @@ RUN mv sample_plugin plugins
 ## Network Token
 ARG ENABLE_NTF
 ARG NTF_COMMIT=master
-COPY install_ntf.sh .
+COPY scripts/install_ntf.sh .
 RUN ./install_ntf.sh
 
 # Build and copy artifacts
 COPY core/ core/
-COPY build_bess.sh .
+COPY scripts/build_bess.sh .
 RUN ./build_bess.sh && \
     cp bin/bessd /bin && \
     mkdir -p /bin/modules && \

diff --git a/README.md b/README.md
@@ -90,4 +90,4 @@ https://user-images.githubusercontent.com/6157640/133918985-c36d4668-4e98-4866-8
 
 ## Installation
 
-Please see [INSTALL.md](INSTALL.md) for details on how to set up CP and UPF-EPC.
+Please see [INSTALL.md](docs/INSTALL.md) for details on how to set up CP and UPF-EPC.
diff --git a/upf-k8s.yaml → deployments/upf-k8s.yaml b/upf-k8s.yaml → deployments/upf-k8s.yaml
diff --git a/INSTALL.md → docs/INSTALL.md b/INSTALL.md → docs/INSTALL.md
@@ -11,13 +11,13 @@ You need the following dependencies.
 
 * Docker CE >= 19.03
 * Linux kernel version >= 4.15 for Docker; >= 4.19 for AF_XDP
-* Hugepages mounted at `/dev/hugepages` or updated location in [`docker_setup.sh`](docker_setup.sh)
-* Update mode for devices: `dpdk`, `af_xdp` or `af_packet` in [`docker_setup.sh`](docker_setup.sh),
+* Hugepages mounted at `/dev/hugepages` or updated location in [`scripts/docker_setup.sh`](../scripts/docker_setup.sh)
+* Update mode for devices: `dpdk`, `af_xdp` or `af_packet` in [`scripts/docker_setup.sh`](../scripts/docker_setup.sh),
     along with device details
-* Update [`docker_setup.sh`](docker_setup.sh) and [`conf/up4.bess`](conf/up4.bess) to run pktgen tests
-* Update [`docker_setup.sh`](docker_setup.sh) and [`conf/up4.bess`](conf/up4.bess) to run sim mode tests
+* Update [`scripts/docker_setup.sh`](../scripts/docker_setup.sh) and [`conf/up4.bess`](../conf/up4.bess) to run pktgen tests
+* Update [`scripts/docker_setup.sh`](../scripts/docker_setup.sh) and [`conf/up4.bess`](../conf/up4.bess) to run sim mode tests
 
->`docker_setup.sh` is a quick start guide to set up UPF-EPC for evaluation.
+>`scripts/docker_setup.sh` is a quick start guide to set up UPF-EPC for evaluation.
 
 ## Run
 
@@ -29,11 +29,11 @@ You need the following dependencies.
 To run BESS daemon with NGIC modules' code:
 
 ```bash
-./docker_setup.sh
+./scripts/docker_setup.sh
 ```
 
-To update the pipeline, reflect changes to [`conf/up4.bess`](conf/up4.bess)
-and/or [`conf/upf.json`](conf/upf.json)
+To update the pipeline, reflect changes to [`conf/up4.bess`](../conf/up4.bess)
+and/or [`conf/upf.json`](../conf/upf.json)
 
 ```bash
 docker exec bess ./bessctl run up4
@@ -69,11 +69,11 @@ localhost:10514 $ tcpdump gtpuEncap out 1 -c 128 -w conf/gtpuEncapOut.pcap
 
 ## Components
 
-![upf](docs/images/upf.svg)
+![upf](images/upf.svg)
 
 ### Zoom-in
 
-![bess-programming](docs/images/bess-programming.svg)
+![bess-programming](images/bess-programming.svg)
 
 ## Testing
 
@@ -86,7 +86,7 @@ without the need for external interfaces.
 
 > Note: This mode does not support multiple workers currently.
 
-![ubench-sim](docs/images/ubench-sim.svg)
+![ubench-sim](images/ubench-sim.svg)
 
 To start UPF-EPC in simulation mode:
 
@@ -106,10 +106,10 @@ To start UPF-EPC in simulation mode:
 
         "": "max UE sessions",
         "max_sessions": 50000,
-    diff --git a/docker_setup.sh b/docker_setup.sh
+    diff --git a/scripts/docker_setup.sh b/scripts/docker_setup.sh
     index 086ad2f..79d81bd 100755
-    --- a/docker_setup.sh
-    +++ b/docker_setup.sh
+    --- a/scripts/docker_setup.sh
+    +++ b/scripts/docker_setup.sh
     @@ -16,7 +16,7 @@ bessd_port=10514
     mode="dpdk"
     #mode="af_xdp"
@@ -124,7 +124,7 @@ To start UPF-EPC in simulation mode:
 2. Start UPF
 
     ```bash
-    ./docker_setup.sh
+    ./scripts/docker_setup.sh
     ```
 
 3. Insert rules into relevant PDR and FAR tables
@@ -145,19 +145,19 @@ To start UPF-EPC in simulation mode:
 
 4. (optional) Observe the pipeline in GUI
 
-#### [Pktgen](conf/pktgen.bess)
+#### [Pktgen](../conf/pktgen.bess)
 
 Pktgen allows us to test the upf pipeline with external fastpath interfaces.
 This can be done either using a single machine or two machines.
 
-> Make sure the mode is not set to sim in docker_setup.sh and upf.json
+> Make sure the mode is not set to sim in scripts/docker_setup.sh and upf.json
 
-![ubench-pktgen](docs/images/ubench-pktgen.svg)
+![ubench-pktgen](images/ubench-pktgen.svg)
 
 1. Configure the mode/cores/memory/devices as per your environment and start UPF
 
     ```bash
-    ./docker_setup.sh
+    ./scripts/docker_setup.sh
     ```
 
 2. Insert rules into relevant PDR and FAR tables
@@ -176,7 +176,7 @@ This can be done either using a single machine or two machines.
             upf-epc-bess:"$(<VERSION)" -grpc-url=0.0.0.0:10514
     ```
 
-4. Customize [pktgen.bess](conf/pktgen.bess) to match [sim config](conf/upf.json) used in step 2
+4. Customize [pktgen.bess](../conf/pktgen.bess) to match [sim config](../conf/upf.json) used in step 2
 
 5. Start pktgen
 
@@ -193,7 +193,7 @@ application providers. More details are available at [networktokens.org](https:/
 In order to compile NTF support, run the following:
 
 ```bash
-ENABLE_NTF=1 ./docker_setup.sh
+ENABLE_NTF=1 ./scripts/docker_setup.sh
 ```
 
 Update [`conf/spgwu.json`](conf/spgwu.json) and set the `enable_ntf` option to

diff --git a/build_bess.sh → scripts/build_bess.sh b/build_bess.sh → scripts/build_bess.sh
diff --git a/docker_setup.sh → scripts/docker_setup.sh b/docker_setup.sh → scripts/docker_setup.sh
diff --git a/install_ntf.sh → scripts/install_ntf.sh b/install_ntf.sh → scripts/install_ntf.sh
diff --git a/telemetry.sh → scripts/telemetry.sh b/telemetry.sh → scripts/telemetry.sh
Original file line number	Diff line number	Diff line change
Expand Up		@@ -90,4 +90,4 @@ https://user-images.githubusercontent.com/6157640/133918985-c36d4668-4e98-4866-8

		## Installation

		Please see [INSTALL.md](INSTALL.md) for details on how to set up CP and UPF-EPC.
		Please see [INSTALL.md](docs/INSTALL.md) for details on how to set up CP and UPF-EPC.