diff --git a/docs/source/theory/interfaces.rst b/docs/source/theory/interfaces.rst new file mode 100644 index 0000000..c28dc72 --- /dev/null +++ b/docs/source/theory/interfaces.rst @@ -0,0 +1,27 @@ +Kapow! HTTP Interfaces +====================== + +User Interface +-------------- + +The User HTTP interface is used to serve final user requests. + +By default is bind to address `0.0.0.0` and port `8080`. + + +Control Interface +----------------- + +The Control HTTP interface is used by the command `kapow route` to +administer the list of system routes. + +By default is bind to address `127.0.0.1` and port `8081`. + + +Data Interface +-------------- + +The Data HTTP interface is used by the commands `kapow get` and `kapow +set` to exchange the data for a particular request. + +By default is bind to address `127.0.0.1` and port `8082`. diff --git a/docs/source/theory/philosophy.rst b/docs/source/theory/philosophy.rst new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/theory/request_life_cycle.rst b/docs/source/theory/request_life_cycle.rst new file mode 100644 index 0000000..a874759 --- /dev/null +++ b/docs/source/theory/request_life_cycle.rst @@ -0,0 +1,7 @@ +Request Life Cycle +================== + +This section describes the sequence of events happening for each request +answered by the User HTTP Interface. + + diff --git a/docs/source/theory/resource_tree.rst b/docs/source/theory/resource_tree.rst new file mode 100644 index 0000000..3aea6f2 --- /dev/null +++ b/docs/source/theory/resource_tree.rst @@ -0,0 +1,4 @@ +The Resource Tree +================= + +