prpl/prplMesh
1
0
Fork 0
mirror of https://gitlab.com/prpl-foundation/prplmesh/prplMesh.git synced 2025-12-20 01:21:22 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docker: README.md: update with builder instead of runner image

Browse Source 
While we're at it, clean up the documentation a little.

The "all" container is not really used for anything any more, so it's
documentation is removed.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
This commit is contained in:
Arnout Vandecappelle (Essensium/Mind)
2020-08-31 18:12:59 +02:00
committed by arnout
parent d51c1ea07a
commit 7adc105386
1 changed files with 21 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
tools/docker/README.md
View File

@@ -2,10 +2,9 @@
prplMesh provides docker images and helper scripts for building and running prplMesh using docker.
The `./image-build.sh` supports building 2 images:
- **builder image** for building prplMesh using docker
- **runner image** for running prplMesh using docker
The `./image-build.sh` supports building several images. The most used image is
`prplMesh-builder-ubuntu-bionic`. It contains everything needed to build and to run prplMesh.
Wrapper scripts exist to start the containers with appropriate mounting of volumes.
If you don't build the images first, they will be pulled from the prplmesh registry on gitlab.com.
@@ -19,7 +18,7 @@ Note that if you choose not to follow the guide, you should add `sudo` before ea
---
## Docker builder
## Building in docker
The docker builder image can be used to build prplMesh via `maptools.py build` command running in a prplmesh-build container via `build.sh`.
@@ -29,40 +28,6 @@ Build prplMesh in container:
./build.sh <maptools.py build arguments>
```
## Docker runner
The docker runner image can be used to run prplMesh inside containers using `run.sh`.
The runner docker allows running multiple containers, for example one with a controller+agent, the other with an agent only:
The 2 containers are connected using a docker network (bridge), so can
communicate + sniffed by running `wireshark` / `tshark` / `tcpdump` on the bridge from the host to see 1905 packets.
This is what is done by the test scripts in the tests/ directory.
Therefore they require dumpcap and tshark to be installed in order to work.
## Docker all
The all docker allows building and running prplMesh inside containers. It includes all the tools used for building and running prplMesh, and is mainly used for running prplMesh on Windows at the moment.
Build this image:
```bash
cd ./all
docker image build --tag prplmesh-all .
```
The current use case for using the `all` image is to run prplMesh on a Windows host for connecting to the WiFi TestSuite wts application (UCC).
This is done by running the container (mapping the sources or cloning them from within the container) in priviliged mode on port X which is set in the UCC as the DUT port:
```bash
docker container run -v //c/Users/prplMesh/dev1/:/work/dev1 --privileged -p 5000:5000 --expose 5000 --name gateway -d --user=0:0 --interactive --tty --entrypoint bash --rm prplmesh-windows
```
## Docker tester
A simple wrapper which calls `docker exec <container name> -it <path/to>/build/install/scripts/prplmesh_utils.sh status` which prints the prplMesh operational status of the main and radio agents.
### Prerequisites
Build prplMesh (build/install directory will be the only directory mapped to the
containers).
@@ -76,6 +41,17 @@ If you want to see more verbose build output use "--make-verbose" option
./maptools.py build map BUILD_TESTS=ON CMAKE_BUILD_TYPE=Debug --make-verbose
```
## Running in docker
The docker builder image can be used to run prplMesh inside containers using `run.sh`.
It is possible to run multiple containers, for example one with a controller+agent, the other with an agent only:
The 2 containers are connected using a docker network (bridge), so can
communicate + sniffed by running `wireshark` / `tshark` / `tcpdump` on the bridge from the host to see 1905 packets.
This is what is done by the test scripts in the tests/ directory.
Therefore they require dumpcap and tshark to be installed in order to work.
### Run the Containers
Finally, run 2 containers - we will run one controller, naming it "controller", and one "agent".
@@ -114,8 +90,14 @@ If needed, run the container interactively without specifying the daemon to run:
```bash
# start container named <name> and start interactive session using bash (supplied by the image)
./run.sh -n <name>
```
## Docker tester
`test.sh` is a simple wrapper which calls `docker exec <container name> -it <path/to>/build/install/scripts/prplmesh_utils.sh status` which prints the prplMesh operational status of the main and radio agents.
---
**Notes**