docs/installationprocedure/rubbos_installation.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) Huawei Technologies Co.,Ltd and others.
   4
   5 **************************************
   6 Bottlenecks Rubbos Installation Guide
   7 **************************************
   8
   9
  10 Rubbos Introduction
  11 ====================
  12 Rubbos is a bulletin board benchmark modeled after an online news forum like Slashdot.
  13 It is an open source Middleware and an n-tier system model which
  14 is used to be deployed on multiple physical node and
  15 to measure the whole performacne of OPNFV platform.
  16 Rubbos can deploy the Apache, tomcat, and DB.
  17 Based on the deployment, rubbos gives the pressure to the whole system.
  18 When the system reaches to the peak, the throughput will not grow more.
  19 This testcase can help to understand the bottlenecks of OPNFV plantform
  20 and improve the performance of OPNFV platform.
  21
  22 Detailed workflow is illutrated below.
  23
  24 .. image:: ../images/Framework_Setup.png
  25    :width: 770px
  26    :alt: Bottlenecks Framework Setup
  27
  28 Preinstall Packages
  29 ====================
  30 There is a need to install some packages before running the rubbos,
  31 gcc, gettext, g++, libaio1, libaio-dev, make and git are necessary.
  32 When the rubbos runs on the OPNFV community continuous integration(CI)
  33 system, the required packages are installed automately as shown in the
  34 code repository, which is /utils/infra_setup/vm_dev_setup/packages.conf,
  35 besides, the packages can be encapsulated in the images initially.
  36 If someone wants to use rubbos locally, he/she has to install them by
  37 hand, such as in ubuntu 14.04,
  38
  39 .. code-block:: bash
  40
  41     apt-get update
  42     apt-get install gettext
  43
  44 How does Rubbos Integrate into Installers
  45 =========================================
  46 1.Community CI System
  47
  48 Rubbos has been successfully integrated into fuel and compass with NOSDN scenario
  49 in OPNFV community CI system.
  50
  51 Heat is used to create 9 instances, which is shown in
  52 /utils/infra_setup/heat_template/HOT_create_instance.sh, the 9 instances are used
  53 for installing Apache, Tomcat, Mysql, Control, Benchmark and 4 Clients. The tools,
  54 such as rubbos, sysstat, oprofile, etc, are installed in these instances to perform
  55 the test, the test results are stored in the Benchmark instance initially, then they
  56 are copied to the Rubbos_result instance, finally, the test results are transferred to
  57 the community dashboard.
  58
  59 There's a need to store our pakages as large as M bytes or G bytes size, such as
  60 the images, jdk, apache-ant, apache-tomcat, etc, the OPNFV community storage system,
  61 Google Cloud Storage, is used, the pakages can be downloaded from
  62 https://artifacts.opnfv.org/bottlenecks/rubbos.
  63
  64 2.Local Deployment
  65
  66 If someone wants to run the rubbos in his own environment, he/she can keep to the following steps,
  67
  68 2.1 Start up instances by using heat, nova or libvert. In Openstack Environemnt,
  69 the heat script can refer /utils/infra_setup/heat_template/HOT_create_instance.sh,
  70 if the openstack doesn't support heat module,
  71 the script /utils/infra_setup/create_instance.sh can be used.
  72 Without Openstack, there's a way to set up instances by using libvert, the scripts are shown under
  73 the directory /utils/rubbos_dev_env_setup.
  74
  75 The image can be downloaded from the community cloud storage
  76
  77 .. code-block:: bash
  78
  79     curl --connect-timeout 10 -o bottlenecks-trusty-server.img
  80          http://artifacts.opnfv.org/bottlenecks/rubbos/bottlenecks-trusty-server.img
  81
  82 2.2 Ssh into the control node and clone the bottlenecks codes to the root directory.
  83
  84 .. code-block:: bash
  85
  86     git clone https://git.opnfv.org/bottlenecks /bottlenecks
  87
  88 2.3 Download the packages and decompress them into the proper directory.
  89
  90 .. code-block:: bash
  91
  92     curl --connect-timeout 10 -o app_tools.tar.gz
  93          http://artifacts.opnfv.org/bottlenecks/rubbos/app_tools.tar.gz
  94     curl --connect-timeout 10 -o rubbosMulini6.tar.gz
  95          http://artifacts.opnfv.org/bottlenecks/rubbos/rubbosMulini6.tar.gz
  96
  97 .. code-block:: bash
  98
  99     tar zxf app_tools.tar.gz -C /bottlenecks/rubbos
 100     tar zxf rubbosMulini6.tar.gz -C /bottlenecks/rubbos/rubbos_scripts
 101
 102 2.4 Ssh into the Control node and run the script
 103
 104 .. code-block:: bash
 105
 106     source /bottlenecks/rubbos/rubbos_scripts/1-1-1/scripts/run.sh
 107
 108 2.5 Check the test results under the directory /bottlenecks/rubbos/rubbos_results in
 109 Control node. The results are stored in the format of xml,
 110 move them to the brower chrome, then you can see the results.
 111
 112 Test Result Description
 113 =======================
 114 In OPNFV community, the result is shown in the following format
 115
 116 ::
 117
 118    [{'client': 200, 'throughput': 27},
 119     {'client': 700, 'throughput': 102},
 120     {'client': 1200, 'throughput': 177},
 121     {'client': 1700, 'throughput': 252},
 122     {'client': 2200, 'throughput': 323},
 123     {'client': 2700, 'throughput': 399},
 124     {'client': 3200, 'throughput': 473}]
 125
 126 The results are transferred to the community database and a map is drawed on the dashboard.
 127 Along with the growth of the number of the client, the throughput grows at first, then meets
 128 up with a point of inflexion, which is caused by the bottlenecks of the measured system.