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