add yardstick iruya 9.0.0 release notes
[yardstick.git] / docs / testing / user / userguide / opnfv_yardstick_tc089.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International
2 .. License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, Yin Kanglin and others.
5 .. 14_ykl@tongji.edu.cn
6
7 *************************************
8 Yardstick Test Case Description TC089
9 *************************************
10
11 +-----------------------------------------------------------------------------+
12 |Control Node Openstack Service High Availability - Nova Conductor            |
13 |                                                                             |
14 +--------------+--------------------------------------------------------------+
15 |test case id  | OPNFV_YARDSTICK_TC089: Control node Openstack service down - |
16 |              | nova conductor                                               |
17 +--------------+--------------------------------------------------------------+
18 |test purpose  | This test case will verify the high availability of the      |
19 |              | compute database proxy service provided by OpenStack (nova-  |
20 |              | conductor) on control node.                                  |
21 |              |                                                              |
22 +--------------+--------------------------------------------------------------+
23 |test method   | This test case kills the processes of nova-conductor service |
24 |              | on a selected control node, then checks whether the request  |
25 |              | of the related OpenStack command is OK and the killed        |
26 |              | processes are recovered.                                     |
27 |              |                                                              |
28 +--------------+--------------------------------------------------------------+
29 |attackers     | In this test case, an attacker called "kill-process" is      |
30 |              | needed. This attacker includes three parameters:             |
31 |              | 1) fault_type: which is used for finding the attacker's      |
32 |              | scripts. It should be always set to "kill-process" in this   |
33 |              | test case.                                                   |
34 |              | 2) process_name: which is the process name of the specified  |
35 |              | OpenStack service. If there are multiple processes use the   |
36 |              | same name on the host, all of them are killed by this        |
37 |              | attacker.                                                    |
38 |              | In this case. This parameter should always set to "nova-     |
39 |              | conductor".                                                  |
40 |              | 3) host: which is the name of a control node being attacked. |
41 |              |                                                              |
42 |              | e.g.                                                         |
43 |              | -fault_type: "kill-process"                                  |
44 |              | -process_name: "nova-conductor"                              |
45 |              | -host: node1                                                 |
46 |              |                                                              |
47 +--------------+--------------------------------------------------------------+
48 |monitors      | In this test case, one kind of monitor is needed:            |
49 |              | 1. the "process" monitor check whether a process is running  |
50 |              | on a specific node, which needs three parameters:            |
51 |              | 1) monitor_type: which used for finding the monitor class and|
52 |              | related scripts. It should be always set to "process"        |
53 |              | for this monitor.                                            |
54 |              | 2) process_name: which is the process name for monitor       |
55 |              | 3) host: which is the name of the node running the process   |
56 |              |                                                              |
57 |              | e.g.                                                         |
58 |              | monitor:                                                     |
59 |              | -monitor_type: "process"                                     |
60 |              | -process_name: "nova-conductor"                              |
61 |              | -host: node1                                                 |
62 |              |                                                              |
63 +--------------+--------------------------------------------------------------+
64 |operations    | In this test case, the following operations are needed:      |
65 |              | 1. "nova-create-instance": create a VM instance to check     |
66 |              | whether the nova-conductor works normally.                   |
67 |              |                                                              |
68 +--------------+--------------------------------------------------------------+
69 |metrics       | In this test case, there are one metric:                     |
70 |              | 1)process_recover_time: which indicates the maximum time     |
71 |              | (seconds) from the process being killed to recovered         |
72 |              |                                                              |
73 +--------------+--------------------------------------------------------------+
74 |test tool     | Developed by the project. Please see folder:                 |
75 |              | "yardstick/benchmark/scenarios/availability/ha_tools"        |
76 |              |                                                              |
77 +--------------+--------------------------------------------------------------+
78 |references    | ETSI NFV REL001                                              |
79 |              |                                                              |
80 +--------------+--------------------------------------------------------------+
81 |configuration | This test case needs two configuration files:                |
82 |              | 1) test case file: opnfv_yardstick_tc089.yaml                |
83 |              | -Attackers: see above "attackers" description                |
84 |              | -waiting_time: which is the time (seconds) from the process  |
85 |              | being killed to stopping monitors the monitors               |
86 |              | -Monitors: see above "monitors" description                  |
87 |              | -SLA: see above "metrics" description                        |
88 |              |                                                              |
89 |              | 2)POD file: pod.yaml                                         |
90 |              | The POD configuration should record on pod.yaml first.       |
91 |              | the "host" item in this test case will use the node name in  |
92 |              | the pod.yaml.                                                |
93 |              |                                                              |
94 +--------------+--------------------------------------------------------------+
95 |test sequence | description and expected result                              |
96 |              |                                                              |
97 +--------------+--------------------------------------------------------------+
98 |step 1        | do attacker: connect the host through SSH, and then execute  |
99 |              | the kill process script with param value specified by        |
100 |              | "process_name"                                               |
101 |              |                                                              |
102 |              | Result: Process will be killed.                              |
103 |              |                                                              |
104 +--------------+--------------------------------------------------------------+
105 |step 2        | start monitors:                                              |
106 |              | each monitor will run with independently process             |
107 |              |                                                              |
108 |              | Result: The monitor info will be collected.                  |
109 |              |                                                              |
110 +--------------+--------------------------------------------------------------+
111 |step 3        | create a new instance to check whether the nova conductor    |
112 |              | works normally.                                              |
113 |              |                                                              |
114 +--------------+--------------------------------------------------------------+
115 |step 4        | stop the monitor after a period of time specified by         |
116 |              | "waiting_time"                                               |
117 |              |                                                              |
118 |              | Result: The monitor info will be aggregated.                 |
119 |              |                                                              |
120 +--------------+--------------------------------------------------------------+
121 |post-action   | It is the action when the test cases exist. It will check the|
122 |              | status of the specified process on the host, and restart the |
123 |              | process if it is not running for next test cases             |
124 |              |                                                              |
125 +--------------+--------------------------------------------------------------+
126 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
127 |              | execution problem.                                           |
128 |              |                                                              |
129 +--------------+--------------------------------------------------------------+