Update documentation to commit e206546

commit e206546 Merge: 493cce4 6960512 Author: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> AuthorDate: Thu Feb 6 17:00:31 2025 +0000 Commit: GitHub <[email protected]> CommitDate: Thu Feb 6 17:00:31 2025 +0000 Merge pull request os-autoinst#6131 from marmarek/sync-assets-hook Add SYNC_ASSETS_HOOK support
os-autoinst-bot · Feb 7, 2025 · 6e69bb9 · 6e69bb9
1 parent 6801564
commit 6e69bb9
Show file tree

Hide file tree

Showing 3 changed files with 34 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 2025-02-01 04:48:04 UTC
+Last updated 2025-02-07 04:48:28 UTC
 </div>
 </div>
 </body>

diff --git a/docs/current.pdf b/docs/current.pdf
diff --git a/docs/index.html b/docs/index.html
@@ -619,6 +619,7 @@ <h1>openQA Documentation</h1>
 <li><a href="#_configuring_amqp_message_emission">Configuring AMQP message emission</a></li>
 <li><a href="#_configuring_worker_to_use_more_than_one_openqa_server">Configuring worker to use more than one openQA server</a></li>
 <li><a href="#asset-caching">Asset and test/needle caching</a></li>
+<li><a href="#_alternative_caching_implementations">Alternative caching implementations</a></li>
 <li><a href="#_enable_linking_files_referred_by_job_settings">Enable linking files referred by job settings</a></li>
 <li><a href="#_enable_custom_hook_scripts_on_job_done_based_on_result">Enable custom hook scripts on "job done" based on result</a></li>
 <li><a href="#_automatic_cloning_of_incomplete_jobs">Automatic cloning of incomplete jobs</a></li>
@@ -3223,6 +3224,37 @@ <h3 id="asset-caching">Asset and test/needle caching</h3>
 </div>
 </div>
 <div class="sect2">
+<h3 id="_alternative_caching_implementations">Alternative caching implementations</h3>
+<div class="paragraph">
+<p>Caching described above works well for a single worker host, but in case of
+several hosts in a single site (that is remote from the main openQA webui
+instance) it results in downloading the same assets several times. In
+such case, one can setup local cache on their own (without using
+openqa-worker-cacheservice service) and share it with workers using
+some network filesystem (see <a href="#Configuring remote workers">[Configuring remote workers]</a>
+section above).
+Such setups can use <code>SYNC_ASSETS_HOOK</code> in <code>/etc/openqa/workers.ini</code> to ensure
+the cache is up to date before starting the job (or resuming test in developer
+mode). The setting takes a shell command that is executed just before
+evaluating assets. It is up to the system administrator to decide what it
+should do, but there are few suggestions:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Call rsync, possibly via ssh on the cache host</p>
+</li>
+<li>
+<p>Wait for a lock file signaling that cache download is in progress to disappear</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>If the command exits with code 32, re-downloading needles in developer mode
+will be skipped.</p>
+</div>
+</div>
+<div class="sect2">
 <h3 id="_enable_linking_files_referred_by_job_settings">Enable linking files referred by job settings</h3>
 <div class="paragraph">
 <p>Specific job settings might refer to files within the test distribution.
@@ -13238,7 +13270,7 @@ <h3 id="_developing_tests_with_container_setup">Developing tests with container
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-02-01 04:44:31 UTC
+Last updated 2025-02-07 04:44:53 UTC
 </div>
 </div>
 </body>