GoldenPogacsa/consumer-scheduler
Archived
7
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated docs
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Pünkösd Marcell
2020-05-14 20:47:52 +02:00
parent 5d2bed0f14
commit 13842daf1c
3 changed files with 96 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/config.rst Normal file
View File

@ -0,0 +1,19 @@
=============
Configuration
=============
This software component can be configured via environmental variables, which are very useful in a containerized environment.
+--------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Variable | Default | Description |
+====================+==========================+=====================================================================================================================================================================+
| `LOCAL_UUID` | **N/A** | The UUID of the consumer system. Must be the same as the API's |
+--------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `RUN_INTERVAL` | 10 | Interval between synchronizations, and local ip checks. |
+--------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `CUSTOMER_TIMEOUT` | 30 | Default timeout to be set for a consumer. If the timeout expires, the consumer will be considered invalid, and no further attempts will be made to contact with it. |
+--------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `REDIS_URL` | redis://localhost:6379/0 | URL of the Redis database shared with the consumer api |
+--------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `INITIAL_SERVERS` | **N/A** | A comma separated list of the initially known consumers (Can be empty, but must be specified) |
+--------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
docs/index.rst
View File

@ -11,9 +11,11 @@ Welcome to Consumer Scheduler's documentation!
:caption: Contents:
readme
config
source/modules
Indices and tables
==================