Merge pull request #280 from firesim/runfarm-prefix

Runfarm prefix environment variable

deploy/runtools/runtime_config.py

@@ -15,6 +15,8 @@ from runtools.firesim_topology_with_passes import FireSimTopologyWithPasses
 from runtools.workload import WorkloadConfig
 from runtools.run_farm import RunFarm
 from util.streamlogger import StreamLogger
+import os
+
 
 LOCAL_DRIVERS_BASE = "../sim/output/f1/"
 LOCAL_DRIVERS_GENERATED_SRC = "../sim/generated-src/f1/"
@@ -242,7 +244,8 @@ class InnerRuntimeConfiguration:
             rootLogger.warning(overridefield + "=" + overridevalue)
             runtime_dict[overridesection][overridefield] = overridevalue
 
-        self.runfarmtag = runtime_dict['runfarm']['runfarmtag']
+        runfarmtagprefix = "" if 'FIRESIM_RUNFARM_PREFIX' not in os.environ else os.environ['FIRESIM_RUNFARM_PREFIX'] + "-"
+        self.runfarmtag = runfarmtagprefix + runtime_dict['runfarm']['runfarmtag']
         self.f1_16xlarges_requested = int(runtime_dict['runfarm']['f1_16xlarges']) if 'f1_16xlarges' in runtime_dict['runfarm'] else 0
         self.f1_4xlarges_requested = int(runtime_dict['runfarm']['f1_4xlarges']) if 'f1_4xlarges' in runtime_dict['runfarm'] else 0
         self.m4_16xlarges_requested = int(runtime_dict['runfarm']['m4_16xlarges']) if 'm4_16xlarges' in runtime_dict['runfarm'] else 0

docs/Advanced-Usage/Manager/Manager-Environment-Variables.rst

@@ -0,0 +1,24 @@
+.. _manager-environment-variables:
+
+Manager Environment Variables
+===============================
+
+This page contains a centralized reference for the environment variables used
+by the manager.
+in ``config_runtime.ini``, ``config_build.ini``, ``config_build_recipes.ini``,
+and ``config_hwdb.ini``.
+
+.. _config-runtime:
+
+``FIRESIM_RUNFARM_PREFIX``
+--------------------------
+
+This environment variable is used to prefix all Run Farm tags with some prefix.
+This is useful for separating run farms between multiple copies of FireSim.
+
+This is set in ``sourceme-f1-manager.sh``, so you can change it and commit it
+(e.g. if you're maintaining a branch for special runs). It can be unset or set
+to the empty string.
+
+
+

docs/Advanced-Usage/Manager/Manager-Overview.rst

@@ -24,6 +24,8 @@ The manager gets configuration information from several places:
 
 - Configuration Files
 
+- Environment Variables
+
 - Topology definitions for networked simulations (``user_topology.py``)
 
 The following sections detail these inputs. Hit Next to continue.
@@ -38,3 +40,4 @@ encounter issues. The logs contain more detailed output than the manager
 sends to stdout/stderr during normal operation, so it's also useful if you
 want to take a peek at the detailed commands manager is running to facilitate
 builds and simulations. Logs are stored in ``firesim/deploy/logs/``.
+

docs/Advanced-Usage/Manager/index.rst

@@ -10,6 +10,7 @@ Manager Usage (the ``firesim`` command)
    Manager-Command-Line-Args
    Manager-Tasks
    Manager-Configuration-Files
+   Manager-Environment-Variables
    Manager-Topology-Definitions
    AGFI-Tagging
 

sourceme-f1-manager.sh

@@ -18,3 +18,7 @@ source deploy/ssh-setup.sh
 
 # flag for scripts to check that this has been sourced
 export FIRESIM_SOURCED=1
+
+# this is a prefix added to run farm names. change this to isolate run farms
+# if you have multiple copies of firesim
+export FIRESIM_RUNFARM_PREFIX=""