Merge pull request #5437 from os-autoinst-bot/gh-pages-240125044519

Update documentation to commit 99100fe
os-autoinst · Jan 25, 2024 · bc122b6 · bc122b6
2 parents bc761c0 + d289b61
commit bc122b6
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 65 deletions.
diff --git a/docs/api/schema/JobScenarios-01.yaml b/docs/api/schema/JobScenarios-01.yaml
@@ -4,9 +4,9 @@ description: Definitions for openQA job scenarios
 type: object
 additionalProperties: false
 required:
-- job_templates
+  - job_templates
 patternProperties:
-  '^\.[a-z0-9_]+$':
+  ^\.[a-z0-9_]+$:
     type: object
     description: Definitions that can be re-used
 
@@ -15,7 +15,7 @@ properties:
     type: object
     additionalProperties: false
     patternProperties:
-      '^[A-Za-z0-9._*-]+$':
+      ^[A-Za-z0-9._*-]+$:
         type: object
         description: The name of a product (medium)
         required:
@@ -40,14 +40,14 @@ properties:
             description: Additional test variables to be set
             additionalProperties: false
             patternProperties:
-              '^[A-Z_+]+[A-Z0-9_]*$':
+              ^[A-Z_+]+[A-Z0-9_]*$:
                 type: string
 
   machines:
     type: object
     additionalProperties: false
     patternProperties:
-      '^[A-Za-z0-9._*-]+$':
+      ^[A-Za-z0-9._*-]+$:
         type: object
         description: The name of a machine
         required:
@@ -66,7 +66,7 @@ properties:
     type: object
     additionalProperties: false
     patternProperties:
-      '^[A-Za-z\s0-9_*.+-]+$':
+      ^[A-Za-z\s0-9_*.+-]+$:
         type: object
         description: The name of the job template
         additionalProperties: false

diff --git a/docs/api/schema/JobTemplates-01.yaml b/docs/api/schema/JobTemplates-01.yaml
@@ -4,10 +4,10 @@ description: openQA job template
 type: object
 additionalProperties: false
 required:
-- products
-- scenarios
+  - products
+  - scenarios
 patternProperties:
-  '^\.[a-z0-9_]+$':
+  ^\.[a-z0-9_]+$:
     type: object
     description: Definitions that can be re-used
 
@@ -17,60 +17,60 @@ properties:
     type: object
     additionalProperties: false
     patternProperties:
-      '^[a-z0-9_]+$':
+      ^[a-z0-9_]+$:
         type: object
         description: The architecture of the test suite(s) eg. ppc64le
         patternProperties:
-          '^.*$':
+          ^.*$:
             type: array
             description: The product to run the test suite(s) on
             items:
               anyOf:
-              - type: string
-                description: Name of a test suite name
-              - type: object
-                maxProperties: 1
-                description: A test suite with machine and/or priority value specified, or a custom job template name if testsuite was specified
-                additionalProperties: false
-                patternProperties:
-                  &testsuite-pattern '^[A-Za-z\s0-9_*.+-]+$':
-                    type: object
-                    additionalProperties: false
-                    properties:
-                      machine: &machine-definition
-                        oneOf:
-                          - type: string
-                          - type: array
-                            items:
+                - type: string
+                  description: Name of a test suite name
+                - type: object
+                  maxProperties: 1
+                  description: A test suite with machine and/or priority value specified, or a custom job template name if testsuite was specified
+                  additionalProperties: false
+                  patternProperties:
+                    &testsuite-pattern ^[A-Za-z\s0-9_*.+-]+$:
+                      type: object
+                      additionalProperties: false
+                      properties:
+                        machine: &machine-definition
+                          oneOf:
                             - type: string
