Add custom environment variable options to pool configuration

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Added
 - Sample Windows container recipes
+- Added environment variables to pool configuration, which allows users to
+setup Batch environment variables for the start task.
 
 ### Fixed
 - Some commands were incorrectly failing due to nodeid conflicts with

config_templates/pool.yaml

@@ -129,3 +129,5 @@ pool_specification:
       - kata_containers
       - singularity
     default: null
+  environment_variables:
+    abc: 'xyz'

convoy/fleet.py

@@ -1677,6 +1677,14 @@ def _construct_pool_object(
                 value=block_for_gr,
             )
         )
+    # add custom env vars to the batch start task
+    env_vars = pool_settings.environment_variables
+    if util.is_not_empty(env_vars):
+        for key in env_vars:
+            pool.start_task.environment_settings.append(
+                batchmodels.EnvironmentSetting(name=key, value=env_vars[key])
+            )
+    del env_vars
     # Linux-only settings
     if not is_windows:
         # singularity env vars

convoy/settings.py

@@ -187,7 +187,7 @@
         'autoscale', 'node_fill_type', 'remote_access_control',
         'certificates', 'prometheus', 'upload_diagnostics_logs_on_unusable',
         'container_runtimes_install', 'container_runtimes_default',
-        'per_job_auto_scratch',
+        'per_job_auto_scratch', 'environment_variables',
     ]
 )
 SSHSettings = collections.namedtuple(
@@ -1328,6 +1328,8 @@ def pool_settings(config):
         container_runtimes_default=cr_default,
         per_job_auto_scratch=_kv_read(
             conf, 'per_job_auto_scratch', default=False),
+        environment_variables=_kv_read_checked(
+            conf, 'environment_variables', default={}),
     )
 
 

docs/13-batch-shipyard-configuration-pool.md

@@ -137,6 +137,8 @@ pool_specification:
       - kata_containers
       - singularity
     default: null
+  environment_variables:
+    abc: 'xyz'
 ```
 
 The `pool_specification` property has the following members:
@@ -572,6 +574,9 @@ behavior on the pool compute nodes.
     * (optional) `default` is the default container runtime to use for
       running Docker containers. This option has no effect on `singularity`
       containers.
+* (optional) `environment_variables` that are set on the Azure Batch start
+task. Note that environment variables are not expanded and are passed
+as-is.
 
 ## Full template
 A full template of a credentials file can be found

schemas/pool.yaml

@@ -364,3 +364,8 @@ mapping:
           default:
             type: str
             enum: ['kata_containers', 'runc']
+      environment_variables:
+        type: map
+        mapping:
+          regex;(.+):
+            type: str