Add new option admin_environment

- This is environment which is intended to be passed only to the batch
  commands, not to the user servers.  However, it is unknown if any
  spawners support this.  Don't rely on it unless the spawner
  explicitely says it supports it.

Author: rkdarst

CHANGELOG.md

@@ -9,6 +9,7 @@ Added (user)
 * Add `req_prologue` and `req_epilogue` options to scripts which are inserted before/after the main jupyterhub-singleuser command, which allow for generic setup/cleanup without overriding the entire script.  #96
 * SlurmSpawner: add the `req_reservation` option.  #91
 * Add basic support for JupyterHub progress updates, but this is not used much yet.  #86
++* Add the option `admin_environment` which get passed to the batch submission commands (like for authentication) but *not* to the `--export
 
 Added (developer)
 

README.md

@@ -98,6 +98,10 @@ shell which will execute arbitrary user environment configuration
 access to their own cluster user account.  This is something which we
 are working on.
 
+The `admin_environment` option claims to pass environment only to the
+batch spawners, and not the user servers.  This relies on each spawner
+handling environment correctly, and this is *not* checked so you
+should *not* rely on this yet.
 
 ## Provide different configurations of BatchSpawner
 

SPAWNERS.md

@@ -34,6 +34,8 @@ environment to be used, set `req_srun=''`.  However, this is not
 perfect: there is still a bash shell begun as the user which could run
 arbitrary startup, define shell aliases for `srun`, etc.
 
+`admin_environment` does work with SlurmSpawner.
+
 Use of `srun` is required to gracefully terminate.
 
 

batchspawner/batchspawner.py

@@ -213,6 +213,23 @@ def cmd_formatted_for_batch(self):
         """The command which is substituted inside of the batch script"""
         return ' '.join([self.batchspawner_singleuser_cmd] + self.cmd + self.get_args())
 
+    def get_admin_env(self):
+        """Get the environment passed to the batch submit/cancel/etc commands.
+
+        This contains all of the output from self.get_env(), plus any
+        variables defined in self.admin_environment.  In fact, only this
+        command is used to pass to batch commands, and the only use of
+        self.get_env() is producing the list of variables to be
+        --export='ed to.  Everything in get_env *must* also be in here
+        or else it won't be used.
+        """
+        env = self.get_env()
+        if self.admin_environment:
+            for key in self.admin_environment.split(','):
+                if key in os.environ and key not in env:
+                    env[key] = os.environ[key]
+        return env
+
     async def run_command(self, cmd, input=None, env=None):
         proc = await asyncio.create_subprocess_shell(cmd, env=env,
                                                     stdin=asyncio.subprocess.PIPE,