-                      priority: &priority-definition
-                        type: number
-                      settings: &settings-definition
-                        type: object
-                        description: Additional test variables to be set
-                        additionalProperties: false
-                        patternProperties:
-                          '^[A-Z_+]+[A-Z0-9_]*$':
-                            type: string
-                      testsuite:
-                        type: [string, 'null']
-                        pattern: *testsuite-pattern
-                        description: The test suite this scenario is based on if a custom job template name was used
-                      description:
-                        type: string
-                        description: The description of the job template
+                            - type: array
+                              items:
+                                - type: string
+                        priority: &priority-definition
+                          type: number
+                        settings: &settings-definition
+                          type: object
+                          description: Additional test variables to be set
+                          additionalProperties: false
+                          patternProperties:
+                            ^[A-Z_+]+[A-Z0-9_]*$:
+                              type: string
+                        testsuite:
+                          type: [string, 'null']
+                          pattern: *testsuite-pattern
+                          description: The test suite this scenario is based on if a custom job template name was used
+                        description:
+                          type: string
+                          description: The description of the job template
 
   defaults:
     description: A set of architectures with default configurations
     type: object
     additionalProperties: false
     patternProperties:
-      '^[a-z0-9_]+$':
+      ^[a-z0-9_]+$:
         type: object
         description: The architecture to define a default configuration for eg. ppc64le
         required:
-        - machine
-        - priority
+          - machine
+          - priority
         additionalProperties: false
         properties:
           machine: *machine-definition
@@ -81,7 +81,7 @@ properties:
     type: object
     additionalProperties: false
     patternProperties:
-      '^[A-Za-z0-9._*-]+$':
+      ^[A-Za-z0-9._*-]+$:
         type: object
         description: The name of a product (medium)
         required:

diff --git a/docs/api/testapi.html b/docs/api/testapi.html
@@ -2078,7 +2078,7 @@ <h5 id="_backend_get_wait_still_screen_on_here_doc_input">backend_get_wait_still
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-01-12 04:47:08 UTC
+Last updated 2024-01-25 04:47:40 UTC
 </div>
 </div>
 </body>

diff --git a/docs/current.pdf b/docs/current.pdf
diff --git a/docs/index.html b/docs/index.html
@@ -6148,10 +6148,16 @@ <h3 id="asset_cleanup">Cleanup strategy for assets</h3>
 (unless cloned into a job group).</p>
 </div>
 <div class="paragraph">
+<p>If an asset is just a symlink then only the symlink is cleaned up (but not
+the file or directory it points to).</p>
+</div>
+<div class="paragraph">
 <p>'Fixed' assets - those placed in the <code>fixed</code> subdirectory of the relevant
 asset directory - are counted against the group size limit, but are never
 cleaned up. This is intended for things like base disk images which must
-always be available for a test to work.</p>
+always be available for a test to work. Note that relative symlinks in the
+regular assets directory that point into the <code>fixed</code> subdirectory are also
+preserved.</p>
 </div>
 </div>
 <div class="sect2">
@@ -10171,27 +10177,25 @@ <h3 id="_verify_the_setup">Verify the setup</h3>
 <div class="paragraph">
 <p>Simply run a MM test scenario. For openSUSE, you can find many relevant tests on
 <a href="https://openqa.opensuse.org">o3</a>, e.g. look for networking-related tests like
-wicked-tests. To test GRE tunnels, you may want to change the jobs worker
-classes so the different jobs are executed on different workers.</p>
+<code>ping_server</code>/<code>ping_client</code> or <code>wicked_basic_ref</code>/<code>wicked_basic_sut</code>.</p>
 </div>
 <div class="paragraph">
-<p>So you could call <code>openqa-clone-job</code> like this:</p>
+<p>To test GRE tunnels, you may want to change the jobs worker classes so the
+different jobs are executed on different workers. So you could call
+<code>openqa-clone-job</code> like this:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="pygments highlight"><code><span></span>openqa-clone-job \
-    --skip-download --skip-chained-deps \    # assuming assets are present
-    --max-depth 0 \                          # clone the entire parallel cluster
-    --export-command \                       # only print the API call
-    https://openqa.opensuse.org/tests/250309 # arbitrary job in cluster to clone
-    _GROUP=0 BUILD+=test-mm-setup            # avoid interfering with production jobs</code></pre>
+    --skip-download --skip-chained-deps \        # assuming assets are present
+    --max-depth 0 \                              # clone the entire parallel cluster
+    https://openqa.opensuse.org/tests/3886213 \  # arbitrary job in cluster to clone
+    _GROUP=0 BUILD+=test-mm-setup \              # avoid interfering with production jobs
+    WORKER_CLASS:wicked_basic_ref+=,worker_foo \ # ensure one job runs on `worker_foo`
+    WORKER_CLASS:wicked_basic_sut+=,worker_bar   # ensure other job runs on `worker_bar`</code></pre>
 </div>
 </div>
 <div class="paragraph">
