This repo defines the web interface for various drunc tools. Including:
- The Processes Manager
- The Controller
To run with a demo version of the drunc process manager, run it with docker compose:
docker compose upIt can take a few moment for the services to boot but the application should then be available in the browser at http://localhost:8000. Authentication is required to work with the application so you need to create a user account to work with:
docker compose exec app python manage.py createsuperuserand follow the prompts. You should then be able to use the details you supplied to pass the login screen. You can use the "boot" button on the main page to create simple processes to experiment with. You can also do this via the command line:
docker compose exec app python scripts/talk_to_process_manager.pyTake the services down with docker compose down or by pressing Ctrl+C in the
corresponding terminal.
Working with the full functionality of the web application requires a number of services
to be started and to work in concert. The Docker Compose stack provides the required
services and is suitable for development and manual testing but is not suitable for
running QA (pre-commit) tooling or unit tests. The project directory is mounted into the
app service which allows the Django development server's auto-reload mechanism to
detect changes to local files and work as expected.
It is recommended that you follow the below instructions on working with poetry to run the project's QA tooling and Unit Tests.
This is a Python application that uses poetry for packaging and dependency management. It also provides pre-commit hooks for various linters and formatters and automated tests using pytest and GitHub Actions. Pre-commit hooks are automatically kept updated with a dedicated GitHub Action.
To get started:
-
Download and install Poetry following the instructions for your OS.
-
Clone this repository and make it your working directory
-
Set up the virtual environment:
poetry install
-
Activate the virtual environment (alternatively, ensure any Python-related command is preceded by
poetry run):poetry shell
-
Install the git hooks:
pre-commit install
Pre-commit should now work as expected when making commits even without the need to have
an active poetry shell. You can also manually run pre-commit (e.g. pre-commit run -a)
and the unit tests with pytest. Remember you'll need to prefix these with poetry run
first if you don't have an active poetry shell.
You can also start the web application though at a minimum this requires the drunc process manager to be running. Note that drunc only works on Linux so this approach will not work on any other platforms. See the next section on also working with Kafka. Assuming you have an active poetry shell for all steps:
-
Start the drunc shell:
drunc-unified-shell --log-level debug ./data/process-manager-no-kafka.json
-
In another terminal, run the main app:
python manage.py runserver
-
As above you'll need to create a user to get past the login page:
python manage.py createsuperuser
Note that if you boot any processes in the web application this will immediately die with an exit code of 255. This is because the drunc shell requires an ssh server on localhost in order to be able to run processes. In most cases this isn't very limiting.
In the event that you want to work with the full application without using Docker Compose you must start the required components manually. Assuming you have an active poetry shell for all steps.
-
Start Kafka - See Running drunc with pocket kafka.
-
Start the drunc shell:
drunc-unified-shell --log-level debug ./data/process-manager-pocket-kafka.json -
Start the application server:
python manage.py runserver -
Start the Kafka consumer:
python manage.py kafka_consumer --debug
From here you should be able to see broadcast messages displayed at the top of the index page on every refresh.