diff --git a/docs/source/index.rst b/docs/source/index.rst index 3cae195ea851d8f8c8cfd31915056321f9993887..05090e0d0cfd12aac0d06dc10e9c5cf42c0f7496 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,6 +10,35 @@ Documentation for the NAT Resource Management tools ------------------ +Configuration file format +--------------------- + +The following example indicates the schema for the configuration file required to call the Resource Management client:: + + { + "mysql":{ + "username":"mydbuser", + "password":"mydbpass", + "hostname":"localhost", + "dbname":"mydb" + }, + "router":{ + "username":"user", + "password":"pass", + "private-key":"/path/to/private/key" + "ssh-config":"/path/to/ssh-config" + } + } + +All "mysql" parameters are mandatory. For "router", username is mandatory, and either password or private-key must be provided. ssh-config is optional. + +Excuting the client +--------------------- + +To create a new router from its fqdn:: + + python3 cli.py create --config /path/to/resource_management_config.json --fqdn test.example.com + .. toctree:: :maxdepth: 1