From 93f275a7a6fc86734036abc5badc50b9175ec04c Mon Sep 17 00:00:00 2001 From: Mark Hamzy Date: Fri, 28 Oct 2016 10:18:09 -0500 Subject: [PATCH] Fix up the tables and one example Change-Id: Icda00a84c8c10f24615616fedcb63c96c1e10be1 --- README.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 5a2ac45..9c39418 100644 --- a/README.rst +++ b/README.rst @@ -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)