From 6c80ac7ca497424ec867c86e43159b3e7f5800c0 Mon Sep 17 00:00:00 2001 From: agardner Date: Thu, 30 Mar 2017 15:16:55 -0400 Subject: bring danube branch up to date with master Gerrit doesn't like merge commits eg: this wont work git merge origin/master --no-commit git commit -sv git review stable/danube So I took the diff git diff origin/stable/danube..master and checked out the files that were changed git checkout origin/master -- featureconfig.rst normally you should checkout the change sets and resolve the merge conflitcs, but in this case we dont care. Change-Id: I2a02e8ae7237825911f22663a5c65cdb9f5c5e4f Signed-off-by: agardner --- docs/release/configguide/featureconfig.rst | 36 +++++++++++++++++++++++ docs/release/configguide/index.rst | 14 +++++++++ docs/release/index.rst | 20 +++++++++++++ docs/release/installation/featureconfig.rst | 43 ---------------------------- docs/release/installation/index.rst | 22 +++++--------- docs/release/userguide/feature.userguide.rst | 1 + docs/release/userguide/index.rst | 5 ++-- 7 files changed, 81 insertions(+), 60 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 (limited to 'docs/release') diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst new file mode 100644 index 0000000..6d2056c --- /dev/null +++ b/docs/release/configguide/featureconfig.rst @@ -0,0 +1,36 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV + +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..c240a91 --- /dev/null +++ b/docs/release/configguide/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV + +.. _domino-configguide: + +************************** +Domino Configuration Guide +************************** + +.. toctree:: + :maxdepth: 2 + + featureconfig.rst diff --git a/docs/release/index.rst b/docs/release/index.rst new file mode 100644 index 0000000..eb21134 --- /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 a8a0a0a..db9f506 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -1,23 +1,15 @@ -.. _domino-installation: - .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV + +.. _domino-installation: -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left -| -| -********************** -Installation procedure -********************** -Colorado 1.0 ------------- +******************************* +Domino Installation Instruction +******************************* .. toctree:: :maxdepth: 2 + :numbered: installation.instructions.rst - featureconfig.rst diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst index 6187a22..8705a77 100644 --- a/docs/release/userguide/feature.userguide.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV ======================================== Domino API Usage Guidelines and Examples diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst index 510fb38..7372cb3 100644 --- a/docs/release/userguide/index.rst +++ b/docs/release/userguide/index.rst @@ -1,7 +1,8 @@ -.. _domino-userguide: - .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV + +.. _domino-userguide: ***************** Domino User Guide -- cgit 1.2.3-korg