Fix up the tables and one example

Change-Id: Icda00a84c8c10f24615616fedcb63c96c1e10be1
This commit is contained in:
Mark Hamzy 2016-10-28 10:18:09 -05:00
parent c6e60848aa
commit 93f275a7a6
1 changed files with 15 additions and 3 deletions

View File

@ -38,13 +38,19 @@ MoltenIron commands
+----------+---------------------------------------------+
|command | description |
+----------+---------------------------------------------+
+==========+=============================================+
|add | Add a node |
+----------+---------------------------------------------+
|allocate | Allocate a node |
+----------+---------------------------------------------+
|release | Release a node |
+----------+---------------------------------------------+
|get_field | Get a specific field in a node |
+----------+---------------------------------------------+
|set_field | Set a specific field with a value in a node |
+----------+---------------------------------------------+
|status | Return the status of every node |
+----------+---------------------------------------------+
|delete_db | Delete every database entry |
+----------+---------------------------------------------+
@ -59,17 +65,23 @@ it is only required for the server.
+------+------------+----------------------------------------------------------+
|usage | key | description |
+------+------------+----------------------------------------------------------+
+======+============+==========================================================+
|B) | mi_port | the port that the server uses to respond to commands. |
+------+------------+----------------------------------------------------------+
|C) | serverIP | The IP address of the server. This is only used by |
| | | clients. |
+------+------------+----------------------------------------------------------+
|S) | maxTime | The maximum amount of time, in seconds, that a node |
| | | is allowed to be allocated to a particular BM node. |
+------+------------+----------------------------------------------------------+
|S) | logdir | The path to the directory where the logs should be |
| | | stored. |
+------+------------+----------------------------------------------------------+
|S) | maxLogDays | The amount of time, in days, to keep old logs. |
+------+------------+----------------------------------------------------------+
|S) | sqlUser | The username to use for the MI server. This user |
| | | will automatically be generated when createDB.py is run. |
+------+------------+----------------------------------------------------------+
|S) | sqlPass | The password of sqlUser |
+------+------------+----------------------------------------------------------+
@ -78,7 +90,7 @@ Running testcases
The suite of testcases is checked by tox. But, before you can run tox, you
need to change the local yaml configuration file to point to the log
directory.
directory. An example::
(LOG=$(pwd)/testenv/log; sed -i -r -e 's,^(logdir: )(.*)$,\1'${LOG}',' conf.yaml; rm -rf testenv/; tox -e testenv)