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,3N,SKX]: "{DIR[DTR]}/dpdk_performance_results_3n_skx"
  42     DIR[DTR,PERF,DPDK,2N,SKX]: "{DIR[DTR]}/dpdk_performance_results_2n_skx"
  43     DIR[DTR,PERF,DPDK,2N,ZN2]: "{DIR[DTR]}/dpdk_performance_results_2n_zn2"
  44     DIR[DTR,PERF,DPDK,2N,CLX]: "{DIR[DTR]}/dpdk_performance_results_2n_clx"
  45     DIR[DTR,PERF,DPDK,2N,DNV]: "{DIR[DTR]}/dpdk_performance_results_2n_dnv"
  46     DIR[DTR,PERF,DPDK,3N,DNV]: "{DIR[DTR]}/dpdk_performance_results_3n_dnv"
  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,SKX]: "{DIR[DTR]}/trex_performance_results_2n_skx"
  50     DIR[DTR,PERF,VPP,ALL]: "{DIR[DTR]}/vpp_performance_results"
  51     DIR[DTR,PERF,VPP,3N,SKX]: "{DIR[DTR]}/vpp_performance_results_3n_skx"
  52     DIR[DTR,PERF,VPP,2N,SKX]: "{DIR[DTR]}/vpp_performance_results_2n_skx"
  53     DIR[DTR,PERF,VPP,2N,ZN2]: "{DIR[DTR]}/vpp_performance_results_2n_zn2"
  54     DIR[DTR,PERF,VPP,2N,CLX]: "{DIR[DTR]}/vpp_performance_results_2n_clx"
  55     DIR[DTR,PERF,VPP,2N,ICX]: "{DIR[DTR]}/vpp_performance_results_2n_icx"
  56     DIR[DTR,PERF,VPP,3N,ICX]: "{DIR[DTR]}/vpp_performance_results_3n_icx"
  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,AWS]: "{DIR[DTR]}/vpp_performance_results_3n_aws"
  62     DIR[DTR,PERF,VPP,2N,AWS]: "{DIR[DTR]}/vpp_performance_results_2n_aws"
  63     DIR[DTR,MRR,VPP,ALL]: "{DIR[DTR]}/vpp_mrr_results"
  64     DIR[DTR,MRR,VPP,3N,SKX]: "{DIR[DTR]}/vpp_mrr_results_3n_skx"
  65     DIR[DTR,MRR,VPP,2N,SKX]: "{DIR[DTR]}/vpp_mrr_results_2n_skx"
  66     DIR[DTR,MRR,VPP,2N,ZN2]: "{DIR[DTR]}/vpp_mrr_results_2n_zn2"
  67     DIR[DTR,MRR,VPP,2N,CLX]: "{DIR[DTR]}/vpp_mrr_results_2n_clx"
  68     DIR[DTR,MRR,VPP,2N,ICX]: "{DIR[DTR]}/vpp_mrr_results_2n_icx"
  69     DIR[DTR,MRR,VPP,3N,ICX]: "{DIR[DTR]}/vpp_mrr_results_3n_icx"
  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,AWS]: "{DIR[DTR]}/vpp_mrr_results_3n_aws"
  75     DIR[DTR,MRR,VPP,2N,AWS]: "{DIR[DTR]}/vpp_mrr_results_2n_aws"
  76     DIR[DTR,FUNC,VPP,DEVICE,UBUNTU]: "{DIR[DTR]}/vpp_device_results_ubuntu"
  77
  78     # Detailed test configurations
  79     DIR[DTC]: "{DIR[WORKING,SRC]}/test_configuration"
  80     DIR[DTC,PERF,VPP,ALL]: "{DIR[DTC]}/vpp_performance_configuration"
  81     DIR[DTC,PERF,VPP,3N,SKX]: "{DIR[DTC]}/vpp_performance_configuration_3n_skx"
  82     DIR[DTC,PERF,VPP,2N,SKX]: "{DIR[DTC]}/vpp_performance_configuration_2n_skx"
  83     DIR[DTC,PERF,VPP,2N,ZN2]: "{DIR[DTC]}/vpp_performance_configuration_2n_zn2"
  84     DIR[DTC,PERF,VPP,2N,CLX]: "{DIR[DTC]}/vpp_performance_configuration_2n_clx"
  85     DIR[DTC,PERF,VPP,2N,ICX]: "{DIR[DTC]}/vpp_performance_configuration_2n_icx"
  86     DIR[DTC,PERF,VPP,3N,ICX]: "{DIR[DTC]}/vpp_performance_configuration_3n_icx"
  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,AWS]: "{DIR[DTC]}/vpp_performance_configuration_3n_aws"
  92     DIR[DTC,PERF,VPP,2N,AWS]: "{DIR[DTC]}/vpp_performance_configuration_2n_aws"
  93     DIR[DTC,MRR,VPP,ALL]: "{DIR[DTC]}/vpp_mrr_configuration"
  94     DIR[DTC,MRR,VPP,3N,SKX]: "{DIR[DTC]}/vpp_mrr_configuration_3n_skx"
  95     DIR[DTC,MRR,VPP,2N,SKX]: "{DIR[DTC]}/vpp_mrr_configuration_2n_skx"
  96     DIR[DTC,MRR,VPP,2N,ZN2]: "{DIR[DTC]}/vpp_mrr_configuration_2n_zn2"
  97     DIR[DTC,MRR,VPP,2N,CLX]: "{DIR[DTC]}/vpp_mrr_configuration_2n_clx"
  98     DIR[DTC,MRR,VPP,2N,ICX]: "{DIR[DTC]}/vpp_mrr_configuration_2n_icx"
  99     DIR[DTC,MRR,VPP,3N,ICX]: "{DIR[DTC]}/vpp_mrr_configuration_3n_icx"
 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,AWS]: "{DIR[DTC]}/vpp_mrr_configuration_3n_aws"
 105     DIR[DTC,MRR,VPP,2N,AWS]: "{DIR[DTC]}/vpp_mrr_configuration_2n_aws"
 106     DIR[DTC,FUNC,VPP,DEVICE,UBUNTU]: "{DIR[DTC]}/vpp_device_configuration_ubuntu"
 107
 108     # Detailed tests operational data
 109     DIR[DTO]: "{DIR[WORKING,SRC]}/test_operational_data"
 110     DIR[DTO,PERF,VPP,ALL]: "{DIR[DTO]}/vpp_performance_operational_data"
 111     DIR[DTO,PERF,VPP,3N,SKX]: "{DIR[DTO]}/vpp_performance_operational_data_3n_skx"
 112     DIR[DTO,PERF,VPP,2N,SKX]: "{DIR[DTO]}/vpp_performance_operational_data_2n_skx"
 113     DIR[DTO,PERF,VPP,2N,ZN2]: "{DIR[DTO]}/vpp_performance_operational_data_2n_zn2"
 114     DIR[DTO,PERF,VPP,2N,CLX]: "{DIR[DTO]}/vpp_performance_operational_data_2n_clx"
 115     DIR[DTO,PERF,VPP,2N,ICX]: "{DIR[DTO]}/vpp_performance_operational_data_2n_icx"
 116     DIR[DTO,PERF,VPP,3N,ICX]: "{DIR[DTO]}/vpp_performance_operational_data_3n_icx"
 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,AWS]: "{DIR[DTO]}/vpp_performance_operational_data_3n_aws"
 122     DIR[DTO,PERF,VPP,2N,AWS]: "{DIR[DTO]}/vpp_performance_operational_data_2n_aws"
 123
 124     # Latencies:
 125     DIR[LAT,VPP]: "{DIR[WORKING,SRC]}/vpp_performance_tests/hdrh_packet_latency_by_percentile_graphs"
 126     DIR[LAT,DPDK]: "{DIR[WORKING,SRC]}/dpdk_performance_tests/hdrh_packet_latency_by_percentile_graphs"
 127     DIR[LAT,TREX]: "{DIR[WORKING,SRC]}/trex_performance_tests/hdrh_packet_latency_by_percentile_graphs"
 128
 129     # .css patch file to fix tables generated by Sphinx
 130     DIR[CSS_PATCH_FILE]: "{DIR[STATIC]}/theme_overrides.css"
 131     DIR[CSS_PATCH_FILE2]: "{DIR[WORKING,SRC,STATIC]}/theme_overrides.css"
 132
 133   # Data sources are used in this order:
 134   data-sources:
 135     # XML
 136     - type: "xml"
 137       url: "https://s3-logs.fd.io/vex-yul-rot-jenkins-1"
 138       path: "{job}/{build}/{filename}"
 139       file-name: "output_info.xml.gz"
 140       file-format: ".gz"
 141       enabled: True
 142     - type: "xml"
 143       url: "https://logs.nginx.service.consul/vex-yul-rot-jenkins-1"
 144       path: "{job}/{build}/archives/{filename}"
 145       file-name: "output_info.xml.gz"
 146       file-format: ".gz"
 147       enabled: True
 148     - type: "xml"
 149       url: "https://logs.nginx.service.consul/vex-yul-rot-jenkins-1"
 150       path: "{job}/{build}/{filename}"
 151       file-name: "output_info.xml.gz"
 152       file-format: ".gz"
 153       enabled: True
 154     # XML from S3 docs
 155     - type: "xml-docs"
 156       url: "https://s3-docs.fd.io/csit"
 157       path: "report/_static/archive"
 158       file-name: "output_info.xml.gz"
 159       file-format: ".gz"
 160       enabled: True
 161     - type: "xml-docs"
 162       url: "https://s3-docs.fd.io/csit"
 163       path: "report/_static/archive"
 164       file-name: "output.xml.gz"
 165       file-format: ".gz"
 166       enabled: True
 167
 168   archive-inputs: False
 169
 170   mapping-file: ""
 171
 172   ignore-list: ""
 173
 174   make-dirs:
 175   # List the directories which are created while preparing the environment.
 176   # All directories MUST be defined in "paths" section.
 177     - "DIR[WORKING,DATA]"
 178     - "DIR[STATIC,VPP]"
 179     - "DIR[STATIC,DPDK]"
 180     - "DIR[STATIC,TREX]"
 181     - "DIR[STATIC,ARCH]"
 182     - "DIR[BUILD,LATEX]"
 183     - "DIR[WORKING,SRC]"
 184     - "DIR[WORKING,SRC,STATIC]"
 185
 186   remove-dirs:
 187   # List the directories which are deleted while cleaning the environment.
 188   # All directories MUST be defined in "paths" section.
 189   #  - "DIR[BUILD,HTML]"
 190     - "DIR[WORKING,DATA]"
 191
 192   build-dirs:
 193   # List the directories where the results (build) is stored.
 194   # All directories MUST be defined in "paths" section.
 195     - "DIR[BUILD,HTML]"
 196     - "DIR[BUILD,LATEX]"
 197
 198   reverse-input: False  # Needed for trending, not important for the report
 199
 200   limits:
 201     nic:
 202       x520: 24460000
 203       x553: 29761905
 204       x710: 35800000
 205       xxv710: 35800000
 206       xl710: 35800000
 207       cx556a: 148809523.81
 208       e810cq: 148809523.81
 209
 210     link:
 211       10ge: 14880952.38
 212       25ge: 37202380.95
 213       40ge: 59523809.52
 214       100ge: 148809523.81
 215
 216     pci:
 217       pci-g3-x8: 74404761.90
 218       pci-g3-x16: 148809523.81
 219
 220 ################################################################################
 221 ###                               S T A T I C                                ###
 222 ################################################################################
 223
 224 - type: "static"
 225   src-path: "{DIR[RST]}"
 226   dst-path: "{DIR[WORKING,SRC]}"
 227
 228 ################################################################################
 229 ###                               O U T P U T                                ###
 230 ################################################################################
 231
 232 - type: "output"
 233   arch-file-format:
 234     - ".gz"
 235     - ".zip"
 236   output: "report"
 237   format:
 238     html:
 239       - full
 240     # pdf:
 241     #   - minimal