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,TREX]: "{DIR[STATIC]}/trex"
  35     DIR[STATIC,ARCH]: "{DIR[STATIC]}/archive"
  36
  37     # Detailed test results
  38     DIR[DTR]: "{DIR[WORKING,SRC]}/detailed_test_results"
  39     DIR[DTR,PERF,DPDK,2N,ICX]: "{DIR[DTR]}/dpdk_performance_results_2n_icx"
  40     DIR[DTR,PERF,DPDK,3N,ICX]: "{DIR[DTR]}/dpdk_performance_results_3n_icx"
  41     DIR[DTR,PERF,DPDK,2N,ZN2]: "{DIR[DTR]}/dpdk_performance_results_2n_zn2"
  42     DIR[DTR,PERF,DPDK,2N,CLX]: "{DIR[DTR]}/dpdk_performance_results_2n_clx"
  43     DIR[DTR,PERF,DPDK,2N,DNV]: "{DIR[DTR]}/dpdk_performance_results_2n_dnv"
  44     DIR[DTR,PERF,DPDK,3N,DNV]: "{DIR[DTR]}/dpdk_performance_results_3n_dnv"
  45     DIR[DTR,PERF,DPDK,3N,SNR]: "{DIR[DTR]}/dpdk_performance_results_3n_snr"
  46     DIR[DTR,PERF,DPDK,3N,ALT]: "{DIR[DTR]}/dpdk_performance_results_3n_alt"
  47     DIR[DTR,PERF,DPDK,3N,TSH]: "{DIR[DTR]}/dpdk_performance_results_3n_tsh"
  48     DIR[DTR,PERF,DPDK,2N,TX2]: "{DIR[DTR]}/dpdk_performance_results_2n_tx2"
  49     DIR[DTR,PERF,TREX,2N,ICX]: "{DIR[DTR]}/trex_performance_results_2n_icx"
  50     DIR[DTR,PERF,TREX,1N,AWS]: "{DIR[DTR]}/trex_performance_results_1n_aws"
  51     DIR[DTR,PERF,VPP,ALL]: "{DIR[DTR]}/vpp_performance_results"
  52     DIR[DTR,PERF,VPP,2N,ZN2]: "{DIR[DTR]}/vpp_performance_results_2n_zn2"
  53     DIR[DTR,PERF,VPP,2N,CLX]: "{DIR[DTR]}/vpp_performance_results_2n_clx"
  54     DIR[DTR,PERF,VPP,2N,ICX]: "{DIR[DTR]}/vpp_performance_results_2n_icx"
  55     DIR[DTR,PERF,VPP,3N,ICX]: "{DIR[DTR]}/vpp_performance_results_3n_icx"
  56     DIR[DTR,PERF,VPP,3N,ALT]: "{DIR[DTR]}/vpp_performance_results_3n_alt"
  57     DIR[DTR,PERF,VPP,3N,TSH]: "{DIR[DTR]}/vpp_performance_results_3n_tsh"
  58     DIR[DTR,PERF,VPP,2N,TX2]: "{DIR[DTR]}/vpp_performance_results_2n_tx2"
  59     DIR[DTR,PERF,VPP,3N,DNV]: "{DIR[DTR]}/vpp_performance_results_3n_dnv"
  60     DIR[DTR,PERF,VPP,2N,DNV]: "{DIR[DTR]}/vpp_performance_results_2n_dnv"
  61     DIR[DTR,PERF,VPP,3N,SNR]: "{DIR[DTR]}/vpp_performance_results_3n_snr"
  62     DIR[DTR,PERF,VPP,3N,AWS]: "{DIR[DTR]}/vpp_performance_results_3n_aws"
  63     DIR[DTR,PERF,VPP,2N,AWS]: "{DIR[DTR]}/vpp_performance_results_2n_aws"
  64     DIR[DTR,MRR,VPP,ALL]: "{DIR[DTR]}/vpp_mrr_results"
  65     DIR[DTR,MRR,VPP,2N,ZN2]: "{DIR[DTR]}/vpp_mrr_results_2n_zn2"
  66     DIR[DTR,MRR,VPP,2N,CLX]: "{DIR[DTR]}/vpp_mrr_results_2n_clx"
  67     DIR[DTR,MRR,VPP,2N,ICX]: "{DIR[DTR]}/vpp_mrr_results_2n_icx"
  68     DIR[DTR,MRR,VPP,3N,ICX]: "{DIR[DTR]}/vpp_mrr_results_3n_icx"
  69     DIR[DTR,MRR,VPP,3N,ALT]: "{DIR[DTR]}/vpp_mrr_results_3n_alt"
  70     DIR[DTR,MRR,VPP,3N,TSH]: "{DIR[DTR]}/vpp_mrr_results_3n_tsh"
  71     DIR[DTR,MRR,VPP,2N,TX2]: "{DIR[DTR]}/vpp_mrr_results_2n_tx2"
  72     DIR[DTR,MRR,VPP,3N,DNV]: "{DIR[DTR]}/vpp_mrr_results_3n_dnv"
  73     DIR[DTR,MRR,VPP,2N,DNV]: "{DIR[DTR]}/vpp_mrr_results_2n_dnv"
  74     DIR[DTR,MRR,VPP,3N,SNR]: "{DIR[DTR]}/vpp_mrr_results_3n_snr"
  75     DIR[DTR,MRR,VPP,3N,AWS]: "{DIR[DTR]}/vpp_mrr_results_3n_aws"
  76     DIR[DTR,MRR,VPP,2N,AWS]: "{DIR[DTR]}/vpp_mrr_results_2n_aws"
  77     DIR[DTR,FUNC,VPP,DEVICE,UBUNTU]: "{DIR[DTR]}/vpp_device_results_ubuntu"
  78
  79     # Detailed test configurations
  80     DIR[DTC]: "{DIR[WORKING,SRC]}/test_configuration"
  81     DIR[DTC,PERF,VPP,ALL]: "{DIR[DTC]}/vpp_performance_configuration"
  82     DIR[DTC,PERF,VPP,2N,ZN2]: "{DIR[DTC]}/vpp_performance_configuration_2n_zn2"
  83     DIR[DTC,PERF,VPP,2N,CLX]: "{DIR[DTC]}/vpp_performance_configuration_2n_clx"
  84     DIR[DTC,PERF,VPP,2N,ICX]: "{DIR[DTC]}/vpp_performance_configuration_2n_icx"
  85     DIR[DTC,PERF,VPP,3N,ICX]: "{DIR[DTC]}/vpp_performance_configuration_3n_icx"
  86     DIR[DTC,PERF,VPP,3N,ALT]: "{DIR[DTC]}/vpp_performance_configuration_3n_alt"
  87     DIR[DTC,PERF,VPP,3N,TSH]: "{DIR[DTC]}/vpp_performance_configuration_3n_tsh"
  88     DIR[DTC,PERF,VPP,2N,TX2]: "{DIR[DTC]}/vpp_performance_configuration_2n_tx2"
  89     DIR[DTC,PERF,VPP,3N,DNV]: "{DIR[DTC]}/vpp_performance_configuration_3n_dnv"
  90     DIR[DTC,PERF,VPP,2N,DNV]: "{DIR[DTC]}/vpp_performance_configuration_2n_dnv"
  91     DIR[DTC,PERF,VPP,3N,SNR]: "{DIR[DTC]}/vpp_performance_configuration_3n_snr"
  92     DIR[DTC,PERF,VPP,3N,AWS]: "{DIR[DTC]}/vpp_performance_configuration_3n_aws"
  93     DIR[DTC,PERF,VPP,2N,AWS]: "{DIR[DTC]}/vpp_performance_configuration_2n_aws"
  94     DIR[DTC,MRR,VPP,ALL]: "{DIR[DTC]}/vpp_mrr_configuration"
  95     DIR[DTC,MRR,VPP,2N,ZN2]: "{DIR[DTC]}/vpp_mrr_configuration_2n_zn2"
  96     DIR[DTC,MRR,VPP,2N,CLX]: "{DIR[DTC]}/vpp_mrr_configuration_2n_clx"
  97     DIR[DTC,MRR,VPP,2N,ICX]: "{DIR[DTC]}/vpp_mrr_configuration_2n_icx"
  98     DIR[DTC,MRR,VPP,3N,ICX]: "{DIR[DTC]}/vpp_mrr_configuration_3n_icx"
  99     DIR[DTC,MRR,VPP,3N,ALT]: "{DIR[DTC]}/vpp_mrr_configuration_3n_alt"
 100     DIR[DTC,MRR,VPP,3N,TSH]: "{DIR[DTC]}/vpp_mrr_configuration_3n_tsh"
 101     DIR[DTC,MRR,VPP,2N,TX2]: "{DIR[DTC]}/vpp_mrr_configuration_2n_tx2"
 102     DIR[DTC,MRR,VPP,3N,DNV]: "{DIR[DTC]}/vpp_mrr_configuration_3n_dnv"
 103     DIR[DTC,MRR,VPP,2N,DNV]: "{DIR[DTC]}/vpp_mrr_configuration_2n_dnv"
 104     DIR[DTC,MRR,VPP,3N,SNR]: "{DIR[DTC]}/vpp_mrr_configuration_3n_snr"
 105     DIR[DTC,MRR,VPP,3N,AWS]: "{DIR[DTC]}/vpp_mrr_configuration_3n_aws"
 106     DIR[DTC,MRR,VPP,2N,AWS]: "{DIR[DTC]}/vpp_mrr_configuration_2n_aws"
 107     DIR[DTC,FUNC,VPP,DEVICE,UBUNTU]: "{DIR[DTC]}/vpp_device_configuration_ubuntu"
 108
 109     # Detailed tests operational data
 110     DIR[DTO]: "{DIR[WORKING,SRC]}/test_operational_data"
 111     DIR[DTO,PERF,VPP,ALL]: "{DIR[DTO]}/vpp_performance_operational_data"
 112     DIR[DTO,PERF,VPP,2N,ZN2]: "{DIR[DTO]}/vpp_performance_operational_data_2n_zn2"
 113     DIR[DTO,PERF,VPP,2N,CLX]: "{DIR[DTO]}/vpp_performance_operational_data_2n_clx"
 114     DIR[DTO,PERF,VPP,2N,ICX]: "{DIR[DTO]}/vpp_performance_operational_data_2n_icx"
 115     DIR[DTO,PERF,VPP,3N,ICX]: "{DIR[DTO]}/vpp_performance_operational_data_3n_icx"
 116     DIR[DTO,PERF,VPP,3N,ALT]: "{DIR[DTO]}/vpp_performance_operational_data_3n_alt"
 117     DIR[DTO,PERF,VPP,3N,TSH]: "{DIR[DTO]}/vpp_performance_operational_data_3n_tsh"
 118     DIR[DTO,PERF,VPP,2N,TX2]: "{DIR[DTO]}/vpp_performance_operational_data_2n_tx2"
 119     DIR[DTO,PERF,VPP,3N,DNV]: "{DIR[DTO]}/vpp_performance_operational_data_3n_dnv"
 120     DIR[DTO,PERF,VPP,2N,DNV]: "{DIR[DTO]}/vpp_performance_operational_data_2n_dnv"
 121     DIR[DTO,PERF,VPP,3N,SNR]: "{DIR[DTO]}/vpp_performance_operational_data_3n_snr"
 122     DIR[DTO,PERF,VPP,3N,AWS]: "{DIR[DTO]}/vpp_performance_operational_data_3n_aws"
 123     DIR[DTO,PERF,VPP,2N,AWS]: "{DIR[DTO]}/vpp_performance_operational_data_2n_aws"
 124
 125     # Latencies:
 126     DIR[LAT,VPP]: "{DIR[WORKING,SRC]}/vpp_performance_tests/hdrh_packet_latency_by_percentile_graphs"
 127     DIR[LAT,DPDK]: "{DIR[WORKING,SRC]}/dpdk_performance_tests/hdrh_packet_latency_by_percentile_graphs"
 128     DIR[LAT,TREX]: "{DIR[WORKING,SRC]}/trex_performance_tests/hdrh_packet_latency_by_percentile_graphs"
 129
 130     # .css patch file to fix tables generated by Sphinx
 131     DIR[CSS_PATCH_FILE]: "{DIR[STATIC]}/theme_overrides.css"
 132     DIR[CSS_PATCH_FILE2]: "{DIR[WORKING,SRC,STATIC]}/theme_overrides.css"
 133
 134   # Data sources are used in this order:
 135   data-sources:
 136     # XML
 137     - type: "xml"
 138       url: "https://s3-logs.fd.io/vex-yul-rot-jenkins-1"
 139       path: "{job}/{build}/{filename}"
 140       file-name: "output_info.xml.gz"
 141       file-format: ".gz"
 142       enabled: True
 143     # XML from S3 docs
 144     - type: "xml-docs"
 145       url: "https://s3-docs.fd.io/csit"
 146       path: "report/_static/archive"
 147       file-name: "output_info.xml.gz"
 148       file-format: ".gz"
 149       enabled: True
 150     - type: "xml-docs"
 151       url: "https://s3-docs.fd.io/csit"
 152       path: "report/_static/archive"
 153       file-name: "output.xml.gz"
 154       file-format: ".gz"
 155       enabled: True
 156
 157   archive-inputs: True
 158
 159   mapping-file: ""
 160
 161   ignore-list: ""
 162
 163   make-dirs:
 164   # List the directories which are created while preparing the environment.
 165   # All directories MUST be defined in "paths" section.
 166     - "DIR[WORKING,DATA]"
 167     - "DIR[STATIC,VPP]"
 168     - "DIR[STATIC,DPDK]"
 169     - "DIR[STATIC,TREX]"
 170     - "DIR[STATIC,ARCH]"
 171     - "DIR[BUILD,LATEX]"
 172     - "DIR[WORKING,SRC]"
 173     - "DIR[WORKING,SRC,STATIC]"
 174
 175   remove-dirs:
 176   # List the directories which are deleted while cleaning the environment.
 177   # All directories MUST be defined in "paths" section.
 178   #  - "DIR[BUILD,HTML]"
 179     - "DIR[WORKING,DATA]"
 180
 181   build-dirs:
 182   # List the directories where the results (build) is stored.
 183   # All directories MUST be defined in "paths" section.
 184     - "DIR[BUILD,HTML]"
 185     - "DIR[BUILD,LATEX]"
 186
 187   reverse-input: False  # Needed for trending, not important for the report
 188
 189   limits:
 190     nic:
 191       x520: 29761904
 192       x553: 29761904
 193       x710: 29761904
 194       xxv710: 37500000
 195       xl710: 37500000
 196       cx556a: 148809523
 197       e810cq: 117000000
 198       e810xxv: 58000000
 199       e822cq: 37500000
 200
 201     link:
 202       10ge: 14880952
 203       25ge: 37202380
 204       40ge: 59523809
 205       100ge: 148809523
 206
 207     pci:
 208       pci-g3-x8: 74404761
 209       pci-g3-x16: 148809523
 210
 211   frequency:  # [GHz]
 212     2n-aws: 1.000
 213     2n-dnv: 2.000
 214     2n-clx: 2.300
 215     2n-icx: 2.600
 216     2n-skx: 2.500
 217     2n-tx2: 2.500
 218     2n-zn2: 2.900
 219     3n-alt: 3.000
 220     3n-aws: 1.000
 221     3n-dnv: 2.000
 222     3n-icx: 2.600
 223     3n-skx: 2.500
 224     3n-tsh: 2.200
 225     3n-snr: 2.200
 226
 227 ################################################################################
 228 ###                               S T A T I C                                ###
 229 ################################################################################
 230
 231 - type: "static"
 232   src-path: "{DIR[RST]}"
 233   dst-path: "{DIR[WORKING,SRC]}"
 234
 235 ################################################################################
 236 ###                               O U T P U T                                ###
 237 ################################################################################
 238
 239 - type: "output"
 240   arch-file-format:
 241     - ".gz"
 242     - ".zip"
 243   output: "report"
 244   format:
 245     html:
 246       - full
 247     pdf:
 248       - minimal