7adc105386
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>
4.7 KiB
prplMesh docker support
prplMesh provides docker images and helper scripts for building and 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.
Docker post-installation
To remove the need of using sudo before each docker command, please refer to the next guide:
https://docs.docker.com/install/linux/linux-postinstall/
Note that if you choose not to follow the guide, you should add sudo before each command.
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.
Build prplMesh in container:
./build.sh <maptools.py build arguments>
Build prplMesh (build/install directory will be the only directory mapped to the containers).
./maptools.py build map BUILD_TESTS=ON CMAKE_BUILD_TYPE=Debug
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". Naming is important to be able to attach to the container easily from other shells (for tailing the logs).
Helper scripts for running controller and agent are provided in the image for running in detached mode - start-agent, start-controller, start-controller-agent.
In this mode, the container entry command is to run the prplMesh controller / agent / controller & agent.
After running, we can connect to the container with a new shell using docker container exec -it <name> bash.
Run Agent+Controller container (detached)
# start controller+agent in a new container named 'controller' in detached mode
./run.sh -n controller -d start-controller-agent
# attach the controller container and open new bash shell
docker container exec -it controller bash
# Now we are inside the container and can tail the controller log
tail -F /tmp/beerocks/logs/beerocks_controller.log
Run Agent container (detached)
# start agent in a new container named 'agent' in detached mode
./run.sh -n agent -d start-agent
# attach the agent container and open new bash shell
docker container exec -it agent bash
# Now we are inside the container and can tail the agent log
tail -F /tmp/beerocks/logs/beerocks_agent.log
Running container interactive
If needed, run the container interactively without specifying the daemon to run:
# 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
- The script automatically selects an IP based on the network, but its not 100% full proof - it generates a random IP in the network subnet, except for the gateway. If more than one container is created on the same network they might get the same IP (very rare but keep in mind)
- List all running containers
docker container ls - Connect to any running container using
docker container attach <name> - Connect to any running container opening a new shell using
docker container exec -it <name> bash - Kill all containers (running and stopped)
docker rm -f $(docker ps -a -q)
Docker cheat-sheet
Show all images - docker images
Delete all images - docker rmi $(docker images -q)
Delete all containers - docker rm $(docker ps -a -q)
Fetch the logs of a specific container - docker logs CONTAINER
Proxy - The recommended way to work with docker behind a proxy is by configuring the docker client to pass proxy information to containers automatically.