--- /dev/null
+| Calipso.io\r
+| Installation Guide\r
+\r
+|image0|\r
+\r
+Project “Calipso” tries to illuminate complex virtual networking with\r
+real time operational state visibility for large and highly distributed\r
+Virtual Infrastructure Management (VIM).\r
+\r
+We believe that Stability is driven by accurate Visibility.\r
+\r
+Calipso provides visible insights using smart discovery and virtual\r
+topological representation in graphs, with monitoring per object in the\r
+graph inventory to reduce error vectors and troubleshooting, maintenance\r
+cycles for VIM operators and administrators.\r
+\r
+Table of Contents\r
+\r
+Calipso.io Installation Guide 1\r
+\r
+1 Pre Requisites 3\r
+\r
+1.1 Pre Requisites for Calipso “all in one” application 3\r
+\r
+1.2 Pre Requisites for Calipso UI application 3\r
+\r
+2 Installation Option used with Apex 4\r
+\r
+2.1 Micro Services App, single line install 4\r
+\r
+3 OPNFV Scenario 5\r
+\r
+3.1 APEX automatic configurator and setup 5\r
+\r
+3.2 Apex scenario 5\r
+\r
+3.3 Calipso functest 6\r
+\r
+TBD 6\r
+\r
+Pre Requisites \r
+===============\r
+\r
+Pre Requisites for Calipso “all in one” application \r
+----------------------------------------------------\r
+\r
+ Calipso’s main application is written with Python3.5 for Linux\r
+ Servers, tested successfully on Centos 7.3 and Ubuntu 16.04. When\r
+ running using micro-services many of the required software packages\r
+ and libraries are delivered per micro service, but for an “all in\r
+ one” application case there are several dependencies.\r
+\r
+ Here is a list of the required software packages, and the official\r
+ supported steps required to install them:\r
+\r
+1. Python3.5.x for Linux :\r
+ https://docs.python.org/3.5/using/unix.html#on-linux\r
+\r
+2. Pip for Python3 : https://docs.python.org/3/installing/index.html\r
+\r
+3. Python3 packages to install using pip3 :\r
+\r
+ **sudo pip3 install falcon (>1.1.0)**\r
+\r
+ **sudo pip3 install pymongo (>3.4.0)**\r
+\r
+ **sudo pip3 install gunicorn (>19.6.0)**\r
+\r
+ **sudo pip3 install ldap3 (>2.1.1)**\r
+\r
+ **sudo pip3 install setuptools (>34.3.2)**\r
+\r
+ **sudo pip3 install python3-dateutil (>2.5.3-2)**\r
+\r
+ **sudo pip3 install bcrypt (>3.1.1)**\r
+\r
+ **sudo pip3 install bson**\r
+\r
+ **sudo pip3 install websocket**\r
+\r
+ **sudo pip3 install datetime**\r
+\r
+ **sudo pip3 install typing**\r
+\r
+ **sudo pip3 install kombu**\r
+\r
+ **sudo pip3 install boltons**\r
+\r
+ **sudo pip3 install paramiko**\r
+\r
+ **sudo pip3 install requests **\r
+\r
+ **sudo pip3 install httplib2**\r
+\r
+ **sudo pip3 install mysql.connector**\r
+\r
+ **sudo pip3 install xmltodict**\r
+\r
+ **sudo pip3 install cryptography**\r
+\r
+ **sudo pip3 install docker**\r
+\r
+1. Git : https://git-scm.com/book/en/v2/Getting-Started-Installing-Git\r
+\r
+2. Docker : https://docs.docker.com/engine/installation/\r
+\r
+Pre Requisites for Calipso UI application \r
+------------------------------------------\r
+\r
+ Calipso UI is developed and maintained using Meteor Framework\r
+ (https://www.meteor.com/tutorials). For stability and manageability\r
+ reasons we decided to always build the latest Calipso UI as a Docker\r
+ container pre-parameterized for stable and supported behavior. The\r
+ required steps for installing the Calipso UI with several options\r
+ are listed below.\r
+\r
+Installation Option used with Apex\r
+==================================\r
+\r
+Micro Services App, single line install\r
+---------------------------------------\r
+\r
+ For most users, this will be the fastest and more reliable install\r
+ option. We currently have Calipso divided into 7 major containers,\r
+ those are installed using a single installer. The Calipso containers\r
+ are pre-packaged and fully customized per our design needs. Here are\r
+ the required steps for installation using this option:\r
+\r
+1. Follow steps 1- 5 per section 2.1 above.\r
+\r
+2. Install Docker : https://docs.docker.com/engine/installation/\r
+\r
+3. Install the following python3 libraries using pip3 : docker, pymongo\r
+\r
+4. Although Calipso installer can download all needed containers, if\r
+ they doesn’t exist locally already, we recommend doing a manual\r
+ download of all 7 containers, providing better control and logging:\r
+\r
+ **sudo docker login** # use your DockerHub username and password to\r
+ login.\r
+\r
+ **sudo docker pull korenlev/calipso:scan** # scan container used to\r
+ scan VIM\r
+\r
+ **sudo docker pull korenlev/calipso:listen** # listen container to\r
+ attach to VIM’s BUS.\r
+\r
+ **sudo docker pull korenlev/calipso:api** # api container for\r
+ application integration\r
+\r
+ **sudo docker pull korenlev/calipso:sensu** # sensu server container\r
+ for monitoring\r
+\r
+ **sudo docker pull korenlev/calipso:mongo** # calipso mongo DB\r
+ container\r
+\r
+ **sudo docker pull korenlev/calipso:ui** # calipso ui container\r
+\r
+ **sudo docker pull korenlev/calipso:ldap** # calipso ldap container\r
+\r
+1. Check that all containers were downloaded and registered\r
+ successfully:\r
+\r
+ **sudo docker images**\r
+\r
+ Expected results (As of Aug 2017):\r
+\r
+ **REPOSITORY TAG IMAGE ID CREATED SIZE**\r
+\r
+ **korenlev/calipso listen 12086aaedbc3 6 hours ago 1.05GB**\r
+\r
+ **korenlev/calipso api 34c4c6c1b03e 6 hours ago 992MB**\r
+\r
+ **korenlev/calipso scan 1ee60c4e61d5 6 hours ago 1.1GB**\r
+\r
+ **korenlev/calipso sensu a8a17168197a 6 hours ago 1.65GB**\r
+\r
+ **korenlev/calipso mongo 17f2d62f4445 22 hours ago 1.31GB**\r
+\r
+ **korenlev/calipso ui ab37b366e812 11 days ago 270MB**\r
+\r
+ **korenlev/calipso ldap 316bc94b25ad 2 months ago 269MB**\r
+\r
+1. Run the calipso installer using single line arguments:\r
+\r
+ **python3 calipso/app/install/calipso-installer.py--command\r
+ start-all --copy q**\r
+\r
+ This should launch all calipso modules in sequence along with all\r
+ needed configuration files placed in /home/calipso.\r
+\r
+OPNFV Scenario \r
+===============\r
+\r
+Although calipso is designed for any VIM and for enterprise use-cases\r
+too, service providers can use additional capability to install calipso\r
+with Apex for OPNFV.\r
+\r
+APEX automatic configurator and setup\r
+-------------------------------------\r
+\r
+ When using apex to install OPNFV, the Triple-O based OpenStack is\r
+ installed automatically and calipso installation can be initiated\r
+ automatically after apex completes the VIM installation process for\r
+ a certain scenario.\r
+\r
+ In this case setup\_apex\_environment.py can be used for creating a\r
+ new environment automatically into mongoDB and UI of Calipso\r
+ (instead of using the calipso UI to do that as typical user would\r
+ do), then detailed scanning can start immediately, the following\r
+ options are available for setup\_apex\_environment.py:\r
+\r
+ **-m [MONGO\_CONFIG], --mongo\_config [MONGO\_CONFIG]**\r
+\r
+ **name of config file with MongoDB server access details**\r
+\r
+ **(Default: /local\_dir/calipso\_mongo\_access.conf)**\r
+\r
+ **-d [CONFIG\_DIR], --config\_dir [CONFIG\_DIR]**\r
+\r
+ **path to directory with config data (Default:**\r
+\r
+ **/home/calipso/apex\_setup\_files)**\r
+\r
+ **-i [INSTALL\_DB\_DIR], --install\_db\_dir [INSTALL\_DB\_DIR]**\r
+\r
+ **path to directory with DB data (Default:**\r
+\r
+ **/home/calipso/Calipso/app/install/db)**\r
+\r
+ **-a [APEX], --apex [APEX]**\r
+\r
+ **name of environment to Apex host**\r
+\r
+ **-e [ENV], --env [ENV]**\r
+\r
+ **name of environment to create(Default: Apex-Euphrates)**\r
+\r
+ **-l [LOGLEVEL], --loglevel [LOGLEVEL]**\r
+\r
+ **logging level (default: "INFO")**\r
+\r
+ **-f [LOGFILE], --logfile [LOGFILE]**\r
+\r
+ **log file (default:**\r
+\r
+ **"/home/calipso/log/apex\_environment\_fetch.log")**\r
+\r
+ **-g [GIT], --git [GIT]**\r
+\r
+ **URL to clone Git repository (default:**\r
+\r
+ **https://git.opnfv.org/calipso)**\r
+\r
+Apex scenario\r
+-------------\r
+\r
+ Starting Euphrates 1.0 the following scenario added with Apex\r
+ installer:\r
+\r
+ **os-nosdn-calipso-noha**\r
+\r
+ Following CI jobs defined:\r
+\r
+ https://build.opnfv.org/ci/job/calipso-verify-euphrates/\r
+\r
+ https://build.opnfv.org/ci/job/apex-testsuite-os-nosdn-calipso-noha-baremetal-euphrates/\r
+\r
+ https://build.opnfv.org/ci/job/apex-os-nosdn-calipso-noha-baremetal-euphrates/\r
+\r
+ Note: destination deploy server needs to have pre-requisites\r
+ detailed above.\r
+\r
+Calipso functest\r
+----------------\r
+\r
+TBD \r
+----\r
+\r
+.. |image0| image:: media/image1.png\r
+ :width: 6.50000in\r
+ :height: 4.27153in\r
Code Review / calipso.git / commitdiff