From 41f6d348f527bda798c5de061d9c53d149a294b6 Mon Sep 17 00:00:00 2001 From: Ulas Kozat Date: Wed, 29 Mar 2017 12:27:29 -0700 Subject: JIRA 23: Update documentation Change-Id: I11e9ec7f0684b4ebcae8fba0fdfb50c73a5d0bf2 Signed-off-by: Ulas Kozat --- docs/development/overview/index.rst | 4 +-- docs/release/configguide/featureconfig.rst | 35 +++++++++++++++++++++++ docs/release/configguide/index.rst | 13 +++++++++ docs/release/index.rst | 20 ++++++++++++++ docs/release/installation/featureconfig.rst | 43 ----------------------------- docs/release/installation/index.rst | 15 ++-------- docs/release/userguide/index.rst | 4 +-- 7 files changed, 75 insertions(+), 59 deletions(-) create mode 100644 docs/release/configguide/featureconfig.rst create mode 100644 docs/release/configguide/index.rst create mode 100644 docs/release/index.rst delete mode 100644 docs/release/installation/featureconfig.rst diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst index 2492146..aeb8ed6 100644 --- a/docs/development/overview/index.rst +++ b/docs/development/overview/index.rst @@ -1,8 +1,8 @@ -.. _domino-overview: - .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _domino-overview: + *********************** Domino Project Overview *********************** diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst new file mode 100644 index 0000000..acbe6ba --- /dev/null +++ b/docs/release/configguide/featureconfig.rst @@ -0,0 +1,35 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Domino Configuration +==================== +Domino Server and Clients can be configured via (i) passing command line options +(see API documentation) and (ii) the configuration file "domino_conf.py" under the +main directory. + +* The default file for logging is set as none and log level set as "WARNING". + +Domino Server +------------- +* The default server unique user ID is set as 0 in the configuration file. + +* The default TCP port for RPC calls is set as 9090 in the configuration file. + +* The default database file for Domino Server is set as "dominoserver.db" under the main directory + +* The default folder for keeping published TOSCA files and pushed parts is set as "toscafiles" in the configuration file via variable TOSCADIR. + +* The default log level (WARNING) can be changed by passing the flags --log or -l followed by a log level, e.g., ERROR, WARNING, INFO, or DEBUG. + +Domino Client +------------- +* The default mode of CLI is non-interactive (i.e., Domino CLI Utility is used). Passing --iac=TRUE would begin the client in interactive mode. + +* The default log level (WARNING) can be changed by passing the flags --log or -l followed by a log level, e.g., ERROR, WARNING, INFO, or DEBUG. + +* The default Domino Server IP is set as "localhost". This can be overwritten at the time of launching DominoClient via the option flags -i or --ipaddr followed by the IP address of the actual server hosting the Domino Server. + +* The default Domino Client TCP port for RPC calls is set as 9091 in the configuration file. It can be overwritten when the DominoClient is launched by passing the flags --port or -p followed by the port number. + +* The default folder for keeping preceived TOSCA files is set as "toscafiles" in the configuration file via variable TOSCA_RX_DIR. + diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 0000000..9cc5c6c --- /dev/null +++ b/docs/release/configguide/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. _domino-configguide: + +************* +Configuration +************* + +.. toctree:: + :maxdepth: 2 + + featureconfig.rst diff --git a/docs/release/index.rst b/docs/release/index.rst new file mode 100644 index 0000000..c0b1b56 --- /dev/null +++ b/docs/release/index.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV. + + +====== +Domino +====== + +.. toctree:: + :maxdepth: 2 + :numbered: + + ./installation/index.rst + ./configguide/index.rst + ./userguide/index.rst + +Indices +======= +* :ref:`search` diff --git a/docs/release/installation/featureconfig.rst b/docs/release/installation/featureconfig.rst deleted file mode 100644 index e47e0c0..0000000 --- a/docs/release/installation/featureconfig.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left -.. these two pipes are to seperate the logo from the first title -| -| -Domino Configuration -==================== -Domino Server and Clients can be configured via (i) passing command line options -(see API documentation) and (ii) the configuration file "domino_conf.py" under the -main directory. - -* The default file for logging is set as none and log level set as "WARNING". - -Domino Server -------------- -* The default server unique user ID is set as 0 in the configuration file. - -* The default TCP port for RPC calls is set as 9090 in the configuration file. - -* The default database file for Domino Server is set as "dominoserver.db" under the main directory - -* The default folder for keeping published TOSCA files and pushed parts is set as "toscafiles" in the configuration file via variable TOSCADIR. - -* The default log level (WARNING) can be changed by passing the flags --log or -l followed by a log level, e.g., ERROR, WARNING, INFO, or DEBUG. - -Domino Client -------------- -* The default mode of CLI is non-interactive (i.e., Domino CLI Utility is used). Passing --iac=TRUE would begin the client in interactive mode. - -* The default log level (WARNING) can be changed by passing the flags --log or -l followed by a log level, e.g., ERROR, WARNING, INFO, or DEBUG. - -* The default Domino Server IP is set as "localhost". This can be overwritten at the time of launching DominoClient via the option flags -i or --ipaddr followed by the IP address of the actual server hosting the Domino Server. - -* The default Domino Client TCP port for RPC calls is set as 9091 in the configuration file. It can be overwritten when the DominoClient is launched by passing the flags --port or -p followed by the port number. - -* The default folder for keeping preceived TOSCA files is set as "toscafiles" in the configuration file via variable TOSCA_RX_DIR. - diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index a3a595f..72b2d51 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -1,23 +1,14 @@ -.. _domino-installation: - .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left -| -| +.. _domino-installation: + ********************** Installation procedure ********************** -Danube 1.0 ------------- .. toctree:: :maxdepth: 2 + :numbered: installation.instructions.rst - featureconfig.rst diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst index 510fb38..a37fc09 100644 --- a/docs/release/userguide/index.rst +++ b/docs/release/userguide/index.rst @@ -1,8 +1,8 @@ -.. _domino-userguide: - .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _domino-userguide: + ***************** Domino User Guide ***************** -- cgit 1.2.3-korg