Update documentation to commit a8824eb

commit a8824eb Merge: da5fbe6 bc927f2 Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> AuthorDate: Tue Oct 29 17:39:17 2024 +0000 Commit: GitHub <[email protected]> CommitDate: Tue Oct 29 17:39:17 2024 +0000 Merge pull request os-autoinst#6034 from perlpunk/fix-boolean Return 0/1 explicitly as the client expects it
os-autoinst-bot · Oct 30, 2024 · 29cf26e · 29cf26e
1 parent c8c3553
commit 29cf26e
Show file tree

Hide file tree

Showing 3 changed files with 117 additions and 2 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 2024-10-11 04:47:41 UTC
+Last updated 2024-10-30 04:49:13 UTC
 </div>
 </div>
 </body>

diff --git a/docs/current.pdf b/docs/current.pdf
diff --git a/docs/index.html b/docs/index.html
@@ -653,6 +653,11 @@ <h1>openQA Documentation</h1>
 </ul>
 </li>
 <li><a href="#_automatic_installation_of_the_operating_systems_for_openqa_machines">Automatic installation of the operating systems for openQA machines</a></li>
+<li><a href="#_special_network_conditions">Special network conditions</a>
+<ul class="sectlevel2">
+<li><a href="#_wireguard">WireGuard</a></li>
+</ul>
+</li>
 <li><a href="#_troubleshooting">Troubleshooting</a>
 <ul class="sectlevel2">
 <li><a href="#troubleshooting">Tests fail quickly</a></li>
@@ -4096,6 +4101,116 @@ <h2 id="_automatic_installation_of_the_operating_systems_for_openqa_machines">Au
 </div>
 </div>
 <div class="sect1">
+<h2 id="_special_network_conditions">Special network conditions</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>There might be certain situations where the openQA workers cannot reach the openQA webui directly.
+In this case a reverse connection via SSH or WireGuard might be useful allowing the openQA webui
+to connect to a worker opening a backchannel.</p>
+</div>
+<div class="sect2">
+<h3 id="_wireguard">WireGuard</h3>
+<div class="paragraph">
+<p>For WireGuard using wg-quick is recommended.</p>
+</div>
+<div class="paragraph">
+<p>To generate a private (first line) and a public (second line) key for each peer use this command:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="pygments highlight"><code data-lang="sh"><span></span>wg<span class="tok-w"> </span>genkey<span class="tok-w"> </span><span class="tok-p">|</span><span class="tok-w"> </span>tee<span class="tok-w"> </span>/dev/stderr<span class="tok-w"> </span><span class="tok-p">|</span><span class="tok-w"> </span>wg<span class="tok-w"> </span>pubkey</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Create a config in <code>/etc/wireguard/openqa.conf</code> on the webui host:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="pygments highlight"><code data-lang="ini"><span></span><span class="tok-k">[Interface]</span>
+<span class="tok-na">Address</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">fd0a::1/128</span>
+<span class="tok-na">PrivateKey</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">+++ INSERT PRIVATE KEY of webui +++</span>
+
+<span class="tok-k">[Peer]</span>
+<span class="tok-c1"># Name = worker1</span>
+<span class="tok-na">PublicKey</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">+++ INSERT PUBLIC KEY OF worker1 +++</span>
+<span class="tok-na">Endpoint</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">worker1:51820</span>
+<span class="tok-na">AllowedIPs</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">fd0a::2/128</span>
+<span class="tok-na">PersistentKeepalive</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">60</span>
+
+<span class="tok-k">[Peer]</span>
+<span class="tok-c1"># Name = worker2</span>
+<span class="tok-na">PublicKey</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">+++ INSERT PUBLIC KEY OF worker2 +++</span>
+<span class="tok-na">Endpoint</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">worker2:51820</span>
+<span class="tok-na">AllowedIPs</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">fd0a::3/128</span>
+<span class="tok-na">PersistentKeepalive</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">60</span></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Create a config in <code>/etc/wireguard/openqa.conf</code> on the worker1 host (and analog on other worker hosts):</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="pygments highlight"><code data-lang="ini"><span></span><span class="tok-k">[Interface]</span>
+<span class="tok-na">Address</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">fd0a::2/128</span>
+<span class="tok-na">PrivateKey</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">+++ INSERT PRIVATE KEY HERE +++</span>
+<span class="tok-na">ListenPort</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">51820</span>
+
+<span class="tok-k">[Peer]</span>
+<span class="tok-c1"># Name = webui</span>
+<span class="tok-na">PublicKey</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">+++ INSERT PUBLIC KEY OF webui +++</span>
+<span class="tok-na">AllowedIPs</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">fd0a::1/128</span></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>On all peers run now:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="pygments highlight"><code data-lang="sh"><span></span>zypper<span class="tok-w"> </span>-n<span class="tok-w"> </span><span class="tok-k">in</span><span class="tok-w"> </span>wireguard-tools
+systemctl<span class="tok-w"> </span><span class="tok-nb">enable</span><span class="tok-w"> </span>--now<span class="tok-w"> </span>wg-quick@openqa</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Then update <code>/etc/openqa/workers.ini</code> on the workers like this:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="pygments highlight"><code data-lang="ini"><span></span><span class="tok-k">[global]</span>
+<span class="tok-na">HOST</span><span class="tok-o">=</span><span class="tok-s">[fd0a::1]</span>
+
+<span class="tok-k">[[fd0a::1]]</span>
+<span class="tok-na">TESTPOOLSERVER</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">rsync://[fd0a::1]/tests</span></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Same for <code>/etc/openqa/client.conf</code></p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="pygments highlight"><code data-lang="ini"><span></span><span class="tok-k">[[fd0a::1]]</span>
+<span class="tok-na">key</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">FOO</span>
+<span class="tok-na">secret</span><span class="tok-w"> </span><span class="tok-o">=</span><span class="tok-w"> </span><span class="tok-s">BAR</span></code></pre>
+</div>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+The IPv6 address is written in square brackets as it is internally
+converted to a URL which requires this notation.
+This is also the reason why host specific section headers need to
+have double brackets (one for the ini format, one for the IPv6 host notation).
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
 <h2 id="_troubleshooting">Troubleshooting</h2>
 <div class="sectionbody">
 <div class="sect2">
@@ -13062,7 +13177,7 @@ <h3 id="_developing_tests_with_container_setup">Developing tests with container
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-10-11 04:44:34 UTC
+Last updated 2024-10-30 04:45:08 UTC
 </div>
 </div>
 </body>