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