Report: Configure report
[csit.git] / resources / tools / presentation / specifications / report / environment.yaml
1 ################################################################################
2 ###                          E N V I R O N M E N T                           ###
3 ################################################################################
4
5 - type: "environment"
6
7   spec-files:
8     - "specifications/report/data_sets.yaml"
9     - "specifications/report/layouts.yaml"
10     - "specifications/report/elements.yaml"
11
12   paths:
13     # Top level directories:
14     ## Working directory
15     DIR[WORKING]: "_tmp"
16     ## Build directories
17     DIR[BUILD,HTML]: "_build"
18     DIR[BUILD,LATEX]: "_build_latex"
19
20     # Static .rst files
21     DIR[RST]: "../../../docs/report"
22
23     # Working directories
24     ## Input data files (.zip, .xml)
25     DIR[WORKING,DATA]: "{DIR[WORKING]}/data"
26     ## Static source files from git
27     DIR[WORKING,SRC]: "{DIR[WORKING]}/src"
28     DIR[WORKING,SRC,STATIC]: "{DIR[WORKING,SRC]}/_static"
29
30     # Static html content
31     DIR[STATIC]: "{DIR[BUILD,HTML]}/_static"
32     DIR[STATIC,VPP]: "{DIR[STATIC]}/vpp"
33     DIR[STATIC,DPDK]: "{DIR[STATIC]}/dpdk"
34     DIR[STATIC,ARCH]: "{DIR[STATIC]}/archive"
35
36     # Detailed test results
37     DIR[DTR]: "{DIR[WORKING,SRC]}/detailed_test_results"
38     DIR[DTR,PERF,DPDK,3N,SKX]: "{DIR[DTR]}/dpdk_performance_results_3n_skx"
39     DIR[DTR,PERF,DPDK,2N,SKX]: "{DIR[DTR]}/dpdk_performance_results_2n_skx"
40     DIR[DTR,PERF,DPDK,2N,ZN2]: "{DIR[DTR]}/dpdk_performance_results_2n_zn2"
41     DIR[DTR,PERF,DPDK,2N,CLX]: "{DIR[DTR]}/dpdk_performance_results_2n_clx"
42     DIR[DTR,PERF,DPDK,2N,DNV]: "{DIR[DTR]}/dpdk_performance_results_2n_dnv"
43     DIR[DTR,PERF,DPDK,3N,DNV]: "{DIR[DTR]}/dpdk_performance_results_3n_dnv"
44     DIR[DTR,PERF,DPDK,3N,TSH]: "{DIR[DTR]}/dpdk_performance_results_3n_tsh"
45     DIR[DTR,PERF,DPDK,2N,TX2]: "{DIR[DTR]}/dpdk_performance_results_2n_tx2"
46     DIR[DTR,PERF,VPP,ALL]: "{DIR[DTR]}/vpp_performance_results"
47     DIR[DTR,PERF,VPP,3N,SKX]: "{DIR[DTR]}/vpp_performance_results_3n_skx"
48     DIR[DTR,PERF,VPP,2N,SKX]: "{DIR[DTR]}/vpp_performance_results_2n_skx"
49     DIR[DTR,PERF,VPP,2N,ZN2]: "{DIR[DTR]}/vpp_performance_results_2n_zn2"
50     DIR[DTR,PERF,VPP,2N,CLX]: "{DIR[DTR]}/vpp_performance_results_2n_clx"
51     DIR[DTR,PERF,VPP,2N,ICX]: "{DIR[DTR]}/vpp_performance_results_2n_icx"
52     DIR[DTR,PERF,VPP,3N,ICX]: "{DIR[DTR]}/vpp_performance_results_3n_icx"
53     DIR[DTR,PERF,VPP,3N,TSH]: "{DIR[DTR]}/vpp_performance_results_3n_tsh"
54     DIR[DTR,PERF,VPP,2N,TX2]: "{DIR[DTR]}/vpp_performance_results_2n_tx2"
55     DIR[DTR,PERF,VPP,3N,DNV]: "{DIR[DTR]}/vpp_performance_results_3n_dnv"
56     DIR[DTR,PERF,VPP,2N,DNV]: "{DIR[DTR]}/vpp_performance_results_2n_dnv"
57     DIR[DTR,MRR,VPP,ALL]: "{DIR[DTR]}/vpp_mrr_results"
58     DIR[DTR,MRR,VPP,3N,SKX]: "{DIR[DTR]}/vpp_mrr_results_3n_skx"
59     DIR[DTR,MRR,VPP,2N,SKX]: "{DIR[DTR]}/vpp_mrr_results_2n_skx"
60     DIR[DTR,MRR,VPP,2N,ZN2]: "{DIR[DTR]}/vpp_mrr_results_2n_zn2"
61     DIR[DTR,MRR,VPP,2N,CLX]: "{DIR[DTR]}/vpp_mrr_results_2n_clx"
62     DIR[DTR,MRR,VPP,2N,ICX]: "{DIR[DTR]}/vpp_mrr_results_2n_icx"
63     DIR[DTR,MRR,VPP,3N,ICX]: "{DIR[DTR]}/vpp_mrr_results_3n_icx"
64     DIR[DTR,MRR,VPP,3N,TSH]: "{DIR[DTR]}/vpp_mrr_results_3n_tsh"
65     DIR[DTR,MRR,VPP,2N,TX2]: "{DIR[DTR]}/vpp_mrr_results_2n_tx2"
66     DIR[DTR,MRR,VPP,3N,DNV]: "{DIR[DTR]}/vpp_mrr_results_3n_dnv"
67     DIR[DTR,MRR,VPP,2N,DNV]: "{DIR[DTR]}/vpp_mrr_results_2n_dnv"
68     DIR[DTR,FUNC,VPP,DEVICE,UBUNTU]: "{DIR[DTR]}/vpp_device_results_ubuntu"
69
70     # Detailed test configurations
71     DIR[DTC]: "{DIR[WORKING,SRC]}/test_configuration"
72     DIR[DTC,PERF,VPP,ALL]: "{DIR[DTC]}/vpp_performance_configuration"
73     DIR[DTC,PERF,VPP,3N,SKX]: "{DIR[DTC]}/vpp_performance_configuration_3n_skx"
74     DIR[DTC,PERF,VPP,2N,SKX]: "{DIR[DTC]}/vpp_performance_configuration_2n_skx"
75     DIR[DTC,PERF,VPP,2N,ZN2]: "{DIR[DTC]}/vpp_performance_configuration_2n_zn2"
76     DIR[DTC,PERF,VPP,2N,CLX]: "{DIR[DTC]}/vpp_performance_configuration_2n_clx"
77     DIR[DTC,PERF,VPP,2N,ICX]: "{DIR[DTC]}/vpp_performance_configuration_2n_icx"
78     DIR[DTC,PERF,VPP,3N,ICX]: "{DIR[DTC]}/vpp_performance_configuration_3n_icx"
79     DIR[DTC,PERF,VPP,3N,TSH]: "{DIR[DTC]}/vpp_performance_configuration_3n_tsh"
80     DIR[DTC,PERF,VPP,2N,TX2]: "{DIR[DTC]}/vpp_performance_configuration_2n_tx2"
81     DIR[DTC,PERF,VPP,3N,DNV]: "{DIR[DTC]}/vpp_performance_configuration_3n_dnv"
82     DIR[DTC,PERF,VPP,2N,DNV]: "{DIR[DTC]}/vpp_performance_configuration_2n_dnv"
83     DIR[DTC,MRR,VPP,ALL]: "{DIR[DTC]}/vpp_mrr_configuration"
84     DIR[DTC,MRR,VPP,3N,SKX]: "{DIR[DTC]}/vpp_mrr_configuration_3n_skx"
85     DIR[DTC,MRR,VPP,2N,SKX]: "{DIR[DTC]}/vpp_mrr_configuration_2n_skx"
86     DIR[DTC,MRR,VPP,2N,ZN2]: "{DIR[DTC]}/vpp_mrr_configuration_2n_zn2"
87     DIR[DTC,MRR,VPP,2N,CLX]: "{DIR[DTC]}/vpp_mrr_configuration_2n_clx"
88     DIR[DTC,MRR,VPP,2N,ICX]: "{DIR[DTC]}/vpp_mrr_configuration_2n_icx"
89     DIR[DTC,MRR,VPP,3N,ICX]: "{DIR[DTC]}/vpp_mrr_configuration_3n_icx"
90     DIR[DTC,MRR,VPP,3N,TSH]: "{DIR[DTC]}/vpp_mrr_configuration_3n_tsh"
91     DIR[DTC,MRR,VPP,2N,TX2]: "{DIR[DTC]}/vpp_mrr_configuration_2n_tx2"
92     DIR[DTC,MRR,VPP,3N,DNV]: "{DIR[DTC]}/vpp_mrr_configuration_3n_dnv"
93     DIR[DTC,MRR,VPP,2N,DNV]: "{DIR[DTC]}/vpp_mrr_configuration_2n_dnv"
94     DIR[DTC,FUNC,VPP,DEVICE,UBUNTU]: "{DIR[DTC]}/vpp_device_configuration_ubuntu"
95
96     # Detailed tests operational data
97     DIR[DTO]: "{DIR[WORKING,SRC]}/test_operational_data"
98     DIR[DTO,PERF,VPP,ALL]: "{DIR[DTO]}/vpp_performance_operational_data"
99     DIR[DTO,PERF,VPP,3N,SKX]: "{DIR[DTO]}/vpp_performance_operational_data_3n_skx"
100     DIR[DTO,PERF,VPP,2N,SKX]: "{DIR[DTO]}/vpp_performance_operational_data_2n_skx"
101     DIR[DTO,PERF,VPP,2N,ZN2]: "{DIR[DTO]}/vpp_performance_operational_data_2n_zn2"
102     DIR[DTO,PERF,VPP,2N,CLX]: "{DIR[DTO]}/vpp_performance_operational_data_2n_clx"
103     DIR[DTO,PERF,VPP,2N,ICX]: "{DIR[DTO]}/vpp_performance_operational_data_2n_icx"
104     DIR[DTO,PERF,VPP,3N,ICX]: "{DIR[DTO]}/vpp_performance_operational_data_3n_icx"
105     DIR[DTO,PERF,VPP,3N,TSH]: "{DIR[DTO]}/vpp_performance_operational_data_3n_tsh"
106     DIR[DTO,PERF,VPP,2N,TX2]: "{DIR[DTO]}/vpp_performance_operational_data_2n_tx2"
107     DIR[DTO,PERF,VPP,3N,DNV]: "{DIR[DTO]}/vpp_performance_operational_data_3n_dnv"
108     DIR[DTO,PERF,VPP,2N,DNV]: "{DIR[DTO]}/vpp_performance_operational_data_2n_dnv"
109
110     # Latencies:
111     DIR[LAT,VPP]: "{DIR[WORKING,SRC]}/vpp_performance_tests/hdrh_packet_latency_by_percentile_graphs"
112     DIR[LAT,DPDK]: "{DIR[WORKING,SRC]}/dpdk_performance_tests/hdrh_packet_latency_by_percentile_graphs"
113
114     # .css patch file to fix tables generated by Sphinx
115     DIR[CSS_PATCH_FILE]: "{DIR[STATIC]}/theme_overrides.css"
116     DIR[CSS_PATCH_FILE2]: "{DIR[WORKING,SRC,STATIC]}/theme_overrides.css"
117
118   # Data sources are used in this order:
119   data-sources:
120     # JSON from S3
121     - type: "json"
122       url: "https://logs.nginx.service.consul/vex-yul-rot-jenkins-1"
123       path: "{job}/{build}/{filename}"
124       file-name: "output.json.gz"
125       file-format: ".gz"
126       enabled: False
127     # XML
128     - type: "xml"
129       url: "https://logs.nginx.service.consul/vex-yul-rot-jenkins-1"
130       path: "{job}/{build}/archives/{filename}"
131       file-name: "output_info.xml.gz"
132       file-format: ".gz"
133       enabled: True
134     - type: "xml"
135       url: "https://logs.nginx.service.consul/vex-yul-rot-jenkins-1"
136       path: "{job}/{build}/{filename}"
137       file-name: "output_info.xml.gz"
138       file-format: ".gz"
139       enabled: True
140     - type: "xml"
141       url: "https://logs.fd.io/production/vex-yul-rot-jenkins-1"
142       path: "{job}/{build}/archives/{filename}"
143       file-name: "output_info.xml.gz"
144       file-format: ".gz"
145       enabled: True
146     - type: "xml"
147       url: "https://logs.fd.io/production/vex-yul-rot-jenkins-1"
148       path: "{job}/{build}/archives/{filename}"
149       file-name: "output.xml.gz"
150       file-format: ".gz"
151       enabled: True
152     - type: "xml"
153       url: "https://logs.nginx.service.consul/vex-yul-rot-jenkins-1"
154       path: "{job}/{build}/archives/{filename}"
155       file-name: "output.xml.gz"
156       file-format: ".gz"
157       enabled: True
158     - type: "xml"
159       url: "https://logs.nginx.service.consul/vex-yul-rot-jenkins-1"
160       path: "{job}/{build}/{filename}"
161       file-name: "output.xml.gz"
162       file-format: ".gz"
163       enabled: True
164     - type: "xml"
165       url: "https://logs.fd.io/production/vex-yul-rot-jenkins-1"
166       path: "{job}/{build}/{filename}"
167       file-name: "output_info.xml.gz"
168       file-format: ".gz"
169       enabled: True
170     - type: "xml"
171       url: "https://logs.fd.io/production/vex-yul-rot-jenkins-1"
172       path: "{job}/{build}/{filename}"
173       file-name: "output.xml.gz"
174       file-format: ".gz"
175       enabled: True
176     # XML from docs.nexus
177     - type: "xml-docs"
178       url: "https://docs.fd.io/csit"
179       path: "report/_static/archive"
180       file-name: "output_info.xml.gz"
181       file-format: ".gz"
182       enabled: True
183     - type: "xml-docs"
184       url: "https://docs.fd.io/csit"
185       path: "report/_static/archive"
186       file-name: "output.xml.gz"
187       file-format: ".gz"
188       enabled: True
189     - type: "xml-docs"
190       url: "https://docs.fd.io/csit"
191       path: "report/_static/archive"
192       file-name: "robot-plugin.zip"
193       file-format: ".zip"
194       enabled: True
195
196   archive-inputs: True
197
198   mapping-file: ""
199
200   ignore-list: ""
201
202   make-dirs:
203   # List the directories which are created while preparing the environment.
204   # All directories MUST be defined in "paths" section.
205     - "DIR[WORKING,DATA]"
206     - "DIR[STATIC,VPP]"
207     - "DIR[STATIC,DPDK]"
208     - "DIR[STATIC,ARCH]"
209     - "DIR[BUILD,LATEX]"
210     - "DIR[WORKING,SRC]"
211     - "DIR[WORKING,SRC,STATIC]"
212
213   remove-dirs:
214   # List the directories which are deleted while cleaning the environment.
215   # All directories MUST be defined in "paths" section.
216   #  - "DIR[BUILD,HTML]"
217     - "DIR[WORKING,DATA]"
218
219   build-dirs:
220   # List the directories where the results (build) is stored.
221   # All directories MUST be defined in "paths" section.
222     - "DIR[BUILD,HTML]"
223     - "DIR[BUILD,LATEX]"
224
225   reverse-input: False  # Needed for trending, not important for the report
226
227   # TODO: Change in code needed, it was in type: "configuration"
228   limits:
229     nic:
230       x520: 24460000
231       x553: 29761905
232       x710: 35800000
233       xxv710: 35800000
234       xl710: 35800000
235       cx556a: 148809523.81
236       e810cq: 148809523.81
237
238     link:
239       10ge: 14880952.38
240       25ge: 37202380.95
241       40ge: 59523809.52
242       100ge: 148809523.81
243
244     pci:
245       pci-g3-x8: 74404761.90
246       pci-g3-x16: 148809523.81
247
248 ################################################################################
249 ###                               S T A T I C                                ###
250 ################################################################################
251
252 - type: "static"
253   src-path: "{DIR[RST]}"
254   dst-path: "{DIR[WORKING,SRC]}"
255
256 ################################################################################
257 ###                               O U T P U T                                ###
258 ################################################################################
259
260 - type: "output"
261   arch-file-format:  # moved from input, TODO: change it in the code
262     - ".gz"
263     - ".zip"
264   output: "report"
265   format:
266     html:
267     - full
268 #     pdf:
269 #     - minimal