Update documentation to commit e68161c

commit e68161c Merge: 6d98001 e3ddc18 Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> AuthorDate: Wed Dec 13 21:38:12 2023 +0000 Commit: GitHub <[email protected]> CommitDate: Wed Dec 13 21:38:12 2023 +0000 Merge pull request os-autoinst#5395 from Martchus/doc-2 Improve documentation of cache service related variables in config
os-autoinst-bot · Dec 14, 2023 · 3585566 · 3585566
1 parent 5d4540f
commit 3585566
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 28 deletions.
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 2023-12-08 11:02:52 UTC
+Last updated 2023-12-14 02:27:48 UTC
 </div>
 </div>
 </body>

diff --git a/docs/current.pdf b/docs/current.pdf
diff --git a/docs/index.html b/docs/index.html
@@ -9836,8 +9836,9 @@ <h3 id="_multi_machine_test_setup">Multi-machine test setup</h3>
 <div class="title">Note</div>
 </td>
 <td class="content">
-Another way to setup the environment with <em>iptables</em> and <em>firewalld</em> is described
-on the <a href="https://fedoraproject.org/wiki/OpenQA_advanced_network_guide">Fedora wiki</a>.
+Another way to setup the environment with <em>iptables</em> and <em>firewalld</em> is
+described on the
+<a href="https://fedoraproject.org/wiki/OpenQA_advanced_network_guide">Fedora wiki</a>.
 </td>
 </tr>
 </table>
@@ -9849,9 +9850,11 @@ <h3 id="_multi_machine_test_setup">Multi-machine test setup</h3>
 <div class="title">Note</div>
 </td>
 <td class="content">
-Alternatively <a href="https://github.com/os-autoinst/salt-states-openqa">salt-states-openqa</a> contains
-necessities to establish such a setup and configure it for all workers with the <code>tap</code>
-worker class. They also cover GRE tunnels (that are explained in the next section).
+Alternatively
+<a href="https://github.com/os-autoinst/salt-states-openqa">salt-states-openqa</a> contains
+necessities to establish such a setup and configure it for all workers with the
+<code>tap</code> worker class. They also cover GRE tunnels (that are explained in the next
+section).
 </td>
 </tr>
 </table>
@@ -10032,10 +10035,10 @@ <h5 id="_configure_openqa_workers">Configure openQA workers</h5>
 <div class="sect2">
 <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>
+<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>
 </div>
 <div class="paragraph">
 <p>So you could call <code>openqa-clone-job</code> like this:</p>
@@ -10051,49 +10054,57 @@ <h3 id="_verify_the_setup">Verify the setup</h3>
 </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>
+<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>
+<p>Also be sure to reboot the worker host to make sure the setup is actually
+persistent.</p>
 </div>
 <div class="sect3">
 <h4 id="_start_test_vms_manually">Start test VMs manually</h4>
 <div class="paragraph">
 <p>You may also start VMs manually to verify the setup.</p>
 </div>
 <div class="paragraph">
-<p>First, download a suitable image and launch a VM in the same way <code>os-autoinst</code> would do
-for MM jobs:</p>
+<p>First, download a suitable image and launch a VM in the same way <code>os-autoinst</code>
+would do for MM jobs:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="pygments highlight"><code><span></span>wget http://download.opensuse.org/tumbleweed/appliances/openSUSE-Tumbleweed-Minimal-VM.x86_64-Cloud.qcow2
 qemu-system-x86_64 -m 2048 -enable-kvm -vnc :42 -snapshot \
-  -netdev tap,id=qanet0,ifname=tap39,script=no,downscript=no -device virtio-net,netdev=qanet0,mac=00:00:00:00:00:01 \
+  -netdev tap,id=qanet0,ifname=tap40,script=no,downscript=no \
+  -device virtio-net,netdev=qanet0,mac=52:54:00:13:0b:4a \
   openSUSE-Tumbleweed-Minimal-VM.x86_64-Cloud.qcow2</code></pre>
 </div>
 </div>
 <div class="paragraph">
-<p>The image used here is of course just an example. Within the VM configure the network
-<strong>like</strong> this (you may need to adjust concrete IP addresses, subnets and interface names):</p>
+<p>The image used here is of course just an example. You need to make sure to
+assign a unique MAC address (e.g. by adjusting the last two figures in the
+example; this will not conflict with MAC addresses used by os-autoinst) and use
+a tap device not used at the same time by a SUT-VM.</p>
+</div>
+<div class="paragraph">
+<p>Within the VM configure the network <strong>like</strong> this (you may need to adjust concrete
+IP addresses, subnets and interface names):</p>
 </div>
 <div class="listingblock">
 <div class="content">
-<pre class="pygments highlight"><code><span></span>ip a add dev eth0 10.0.2.15/24
+<pre class="pygments highlight"><code><span></span>ip link set dev eth0 up mtu 1458
+ip a add dev eth0 10.0.2.15/24
 ip r add default via 10.0.2.2
-ip link set dev eth0 mtu 1458
 echo &#39;nameserver 8.8.8.8&#39; &gt; /etc/resolv.conf</code></pre>
 </div>
 </div>
 <div class="paragraph">
-<p>The MTU is chosen in accordance with what the openSUSE test distribution uses for MM
-tests and should be below the MTU set on the Open vSwitch bridge device (e.g. via
-<code>os-autoinst-setup-multi-machine</code>).</p>
+<p>The MTU is chosen in accordance with what the openSUSE test distribution uses
+for MM tests and should be below the MTU set on the Open vSwitch bridge device
+(e.g. via <code>os-autoinst-setup-multi-machine</code>).</p>
 </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>
+<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>
 </div>
 </div>
 </div>
@@ -10108,7 +10119,8 @@ <h3 id="_debugging_open_vswitch_configuration">Debugging Open vSwitch Configurat
 <p>openvswitch (as above)</p>
 </li>
 <li>
-<p>wicked - creates the bridge <code>br1</code> and tap devices, adds tap devices to the bridge,</p>
+<p>wicked - creates the bridge <code>br1</code> and tap devices, adds tap devices to the
+bridge,</p>
 </li>
 <li>
 <p>firewalld (or SuSEfirewall2 in older setups)</p>
@@ -10221,7 +10233,8 @@ <h3 id="_debugging_open_vswitch_configuration">Debugging Open vSwitch Configurat
 <p>empty output indicates a problem with os-autoinst-openvswitch service</p>
 </li>
 <li>
-<p>zero packet count or missing rules in table=1 indicate problem with tap devices</p>
+<p>zero packet count or missing rules in table=1 indicate problem with tap
+devices</p>
 </li>
 </ul>
 </div>
@@ -12449,7 +12462,7 @@ <h3 id="_developing_tests_with_container_setup">Developing tests with container
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2023-12-08 10:59:21 UTC
+Last updated 2023-12-14 02:24:13 UTC
 </div>
 </div>
 </body>