mirror of
				https://github.com/ARM-software/workload-automation.git
				synced 2025-11-04 00:52:08 +00:00 
			
		
		
		
	doc: documenting remote_assets_path
Adding documentation explaining how to use remote_assets_path setting.
This commit is contained in:
		@@ -136,6 +136,12 @@ Available Settings
 | 
			
		||||
   All three values should be Python `old-style format strings`_ specifying which
 | 
			
		||||
   `log record attributes`_ should be displayed.
 | 
			
		||||
 | 
			
		||||
.. confval:: remote_assets_path
 | 
			
		||||
 | 
			
		||||
   Path to the local mount of a network assets repository. See
 | 
			
		||||
   :ref:`assets_repository`.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
There are also a couple of settings are used to provide additional metadata
 | 
			
		||||
for a run. These may get picked up by instruments or result processors to 
 | 
			
		||||
attach  context to results.
 | 
			
		||||
 
 | 
			
		||||
@@ -261,6 +261,22 @@ This is the list of workloads that rely on such recordings:
 | 
			
		||||
| truckerparking3d |
 | 
			
		||||
+------------------+
 | 
			
		||||
 | 
			
		||||
.. _assets_repository:
 | 
			
		||||
 | 
			
		||||
Maintaining Centralized Assets Repository
 | 
			
		||||
-----------------------------------------
 | 
			
		||||
 | 
			
		||||
If there are multiple users within an organization that may need to deploy
 | 
			
		||||
assets for WA extensions, that organization may wish to maintain a centralized
 | 
			
		||||
repository of assets that individual WA installs will be able to automatically
 | 
			
		||||
retrieve asset files from as they are needed. This repository can be any
 | 
			
		||||
directory on a network filer that mirrors the structure of
 | 
			
		||||
``~/.workload_automation/dependencies``, i.e. has a subdirectories named after
 | 
			
		||||
the extensions which assets they contain. Individual WA installs can then set
 | 
			
		||||
``remote_assets_path`` setting in their config to point to the local mount of
 | 
			
		||||
that location.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
(Optional) Uninstalling
 | 
			
		||||
=======================
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user