docs/userguide/rubbos/rubbos_installation.rst

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