-<p>It will print an <code>openqa-cli</code> call. You can modify it to change the worker
-classes of the jobs individually and then invoke it.</p>
-</div>
-<div class="paragraph">
 <p>Also be sure to reboot the worker host to make sure the setup is actually
 persistent.</p>
 </div>
@@ -10225,7 +10229,7 @@ <h4 id="_start_test_vms_manually">Start test VMs manually</h4>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="pygments highlight"><code><span></span>ip link set dev eth0 up mtu 1458
+<pre class="pygments highlight"><code><span></span>ip link set dev eth0 up mtu 1380
 ip a add dev eth0 10.0.2.15/24
 ip r add default via 10.0.2.2
 echo &#39;nameserver 8.8.8.8&#39; &gt; /etc/resolv.conf</code></pre>
@@ -10238,7 +10242,12 @@ <h4 id="_start_test_vms_manually">Start test VMs manually</h4>
 </div>
 <div class="paragraph">
 <p>After this it should be possible to reach other hosts. You may also launch a 2nd
-VM to see whether the VMs can talk to each other.</p>
+VM to see whether the VMs can talk to each other. You may conduct ping tests
+similar to the <code>ping_client</code> test mentioned in the previous section (see the
+<a href="https://github.com/os-autoinst/os-autoinst-distri-opensuse/blob/cc3a5b32527c4c8bb810c8bce9b1449a891ef74b/lib/utils.pm#L2901">utility function in openSUSE tests</a>
+for details). When running ping you can add/remove machines to/from the GRE
+network to bisect problematic hosts/connections (via <code>ovs-vsctl add-port …</code> and
+<code>ovs-vsctl del-port …</code>).</p>
 </div>
 </div>
 </div>
@@ -10269,7 +10278,8 @@ <h3 id="_debugging_open_vswitch_configuration">Debugging Open vSwitch Configurat
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="pygments highlight"><code data-lang="sh"><span></span>ovs-vsctl<span class="tok-w"> </span>show<span class="tok-w"> </span><span class="tok-c1"># shows the bridge br1, the tap devices are assigned to it</span>
+<pre class="pygments highlight"><code data-lang="sh"><span></span>cat<span class="tok-w"> </span>/proc/sys/net/ipv4/conf/<span class="tok-o">{</span>br1,eth0<span class="tok-o">}</span>/forwarding<span class="tok-w"> </span><span class="tok-c1"># check whether IP forwarding is enabled</span>
+ovs-vsctl<span class="tok-w"> </span>show<span class="tok-w"> </span><span class="tok-c1"># shows the bridge br1, the tap devices are assigned to it</span>
 ovs-ofctl<span class="tok-w"> </span>dump-flows<span class="tok-w"> </span>br1<span class="tok-w"> </span><span class="tok-c1"># shows the rules installed by os-autoinst-openvswitch in table=0</span>
 ovs-dpctl<span class="tok-w"> </span>show<span class="tok-w"> </span><span class="tok-c1"># show basic info on all datapaths</span>
 ovs-dpctl<span class="tok-w"> </span>dump-flows<span class="tok-w"> </span><span class="tok-c1"># displays flows in datapaths</span>
@@ -12604,7 +12614,7 @@ <h3 id="_developing_tests_with_container_setup">Developing tests with container
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-01-12 04:44:12 UTC
+Last updated 2024-01-25 04:44:25 UTC
 </div>
 </div>
 </body>