From c3c2f03b65fa2a321dc3bee4b263c8fbdc76fcef Mon Sep 17 00:00:00 2001
From: Scott Wales <scottwales@outlook.com.au>
Date: Wed, 10 Jan 2024 02:33:44 +1100
Subject: [PATCH] Document ssh forward environment variables (#650)

Document ssh forward environment variables

---------

Co-authored-by: Oliver Sanders <oliver.sanders@metoffice.gov.uk>
---
 CONTRIBUTING.md                               |  1 +
 .../config/writing-platform-configs.rst       | 74 ++++++++++++++++++-
 2 files changed, 73 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5c33efc356..cf1d3250ee 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -54,6 +54,7 @@ requests_).
  - Yinjing Lin
  - David Sutherland
  - Thomas Coleman
+ - Scott Wales
 <!-- end-shortlog -->
 
 (All contributors are identifiable with email addresses in the git version
diff --git a/src/reference/config/writing-platform-configs.rst b/src/reference/config/writing-platform-configs.rst
index b38d89bec5..7f5eb646b5 100644
--- a/src/reference/config/writing-platform-configs.rst
+++ b/src/reference/config/writing-platform-configs.rst
@@ -327,8 +327,8 @@ Symlinks for remote install targets are created during :ref:`RemoteInit` followi
 ``cylc play``.
 
 
-Advanced Platform Example
--------------------------
+Advanced Platform Examples
+--------------------------
 
 Platform with no ``$HOME`` directory
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -370,3 +370,73 @@ In this example Cylc will install workflows into
    If you are running :term:`schedulers <scheduler>` directly on the login node
    and submitting jobs locally then the platform name and install target should
    be ``localhost``.
+
+Sharing environment variables with the Cylc server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. admonition:: Scenario
+
+    An environment variable on the computer where you're running ``cylc play``
+    needs to be shared with the Cylc server (e.g. to set up storage paths)
+
+Normally if a Cylc server is running on a remote host it will not keep
+environment variables that are present when you run ``cylc play``. You can
+whitelist variables to be sent to remote servers using
+:cylc:conf:`global.cylc[platforms][<platform name>]ssh forward environment variables`.
+
+These variables are forwarded to the Cylc server and may be used in the
+`global.cylc` file templating.
+
+ .. code-block:: cylc
+    :caption: part of a ``global.cylc`` config file
+
+    [install]
+        [[symlink dirs]]
+            [[[hpc]]]
+                # Here the environment variable on the server is used
+                run = {{ environ['LUSTRE_DISK'] }}
+
+    [platforms]
+        # 'localhost' platform is used when communicating with the server
+        [[localhost]]
+            ssh forward environment variables = LUSTRE_DISK, PROJECT
+
+        [[hpc]]
+            submit method = pbs
+            [[[directives]]]
+                -P = {{ environ['PROJECT'] }}
+
+In this example Cylc will install workflows into the directory specified by
+``$LUSTRE_DISK`` and use the project specified by ``$PROJECT`` in the
+environment where you run ``cylc play``, e.g.
+
+ .. code-block:: sh
+
+    export LUSTRE_DISK=/g/data/foo
+    export PROJECT=bar
+    cylc play
+
+will store the workflow under ``/g/data/foo`` and submit jobs under project
+``bar``.
+
+You can also forward variables from the server to other platforms. You should
+first ensure the variable is available on the server, e.g. by also forwarding
+the variable to ``[[localhost]]``. 
+
+This setting only affects the task submission (e.g. ``qsub``) which may use
+environment variables to set default directives. To set a variable once the
+task has started see
+:cylc:conf:`global.cylc[platforms][<platform name>]copyable environment variables`.
+
+ .. code-block:: cylc
+    :caption: part of a ``global.cylc`` config file
+
+    [platforms]
+        [[localhost]]
+            ssh forward environment variables = PROJECT
+
+        [[hpc]]
+            # Here qsub has been configured to read from $PROJECT
+            ssh forward environment variables = PROJECT
+            submit method = pbs
+