doc: style fixes and links

This commit is contained in:
pancho horrillo
2019-12-13 15:08:02 +01:00
parent 08086ee66e
commit dea72cbe3a
10 changed files with 86 additions and 73 deletions
+15 -9
View File
@@ -5,29 +5,35 @@
clear purpose.
User Interface
--------------
.. _http-user-interface:
The `User HTTP Interface` is used to serve final user requests.
HTTP User Interface
-------------------
The `HTTP User Interface` is used to serve final user requests.
By default it binds to address ``0.0.0.0`` and port ``8080``, but that can be
changed via the ``--bind`` flag.
Control Interface
-----------------
.. _http-control-interface:
The `Control HTTP Interface` is used by the command ``kapow route`` to
HTTP Control Interface
----------------------
The `HTTP Control Interface` is used by the command ``kapow route`` to
administer the list of system routes.
By default it binds to address ``127.0.0.1`` and port ``8081``, but that can be
changed via the ``--control-bind`` flag.
Data Interface
--------------
.. _http-data-interface:
The `Data HTTP Interface` is used by the commands ``kapow get`` and ``kapow
HTTP Data Interface
-------------------
The `HTTP Data Interface` is used by the commands ``kapow get`` and ``kapow
set`` to exchange the data for a particular request.
By default it binds to address ``127.0.0.1`` and port ``8082``, but that can be
+4 -4
View File
@@ -2,7 +2,7 @@ Request Life Cycle
==================
This section describes the sequence of events happening for each request
answered by the `User HTTP Interface`.
answered by the `HTTP User Interface`.
.. image:: ../_static/request_life_cycle.png
@@ -10,7 +10,7 @@ answered by the `User HTTP Interface`.
1. request
----------
The user makes a request to the `User HTTP Interface`.
The user makes a request to the `HTTP User Interface`.
- The request is matched against the route table.
@@ -30,8 +30,8 @@ The spawned entrypoint is run with the following variables added to its
environment:
- :envvar:`KAPOW_HANDLER_ID`: Containing the `HANDLER_ID`
- :envvar:`KAPOW_DATAAPI_URL`: With the URL of the `Data HTTP Interface`
- :envvar:`KAPOW_CONTROLAPI_URL`: With the URL of the `Control HTTP Interface`
- :envvar:`KAPOW_DATAAPI_URL`: With the URL of the `HTTP Data Interface`
- :envvar:`KAPOW_CONTROLAPI_URL`: With the URL of the `HTTP Control Interface`
3. ``kapow set /response/body banana``
+1 -1
View File
@@ -4,7 +4,7 @@ Routes
======
A *Kapow!* route specifies the matching criteria for an incoming request on
the `User HTTP Interface`, and the details to handle it.
the `HTTP User Interface`, and the details to handle it.
*Kapow!* implements a *route table* where all routes reside.