Skip to content

Add some documentation and examples for LogStream

Adam Coldrick requested to merge sotk/logstream/documentation into master

Description

This MR adds some documentation of the purpose of the LogStream service, as well as some information on different approaches to making use of it, either in a BuildGrid remote execution context or as a standalone service.

It also includes an example docker-compose file for a standalone LogStream service.

Validation

You can build the docs with tox, and then serve the result to view in-browser with Python's built-in http server.

tox -e docs
cd docs/build/html
python3 -m http.server

Then go to http://localhost:8000/ to see the new docs.

Try following the instructions in the Using LogStream section to play with the new standalone LogStream docker-compose file.

Merge request reports