feat(docs): Hugo
[csit.git] / docs / content / introduction / perf_triggers_design.md
1 ---
2 bookHidden: true
3 title: "Performance Triggers Design"
4 ---
5
6 # Performance Triggers Design
7
8 *Syntax*
9   trigger_keyword [{tag1} {tag2}AND{tag3} !{tag4} !{tag5}]
10
11 *Inputs*
12   - trigger_keyword for vpp-* jobs: 'perftest'
13   - trigger_keyword for csit-* jobs: 'csit-perftest'
14   - tags: existing CSIT tags [4]_ i.e. ip4base, ip6base, iacldst, memif
15
16 Set of default tags appended to user input, under control by CSIT
17   - always-on for vpp-csit*.job: 'mrr' 'nic_intel_x710-da2' '1t1c'
18   - if input with no tags, following set applied:
19      - 'mrrANDnic_intel-x710AND1t1cAND64bANDip4base'
20      - 'mrrANDnic_intel-x710AND1t1cAND78bANDip6base'
21      - 'mrrANDnic_intel-x710AND1t1cAND64bANDl2bdbase'
22
23 Examples
24   input: 'perftest'
25     expanded: 'mrrANDnic_intel_x710-da2AND1t1cAND64bANDl2bdbase mrrANDnic_intel_x710-da2AND1t1cAND64bANDip4base mrrANDnic_intel_x710-da2AND1t1cAND78bANDip6base'
26   input: 'perftest l2bdbase l2xcbase'
27     expanded: 'mrrANDnic_intel_x710-da2ANDl2bdbase mrrANDnic_intel_x710-da2ANDl2xcbase'
28   input: 'perftest ip4base !feature'
29     expanded: 'mrrANDnic_intel_x710-da2ANDip4base' not 'feature'
30   input: 'perftest ip4base !feature !lbond_dpdk'
31     expanded: 'mrrANDnic_intel_x710-da2ANDip4base' not 'feature' not 'lbond_dpdk'
32   input: 'perftestxyx ip4base !feature !lbond_dpdk'
33     invalid: detected as error
34   input: 'perftestip4base !feature !lbond_dpdk'
35     invalid: detected as error
36   input: 'perftest ip4base!feature!lbond_dpdk'
37     invalid expand: 'mrrANDnic_intel_x710-da2ANDip4base!feature!lbond_dpdk'
38     execution of RobotFramework will fail
39
40 Constrains
41   Trigger keyword must be different for every job to avoid running multiple jobs
42   at once. Trigger keyword must not be substring of job name or any other
43   message printed by JJB bach to gerrit message which can lead to recursive
44   execution.