From 9f614b8363d7f4ff6ac216914e86759809ddc876 Mon Sep 17 00:00:00 2001 From: Koren Lev Date: Wed, 4 Oct 2017 18:54:28 +0300 Subject: docs and installer updates Change-Id: I357626cc8b78aa374043b0a608bcb9695568e480 Signed-off-by: Koren Lev --- app/install/calipso-installer.py | 4 +-- docs/release/calipso-model.pdf | Bin 425202 -> 425368 bytes docs/release/calipso-model.rst | 8 +++--- docs/release/install-guide.pdf | Bin 149319 -> 151053 bytes docs/release/install-guide.rst | 56 ++++++++++++++++++++++++++++++--------- 5 files changed, 51 insertions(+), 17 deletions(-) diff --git a/app/install/calipso-installer.py b/app/install/calipso-installer.py index be7b772..84b10da 100644 --- a/app/install/calipso-installer.py +++ b/app/install/calipso-installer.py @@ -342,7 +342,7 @@ parser.add_argument("--uchiwaport", default="3000", required=False) parser.add_argument("--rabbitmport", - help="Port for the Calipso Sensu RabbitMQ Managment " + help="Port for the Calipso Sensu RabbitMQ Management " "(default=15672)", type=int, default="15672", @@ -354,7 +354,7 @@ parser.add_argument("--sensuport", default="4567", required=False) parser.add_argument("--rabbitport", - help="Port for the Calipso Sensu RabbitMQ " + help="Port for the Calipso Sensu RabbitMQ BUS" "(default=5671)", type=int, default="5671", diff --git a/docs/release/calipso-model.pdf b/docs/release/calipso-model.pdf index 7587147..cd1c2b3 100644 Binary files a/docs/release/calipso-model.pdf and b/docs/release/calipso-model.pdf differ diff --git a/docs/release/calipso-model.rst b/docs/release/calipso-model.rst index d7ee8f7..e531271 100644 --- a/docs/release/calipso-model.rst +++ b/docs/release/calipso-model.rst @@ -786,9 +786,8 @@ have the “network” attribute. Connection\_tests ----------------- -This collection keeps requests from the UI to test the different -adapters (API, DB, CLI etc) connections to the underlying VIM, making -sure dynamic and real-time data is maintained. +This collection keeps requests from the UI or API to test the different adapters (API, DB, and CLI etc) +and their connections to the underlying VIM, making sure dynamic and real-time data will be maintained during discovery. Messages -------- @@ -915,6 +914,9 @@ Constants-scan\_object\_types Object\_types used during scanning, see development-guide for details. +Constants-configuration_targets +Names of the configuration targets used in the configuration section of environment configs. + .. |image0| image:: media/image1.png :width: 6.50000in :height: 4.27153in diff --git a/docs/release/install-guide.pdf b/docs/release/install-guide.pdf index 7d3cd57..1bc24f5 100644 Binary files a/docs/release/install-guide.pdf and b/docs/release/install-guide.pdf differ diff --git a/docs/release/install-guide.rst b/docs/release/install-guide.rst index e3dfda9..a481f60 100644 --- a/docs/release/install-guide.rst +++ b/docs/release/install-guide.rst @@ -284,6 +284,21 @@ Calipso.io Installation Guide 1 Allows to enter a password to be used for mongoDB access on the host, an optional argument, default ‘calipso\_default’ (calipso-mongo container’s default) is deployed if not used. + +8. **--apiport ** + Allows to enter a TCP port to be used for the Calipso API (default=8000) + +9. **--uchiwaport ** + Allows to enter a TCP port to be used for the Sensu UI (default=3000) + +10. **--rabbitmport ** + Allows to enter a TCP port to be used for the RabbitMQ mgmt (default=15672) + +11. **--sensuport ** + Allows to enter a TCP port to be used for the Sensu API (default=4567) + +12. **--rabbitport ** + Allows to enter a TCP port to be used for the RabbitMQ BUS (default=5671) 2.4 Micro Services App, customized interactive install -------------------------------------------------- @@ -318,18 +333,35 @@ with Apex for OPNFV. APEX scenarios --------------- - When using apex to install OPNFV, the Triple-O based OpenStack is - installed automatically and calipso installation can be initiated - automatically after apex completes the VIM installation process for - a certain scenario. - - In this case calipso-configuration.py can be used for creating a new - environment automatically into mongoDB and UI of Calipso (instead of - using the calipso UI to do that as typical user would do), then - detailed scanning can start immediately, the following options are - available for calipso-configuration.py: - - TBD +When using apex to install OPNFV, the Triple-O based OpenStack is +installed automatically and calipso installation can be initiated +automatically after apex completes the VIM installation process for +a certain scenario. + +In this case setup_apex_environment.py can be used for creating a new environment automatically into mongoDB and UI of Calipso, +instead of using the calipso UI to do that as typical user would do, then detailed scanning can start immediately, +the following options are available for setup_apex_environment.py: + -m [MONGO_CONFIG], --mongo_config [MONGO_CONFIG] + name of config file with MongoDB server access details + (Default: /local_dir/calipso_mongo_access.conf) + -d [CONFIG_DIR], --config_dir [CONFIG_DIR] + path to directory with config data (Default: + /home/calipso/apex_setup_files) + -i [INSTALL_DB_DIR], --install_db_dir [INSTALL_DB_DIR] + path to directory with DB data (Default: + /home/calipso/Calipso/app/install/db) + -a [APEX], --apex [APEX] + name of environment to Apex host + -e [ENV], --env [ENV] + name of environment to create(Default: Apex-Euphrates) + -l [LOGLEVEL], --loglevel [LOGLEVEL] + logging level (default: "INFO") + -f [LOGFILE], --logfile [LOGFILE] + log file (default: + "/home/calipso/log/apex_environment_fetch.log") + -g [GIT], --git [GIT] + URL to clone Git repository (default: + https://git.opnfv.org/calipso) Fuel scenarios --------------- -- cgit 1.2.3-korg