diff options
author | Ulas Kozat <ulas.kozat@gmail.com> | 2016-08-15 07:38:52 -0700 |
---|---|---|
committer | Ulas Kozat <ulas.kozat@gmail.com> | 2016-08-15 12:09:27 -0700 |
commit | f09a95be6e5b734dcd7c35e96456a19caea02e78 (patch) | |
tree | 876b3640867067641f348a52e436d9b30ac34e31 /docs/configguide | |
parent | d84f1836684f74115d7f17d4bde1ee94c8d7a79f (diff) |
Update documentation for Colorado Release
Change-Id: I840237951ed32f23b4dbe8c3cb37bb60a18fc4c6
Signed-off-by: Ulas Kozat <ulas.kozat@gmail.com>
Diffstat (limited to 'docs/configguide')
-rw-r--r-- | docs/configguide/featureconfig.rst | 40 | ||||
-rw-r--r-- | docs/configguide/index.rst | 30 | ||||
-rw-r--r-- | docs/configguide/installation.rst | 55 |
3 files changed, 0 insertions, 125 deletions
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst deleted file mode 100644 index 5364dbe..0000000 --- a/docs/configguide/featureconfig.rst +++ /dev/null @@ -1,40 +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. - -Domino Client -------------- -* The default mode of CLI is non-interactive (i.e., Domino CLI Utility is used). This can be changed when the DominoClient is launched by passing the flags --log or -l followed by the -log level choice from the set {ERROR, WARNING, INFO, DEBUG} (not case sensitive). This overwrites the log level default specified in the configuration file. - -* 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/configguide/index.rst b/docs/configguide/index.rst deleted file mode 100644 index 830d7da..0000000 --- a/docs/configguide/index.rst +++ /dev/null @@ -1,30 +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 -| -| -DOMINO Configuration Guide -========================== - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 2 - - installation.rst - featureconfig.rst - -Indices and tables -================== - -* :ref:`search` - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/configguide/installation.rst b/docs/configguide/installation.rst deleted file mode 100644 index 3a2a7d3..0000000 --- a/docs/configguide/installation.rst +++ /dev/null @@ -1,55 +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 Installation -=================== - -Note: The steps below are tested for Ubuntu (16.04, 14.04) and OS X El Capitan. - -Prerequisites -------------- -* git -* python-pip -* python (version =2.7) -* tosca-parser (version >=0.4.0) -* heat-translator (version >=0.5.0) - -Installation Steps (Single Node) --------------------------------- - -* Step-0: Prepare Environment - -.. code-block:: bash - - > $sudo pip install tosca-parser - > $sudo pip install heat-translator - > $sudo pip install requests - -* Step-1: Get the Domino code - -.. code-block:: bash - - > $git clone https://gerrit.opnfv.org/gerrit/domino - -* Step-2: Go to the main domino directory - -.. code-block:: bash - - > $cd domino - -You should see DominoClient.py, DominoServer.py, and domino-cli.py as executibles. - -Installation Steps (Multiple Node) ----------------------------------- - -Repeat the installation steps for single node on each of the nodes. The script -run_multinode.sh under ./domino/tests directory deploys the Domino Code on three -hosts from a deployment node and tests RPC calls. |