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