X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Freport%2Fcsit_framework_documentation%2Fcsit_design.rst;h=b8851513ab86557e8269c0b445fd4de75ddc5830;hb=72f18772740b0dde1ed6e44d740f8456ce0546e9;hp=fef0285b998199a15cfd0cdb67d7dc3af5aaef51;hpb=1c66ee7e4d3c0ac6375c1c5ca15bc349d8cb3bfa;p=csit.git diff --git a/docs/report/csit_framework_documentation/csit_design.rst b/docs/report/csit_framework_documentation/csit_design.rst index fef0285b99..b8851513ab 100644 --- a/docs/report/csit_framework_documentation/csit_design.rst +++ b/docs/report/csit_framework_documentation/csit_design.rst @@ -1,7 +1,7 @@ .. _csit-design: -CSIT Design -=========== +Design +====== FD.io CSIT system design needs to meet continuously expanding requirements of FD.io projects including VPP, related sub-systems (e.g. @@ -24,11 +24,12 @@ including CSIT framework is depicted in the figure below. .. raw:: latex - \begin{figure}[H] - \centering - \includesvg[width=0.90\textwidth]{../_tmp/src/csit_framework_documentation/csit_design_picture} - \label{fig:csit_design_picture} - \end{figure} + \begin{figure}[H] + \centering + \graphicspath{{../_tmp/src/csit_framework_documentation/}} + \includegraphics[width=0.90\textwidth]{csit_design_picture} + \label{fig:csit_design_picture} + \end{figure} .. only:: html @@ -67,14 +68,14 @@ A brief bottom-up description is provided here: - TG-specific stream profiles provide full control of: - - Packet definition – layers, MACs, IPs, ports, combinations thereof + - Packet definition - layers, MACs, IPs, ports, combinations thereof e.g. IPs and UDP ports; - Stream definitions - different streams can run together, delayed, one after each other; - Stream profiles are independent of CSIT framework and can be used in any T-rex setup, can be sent anywhere to repeat tests with exactly the same setup; - - Easily extensible – one can create a new stream profile that meets + - Easily extensible - one can create a new stream profile that meets tests requirements; - Same stream profile can be used for different tests with the same traffic needs; @@ -96,19 +97,12 @@ A brief bottom-up description is provided here: #. Tests - Robot: - Test suites with test cases; - - Functional tests using VIRL environment: - - - VPP; - - Honeycomb; - - NSH_SFC; - Performance tests using physical testbed environment: - VPP; - DPDK-Testpmd; - DPDK-L3Fwd; - - Honeycomb; - - VPP Container orchestrated topologies; - Tools: @@ -178,7 +172,7 @@ the command. They must follow English sentence grammar in one of the following forms: #. **Imperative** - verb-object(s): *"Do something"*, verb in base form. -#. **Declarative** - subject–verb–object(s): *"Subject does something"*, verb in +#. **Declarative** - subject-verb-object(s): *"Subject does something"*, verb in a third-person singular present tense form. #. **Affirmative** - modal_verb-verb-object(s): *"Subject should be something"*, *"Object should exist"*, verb in base form. @@ -191,7 +185,7 @@ section below. Following sections list applicability of the above grammar forms to different :abbr:`RF (Robot Framework)` KW categories. Usage examples are provided, both good and bad. -Coding guidelines +Coding Guidelines ----------------- Coding guidelines can be found on `Design optimizations wiki page