Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation typos and improvements. Thanks Noel!

Browse Source
This commit is contained in:
Roberto Abdelkader Martínez Pérez
2019-11-20 13:37:20 +01:00
parent c2a62814b5
commit b7efb3f109
3 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/theory/interfaces.rst
+5 -5
View File
@@ -9,7 +9,7 @@ User Interface
The User HTTP interface is used to serve final user requests. The User HTTP interface is used to serve final user requests.
By default it binds to address `0.0.0.0` and port `8080`, but can be changed via By default it binds to address ``0.0.0.0`` and port ``8080``, but can be changed via
the ``--bind`` flag. the ``--bind`` flag.
@@ -19,15 +19,15 @@ Control Interface
The Control HTTP interface is used by the command `kapow route` to The Control HTTP interface is used by the command `kapow route` to
administer the list of system routes. administer the list of system routes.
By default it binds to address `127.0.0.1` and port `8081`, but can be changed By default it binds to address ``127.0.0.1`` and port ``8081``, but can be changed
via the ``--control-bind`` flag. via the ``--control-bind`` flag.
Data Interface Data Interface
-------------- --------------
The Data HTTP interface is used by the commands `kapow get` and `kapow The Data HTTP interface is used by the commands ``kapow get`` and ``kapow
set` to exchange the data for a particular request. set`` to exchange the data for a particular request.
By default it binds to address `127.0.0.1` and port `8082`, but can be changed By default it binds to address ``127.0.0.1`` and port ``8082``, but can be changed
via the ``--data-bind`` flag. via the ``--data-bind`` flag.
docs/source/theory/request_life_cycle.rst
+7 -6
View File
@@ -14,15 +14,16 @@ answered by the User HTTP Interface.
The default entrypoint is /bin/sh; we'll explain this workflow for now. The default entrypoint is /bin/sh; we'll explain this workflow for now.
The spawned entrypoint is run with following variables added to its environment: The spawned entrypoint is run with the following variables added to its environment:
- KAPOW_HANDLER_ID
- KAPOW_DATAAPI_URL - KAPOW_HANDLER_ID
- KAPOW_CONTROLAPI_URL - KAPOW_DATAAPI_URL
- KAPOW_CONTROLAPI_URL
#. During the lifetime of the shell, the request and response resources are available via these commands: #. During the lifetime of the shell, the request and response resources are available via these commands:
- kapow get /request/... - kapow get /request/...
- kapow set /response/... - kapow set /response/...
TODO: link to resource tree TODO: link to resource tree
docs/source/theory/resource_tree.rst
+2 -2
View File
@@ -1,5 +1,5 @@
The Resource Tree The `Kapow!` Resource Tree
================= ==========================
This is the model that Kapow! uses to expose the internals of the user request This is the model that Kapow! uses to expose the internals of the user request
being serviced. being serviced.