doc: style fixes

This commit is contained in:
pancho horrillo
2019-12-11 02:32:52 +01:00
parent 37025211b1
commit 16639ba44b
6 changed files with 62 additions and 57 deletions
+10 -6
View File
@@ -12,18 +12,19 @@ answered by the `User HTTP Interface`.
The user makes a request to the `User HTTP Interface`.
- The request is matched against the route table
- The request is matched against the route table.
- ``kapow`` provides a `HANDLER_ID` to identify this request and don't mix it
with other requests that could be running concurrently.
2. spawn
--------
``kapow`` spawns the executable specified as entrypoint in the matching
route.
The default entrypoint is ``/bin/sh``; we'll explain this workflow for now.
The default entrypoint is ``/bin/sh``; let's focus on this workflow.
The spawned entrypoint is run with the following variables added to its
environment:
@@ -32,6 +33,7 @@ environment:
- ``KAPOW_DATAAPI_URL``: With the URL of the `Data HTTP Interface`
- ``KAPOW_CONTROLAPI_URL``: With the URL of the `Control HTTP Interface`
3. ``kapow set /response/body banana``
--------------------------------------
@@ -43,18 +45,20 @@ available via these commands:
- ``kapow set /response/...``
These commands use the aforementioned environment variables to read data
from the user request and to write the response. They accept data
either as arguments or from ``stdin``.
from the user request and to write the response. They accept data either as
arguments or from ``stdin``.
4. exit
-------
The shell dies.
The shell dies. Long live the shell!
5. response
-----------
``kapow`` finalizes the original request.
``kapow`` finalizes the original request. Enjoy your banana now.
.. todo::