1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. (c) Cisco Systems, Inc
5 NFVbench Server mode and NFVbench client API
6 ============================================
8 NFVbench can run as an HTTP server to:
10 - optionally provide access to any arbitrary HTLM files (HTTP server function) - this is optional
11 - service fully parameterized aynchronous run requests using the HTTP protocol (REST/json with polling)
12 - service fully parameterized run requests with interval stats reporting using the WebSocket/SocketIO protocol.
14 Start the NFVbench server
15 -------------------------
16 To run in server mode, simply use the --server <http_root_path> and optionally the listen address to use (--host <ip>, default is 0.0.0.0) and listening port to use (--port <port>, default is 7555).
19 If HTTP files are to be serviced, they must be stored right under the http root path.
20 This root path must contain a static folder to hold static files (css, js) and a templates folder with at least an index.html file to hold the template of the index.html file to be used.
21 This mode is convenient when you do not already have a WEB server hosting the UI front end.
22 If HTTP files servicing is not needed (REST only or WebSocket/SocketIO mode), the root path can point to any dummy folder.
24 Once started, the NFVbench server will be ready to service HTTP or WebSocket/SocketIO requests at the advertised URL.
26 Example of NFVbench server start in a container:
30 # get to the container shell (assume the container name is "nfvbench")
31 docker exec -it nfvbench bash
32 # from the container shell start the NFVbench server in the background
33 nfvbench -c /tmp/nfvbench/nfvbench.cfg --server /tmp &
45 This request simply returns whatever content is sent in the body of the request (body should be in json format, only used for testing)
51 curl -XGET '127.0.0.1:7556/echo' -H "Content-Type: application/json" -d '{"nfvbench": "test"}'
58 <http-url>/status (GET)
59 ^^^^^^^^^^^^^^^^^^^^^^^
61 This request fetches the status of an asynchronous run. It will return in json format:
63 - a request pending reply (if the run is still not completed)
64 - an error reply if there is no run pending
65 - or the complete result of the run
67 The client can keep polling until the run completes.
69 Example of return when the run is still pending:
74 "error_message": "nfvbench run still pending",
78 Example of return when the run completes:
88 <http-url>/start_run (POST)
89 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
91 This request starts an NFVBench run with passed configurations. If no configuration is passed, a run with default configurations will be executed.
93 Example request: curl -XPOST 'localhost:7556/start_run' -H "Content-Type: application/json" -d @nfvbenchconfig.json
95 See "NFVbench configuration JSON parameter" below for details on how to format this parameter.
97 The request returns immediately with a json content indicating if there was an error (status=ERROR) or if the request was submitted successfully (status=PENDING).
98 Example of return when the submission is successful:
103 "error_message": "NFVbench run still pending",
104 "request_id": "42cccb7effdc43caa47f722f0ca8ec96",
108 If there is already an NFVBench running then it will return:
113 "error_message": "there is already an NFVbench request running",
117 WebSocket/SocketIO events
118 -------------------------
120 List of SocketIO events supported:
127 sent by client to start a new run with the configuration passed in argument (JSON).
128 The configuration can be any valid NFVbench configuration passed as a JSON document (see "NFVbench configuration JSON parameter" below)
135 sent by server to report statistics during a run
136 the message contains the statistics {'time_ms': time_ms, 'tx_pps': tx_pps, 'rx_pps': rx_pps, 'drop_pct': drop_pct}
140 (during NDR-PDR search)
141 sent by server when the NDR rate is found
142 the message contains the NDR value {'rate_pps': ndr_pps}
146 (during NDR-PDR search)
147 sent by server when the PDR rate is found
148 the message contains the PDR value {'rate_pps': pdr_pps}
153 sent by server to report the end of a run
154 the message contains the complete results in JSON format
156 NFVbench configuration JSON parameter
157 -------------------------------------
158 The NFVbench configuration describes the parameters of an NFVbench run and can be passed to the NFVbench server as a JSON document.
160 Default configuration
161 ^^^^^^^^^^^^^^^^^^^^^
163 The simplest JSON document is the empty dictionary "{}" which indicates to use the default NFVbench configuration:
166 - NDR-PDR measurement
168 - 1 flow per direction
170 The entire default configuration can be viewed using the --show-json-config option on the cli:
174 # nfvbench --show-config
176 "availability_zone": null,
177 "compute_node_user": "root",
178 "compute_nodes": null,
184 "hw:cpu_policy": "dedicated",
185 "hw:mem_page_size": 2048
190 "flavor_type": "nfv.medium",
192 "generic_poll_sec": 2,
193 "generic_retry_count": 100,
195 "internal_networks": {
197 "name": "nfvbench-net0",
198 "subnet": "nfvbench-subnet0",
199 "cidr": "192.168.1.0/24",
202 "name": "nfvbench-net1",
203 "subnet": "nfvbench-subnet1",
204 "cidr": "192.168.2.0/24",
207 "name": "nfvbench-net2",
208 "subnet": "nfvbench-subnet2",
209 "cidr": "192.168.3.0/24",
214 "loop_vm_name": "nfvbench-loop-vm",
220 "name": "(built-in default config)",
223 "openrc_file": "/tmp/nfvbench/openstack/openrc",
225 "service_chain": "PVP",
226 "service_chain_count": 1,
230 "bidirectional": true,
231 "profile": "traffic_profile_64B"
233 "traffic_generator": {
234 "default_profile": "trex-local",
235 "gateway_ip_addrs": [
239 "gateway_ip_addrs_step": "0.0.0.1",
240 "generator_profile": [
247 "switch_port": "Ethernet1/33",
253 "switch_port": "Ethernet1/34",
259 "name": "trex-local",
263 "host_name": "nfvbench_tg",
268 "ip_addrs_step": "0.0.0.1",
274 "tg_gateway_ip_addrs": [
278 "tg_gateway_ip_addrs_step": "0.0.0.1"
285 "name": "traffic_profile_64B"
291 "name": "traffic_profile_IMIX"
297 "name": "traffic_profile_1518B"
305 "name": "traffic_profile_3sizes"
308 "unidir_reverse_traffic_pps": 1,
309 "vlan_tagging": true,
313 Common examples of JSON configuration
314 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
316 Use the default configuration but use 10000 flows per direction (instead of 1):
320 { "flow_count": 10000 }
323 Use default confguration but with 10000 flows, "EXT" chain and IMIX packet size:
329 "service_chain": "EXT",
331 "profile": "traffic_profile_IMIX"
335 A short run of 5 seconds at a fixed rate of 1Mpps (and everything else same as the default configuration):
344 Example of interaction with the NFVbench server using HTTP and curl
345 -------------------------------------------------------------------
346 HTTP requests can be sent directly to the NFVbench server from CLI using curl from any host that can connect to the server (here we run it from the local host).
348 This is a POST request to start a run using the default NFVbench configuration but with traffic generation disabled ("no_traffic" property is set to true):
352 [root@sjc04-pod3-mgmt ~]# curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"no_traffic":true}' http://127.0.0.1:7555/start_run
354 "error_message": "nfvbench run still pending",
357 [root@sjc04-pod3-mgmt ~]#
359 This request will return immediately with status set to "PENDING" if the request was started successfully.
361 The status can be polled until the run completes. Here the poll returns a "PENDING" status, indicating the run is still not completed:
365 [root@sjc04-pod3-mgmt ~]# curl -G http://127.0.0.1:7555/status
367 "error_message": "nfvbench run still pending",
370 [root@sjc04-pod3-mgmt ~]#
372 Finally, the status request returns a "OK" status along with the full results (truncated here):
376 [root@sjc04-pod3-mgmt ~]# curl -G http://127.0.0.1:7555/status
384 "bidirectional": true,
386 "nova:sjc04-pod3-compute-4": {
388 "Adjacent Cache Line Prefetcher": "Disabled",
389 "All Onboard LOM Ports": "Enabled",
390 "All PCIe Slots OptionROM": "Enabled",
394 "date": "2017-03-31 22:15:41",
395 "nfvbench_version": "0.3.5",
403 [root@sjc04-pod3-mgmt ~]#
407 Example of interaction with the NFVbench server using a python CLI app (nfvbench_client)
408 ----------------------------------------------------------------------------------------
409 The module client/client.py contains an example of python class that can be used to control the NFVbench server from a python app using HTTP or WebSocket/SocketIO.
411 The module client/nfvbench_client.py has a simple main application to control the NFVbench server from CLI.
412 The "nfvbench_client" wrapper script can be used to invoke the client front end (this wrapper is pre-installed in the NFVbench container)
414 Example of invocation of the nfvbench_client front end, from the host (assume the name of the NFVbench container is "nfvbench"),
415 use the default NFVbench configuration but do not generate traffic (no_traffic property set to true, the full json result is truncated here):
419 [root@sjc04-pod3-mgmt ~]# docker exec -it nfvbench nfvbench_client -c '{"no_traffic":true}' http://127.0.0.1:7555
420 {u'status': u'PENDING', u'error_message': u'nfvbench run still pending'}
421 {u'status': u'PENDING', u'error_message': u'nfvbench run still pending'}
422 {u'status': u'PENDING', u'error_message': u'nfvbench run still pending'}
424 {u'status': u'OK', u'result': {u'date': u'2017-03-31 22:04:59', u'nfvbench_version': u'0.3.5',
425 u'config': {u'compute_nodes': None, u'compute_node_user': u'root', u'traffic_generator': {u'tg_gateway_ip_addrs': [u'1.1.0.100', u'2.2.0.100'], u'ip_addrs_step': u'0.0.0.1',
426 u'step_mac': None, u'generator_profile': [{u'intf_speed': u'', u'interfaces': [{u'pci': u'0a:00.0', u'port': 0, u'vlan': 1998, u'switch_port': None},
430 [root@sjc04-pod3-mgmt ~]#
432 The http interface is used unless --use-socketio is defined.
434 Example of invocation using Websocket/SocketIO, execute NFVbench using the default configuration but with a duration of 5 seconds and a fixed rate run of 5kpps.
438 [root@sjc04-pod3-mgmt ~]# docker exec -it nfvbench nfvbench_client -c '{"duration":5,"rate":"5kpps"}' --use-socketio http://127.0.0.1:7555 >results.json