diff options
author | 2017-02-16 11:17:14 -0800 | |
---|---|---|
committer | 2017-02-20 10:24:49 -0800 | |
commit | 735b8680ee2e546bbaceb9ffb4ae8db043779516 (patch) | |
tree | 4175645f5f8b1c28f14f6df3c2d6310240ded644 /docs/installationprocedure | |
parent | 1d3f16e59458942b4112878d6020b6303296dcec (diff) |
JIRA DOMINO-23
new directory structure
new API description
split documents
Change-Id: Iedffd5266c19f9713930011ef8fde7e55fd3ae66
Signed-off-by: Ulas Kozat <ulas.kozat@gmail.com>
Diffstat (limited to 'docs/installationprocedure')
-rw-r--r-- | docs/installationprocedure/featureconfig.rst | 40 | ||||
-rw-r--r-- | docs/installationprocedure/index.rst | 21 | ||||
-rw-r--r-- | docs/installationprocedure/installation.instructions.rst | 57 |
3 files changed, 0 insertions, 118 deletions
diff --git a/docs/installationprocedure/featureconfig.rst b/docs/installationprocedure/featureconfig.rst deleted file mode 100644 index 5364dbe..0000000 --- a/docs/installationprocedure/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/installationprocedure/index.rst b/docs/installationprocedure/index.rst deleted file mode 100644 index f77c38a..0000000 --- a/docs/installationprocedure/index.rst +++ /dev/null @@ -1,21 +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 -| -| -********************** -Installation procedure -********************** -Colorado 1.0 ------------- - -.. toctree:: - :maxdepth: 2 - - installation.instructions.rst - featureconfig.rst diff --git a/docs/installationprocedure/installation.instructions.rst b/docs/installationprocedure/installation.instructions.rst deleted file mode 100644 index 790a5f0..0000000 --- a/docs/installationprocedure/installation.instructions.rst +++ /dev/null @@ -1,57 +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 -b stable/colorado - -* 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 executables. - -Installation Steps (Multiple Node) ----------------------------------- - -Repeat the installation steps for single node on each node. The script -run_multinode.sh under ./domino/tests directory deploys the Domino Code on three -hosts from a deployment node and tests RPC calls. The private key location and -remote host IP addresses must be manually entered and IS_IPandKEY_CONFIGURED=false -must be changed to IS_IPandKEY_CONFIGURED=true. |