summaryrefslogtreecommitdiff
path: root/ARCH
diff options
context:
space:
mode:
authorBen Hutchings <ben.hutchings@codethink.co.uk>2020-05-13 16:14:09 +0100
committerBen Hutchings <ben.hutchings@codethink.co.uk>2020-06-01 15:31:19 +0100
commit2f6987a7cbc485f28b875013bd3793a08be0083c (patch)
tree20bfc92c7036ba0967889a7047f75de2f8a36d83 /ARCH
parentddc2e9c97ddafed9e34aa9f4de2fdf9ffef20bcf (diff)
downloadlorry-controller-2f6987a7cbc485f28b875013bd3793a08be0083c.tar.gz
ARCH: Expand description of the lorrycontroller package
Related to #5.
Diffstat (limited to 'ARCH')
-rw-r--r--ARCH9
1 files changed, 7 insertions, 2 deletions
diff --git a/ARCH b/ARCH
index 152ae33..5f7ce7b 100644
--- a/ARCH
+++ b/ARCH
@@ -431,8 +431,13 @@ The Lorry Controller code base is laid out as follows:
way (with the `@app.route` decorator) seemed to make that harder and
require everything in the same class.
-* `lorrycontroller` is a Python package with the HTTP request
- handlers, management of STATEDB, plus some helpful utilities.
+* `lorrycontroller` is a Python package with:
+
+ - The HTTP request handlers (`LorryControllerRoute` and its subclasses)
+ - Management of STATEDB (`statedb` module)
+ - Support for various Downstream and Upstream Host types
+ (`hosts`, `gitano`, `gerrit`, `gitlab`, `local` modules)
+ - Some helpful utilities (`proxy` module)
* `lorry-controller-minion` is the entirety of the MINION, except that
it uses the `lorrycontroller.setup_proxy` function.