Document sanitizer restrictions for remote run
@@ -40,3 +40,80 @@ Remote processing is also supported from the Python interface when the 'remote'
chip.set('remote', True)
+The SiliconCompiler cloud beta has some restrictions on allowed schema parameters. You are only allowed to specify the following, some of which have additional restrictions:
+
+.. list-table::
+ :widths: 10 10
+ :header-rows: 1
+
+ * - Keypath
+ - Restrictions
+
+ * - ``design``
+ - Must only contain alphanumeric characters or underscores
+ * - ``jobname``
+ - Must only contain alphanumeric characters or underscores
+ * - ``dir``
+ - Must only contain alphanumeric characters or underscores
+ * - ``constraint``
+ - Only allowed for fpgaflow
+ * - ``target``
+ - Must be one of ``asicflow_freepdk45``, ``asicflow_skywater130``, or ``fpgaflow_ice40up5k-sg48``
+ * - ``library, ...``
+ - Allowed if key isn't the name of a built-in PDK standard cell library
+ * - ``source``
+ - None
+ * - ``netlist``
+ - None
+ * - ``testbench``
+ - None
+ * - ``clock, ...``
+ - None
+ * - ``supply, ...``
+ - None
+ * - ``param, ...``
+ - None
+ * - ``define``
+ - None
+ * - ``ydir``
+ - None
+ * - ``idir``
+ - None
+ * - ``vlib``
+ - None
+ * - ``libext``
+ - None
+ * - ``cmdfile``
+ - None
+ * - ``vcd``
+ - None
+ * - ``saif``
+ - None
+ * - ``activityfactor``
+ - None
+ * - ``spef``
+ - None
+ * - ``sdf``
+ - None
+ * - ``exclude``
+ - None
+ * - ``asic, ...``
+ - None
+ * - ``metric, ...``
+ - None
+ * - ``fpga, ...``
+ - None
+ * - ``flowarg, ...``
+ - None
+ * - ``techarg, ...``
+ - None
+ * - ``clean``
+ - None
+ * - ``loglevel``
+ - None
+ * - ``vercheck``
+ - None
+ * - ``checkonly``
+ - None
+
+Values for disallowed keypaths will be silently dropped. In addition, note that the target() function will be re-run on the server, to ensure targets are set up with their default configurations.
