The goal of this document is to provide deployment guidance to the Overlord factory monitor system.
You need a computer that can run docker and python3.6+. We recommend using Ubuntu 18.04+.
Add current user to the “docker” group, then you can run docker command without sudo.
sudo usermod -aG docker ${USER}
Intstall the following packages:
pip3 install jsonrpclib-pelix ws4py
The Overlord source code resides in the chromiumos factory repository. You can clone the factory git repo without the entire chromiumos source tree:
$ git clone https://chromium.googlesource.com/chromiumos/platform/factory
Then you can find the deployment script setup/cros_docker.sh.
$ cd factory/setup $ ./cros_docker.sh overlord setup
You need to provide the following info at this step:
After the setup, the setup script will print some instructions for you to set up the browser certificate. But this step is optional.
$ ./cros_docker.sh overlord run
You can access the Overlord server at https://${IP}:9000.
This feature integrates the DUT's testing framework into Overlord server. Long story short:
Please refer to the user manual guide for more details.
The clients are called ghost in the Overlord framework. There are currently two implementations, one implemented in python and the other implemented in go. The python version can be found under the factory source repository: py/tools/ghost.py; while the go version is under go/src/overlord/ghost.go which is built along side with the overlordd binary under go/bin.
The recommended way is to upgrade the toolkit with upgraded ghost client through shopfloor. This prevents most of the compatibility issues.