C-Docs: Add information about the job triggering

Change-Id: Id99eac3365d7bb53d2f3aae3f0ffe47938c960ab
Signed-off-by: Tibor Frank <[email protected]>

diff --git a/docs/content/overview/csit/branching_strategy.md b/docs/content/overview/csit/branching_strategy.md
index 16d8e0f..1c4e33f 100644 (file)
--- a/docs/content/overview/csit/branching_strategy.md
+++ b/docs/content/overview/csit/branching_strategy.md
@@ -1,6 +1,6 @@
 ---
 title: "Branching Strategy"
-weight: 6
+weight: 7
 ---
 
 # Branching Strategy

diff --git a/docs/content/overview/csit/job_triggering.md b/docs/content/overview/csit/job_triggering.md
new file mode 100644 (file)
index 0000000..b11e2f5
--- /dev/null
+++ b/docs/content/overview/csit/job_triggering.md
@@ -0,0 +1,151 @@
+---
+title: "Job Triggering"
+weight: 6
+---
+
+# Job Triggering
+
+... or how to run the tests.
+
+The trigger consist of
+  - trigger name,
+  - tags (optional),
+  - trigger parameters for the suite generator (optional) - each parameter
+    starts with the hash tag "#" and parameters are separated by the white
+    space.
+
+## On-demand jobs
+
+### Report
+
+Both iterative and coverage jobs are triggered by user from gerrit.
+
+#### Iterative jobs
+
+Trigger name:
+  - csit-vpp-report-iter-`node`-`arch`-perftest
+
+Default values:
+  - iterative test set - the same as it is used for periodical jobs
+  - test type: mrr
+
+Mandatory trigger parameters:
+  - no mandatory parameters - default values are used in that case
+
+Optional trigger parameters:
+  - test set
+  - test type
+
+Examples:
+
+1. csit-vpp-report-iter-2n-emr-perftest
+   - Generates default test set and default test type.
+
+2. csit-vpp-report-iter-2n-emr-perftest #ndrpdr
+   - Generates default test set and ndrpdr tests.
+
+3. csit-vpp-report-iter-2n-emr-perftest #2n-emr-vpp-hoststack
+
+   csit-vpp-report-iter-2n-emr-perftest #2n-emr-vpp-hoststack #hoststack
+   - Generates hoststack test set.
+   - It is not necessary to specify the test type as it is defined in the name
+     of the test set, so both examples are equal and correct.
+
+#### Coverage jobs
+
+Trigger name:
+  - csit-vpp-report-cov-`node`-`arch`-perftest
+
+Default values:
+  - test type: ndrpdr
+
+Mandatory trigger parameters:
+  - test set
+
+Optional trigger parameters:
+  - test type, default value: ndrpdr
+
+Examples:
+
+1. csit-vpp-report-cov-2n-emr-perftest #2n-emr-vpp-cov-ip4-00
+   - Generates the defined test set, ndrpdr tests.
+
+### Development
+
+#### Verify jobs
+
+Trigger name:
+  - csit-`node`-`arch`-perftest `tags`
+
+Default values:
+  - iterative test set - the same as it is used for periodical jobs
+  - test type: mrr
+
+Mandatory trigger parameters:
+  - no mandatory parameters - default values are used in that case
+
+Optional trigger parameters:
+  - test set
+  - test type
+
+Examples:
+
+1. csit-2n-emr-perftest `tags`
+   - Generates iterative mrr tests, runs only those selected by tags.
+
+2. csit-2n-emr-perftest `tags` #2n-emr-vpp-cov-ip4-00 #ndrpdr
+   - Generates defined test set, ndrpdr tests, runs only those selected by tags.
+
+#### Bisect jobs
+
+Trigger name:
+  - bisecttest-`node`-`arch` `commit` `tags`
+
+Default values:
+  - iterative test set - the same as it is used for periodical jobs
+  - test type: mrr
+
+Mandatory trigger parameters:
+  - no mandatory parameters - default values are used in that case
+
+Optional trigger parameters:
+  - test set
+  - test type
+
+Examples:
+
+1. bisecttest-2n-emr `commit` `tags`
+   - Generates iterative mrr tests, runs only those selected by tags.
+
+2. bisecttest-2n-emr `commit` `tags` #2n-emr-vpp-cov-ip4-00 #ndrpdr
+   - Generates defined test set, ndrpdr tests, runs only those selected by tags.
+
+#### Special cases
+
+##### Tox
+
+If the job name includes the string "tox", all tests defined in all test sets
+are generated. Tox job does not run any tests.
+
+##### generate-all
+
+If the string "generate-all" is in the trigger, all tests defined in all test
+sets are generated.
+
+This can be used with verify or bisect jobs if you do not know which test set
+includes required test(s). Be careful and use proper tags to specify the
+test(s).
+
+Examples:
+
+1. csit-2n-emr-perftest `tags` #generate-all
+   - Generates all tests specified in all test sets, runs only those selected by
+     tags.
+
+2. bisecttest-2n-emr `commit` `tags` #generate-all
+   - Generates all tests specified in all test sets, runs only those selected by
+     tags.
+
+## Periodical jobs
+
+The user does not use these jobs as they are periodicaly triggered by Jenkins.

diff --git a/docs/content/overview/csit/suite_generation.md b/docs/content/overview/csit/suite_generation.md
index 84a19b8..e22447a 100644 (file)
--- a/docs/content/overview/csit/suite_generation.md
+++ b/docs/content/overview/csit/suite_generation.md
@@ -5,6 +5,8 @@ weight: 5
 
 # Suite Generation
 
+**This chapter will be completly re-written.**
+
 CSIT uses robot suite files to define tests. However, not all suite files
 available for Jenkins jobs (or manually started bootstrap scripts) are present
 in CSIT git repository. They are generated only when needed.