Submit AYON_SERVER_URL to jobs

client/ayon_deadline/plugins/publish/global/collect_deadline_job_env_vars.py

@@ -1,10 +1,3 @@
-# -*- coding: utf-8 -*-
-"""Collect Deadline servers from instance.
-
-This is resolving index of server lists stored in `deadlineServers` instance
-attribute or using default server if that attribute doesn't exists.
-
-"""
 import os
 
 import pyblish.api
@@ -44,6 +37,7 @@ class CollectDeadlineJobEnvVars(pyblish.api.ContextPlugin):
     ]
 
     def process(self, context):
+
         env = {}
         for key in self.ENV_KEYS:
             value = os.getenv(key)
@@ -53,3 +47,15 @@ def process(self, context):
 
         # Transfer some environment variables from current context
         context.data.setdefault(JOB_ENV_DATA_KEY, {}).update(env)
+
+
+class CollectAYONServerToFarmJob(CollectDeadlineJobEnvVars):
+    label = "Add AYON Server URL to farm job"
+    settings_category = "deadline"
+
+    # Defined via settings
+    enabled = False
+
+    ENV_KEYS = [
+        "AYON_SERVER_URL"
+    ]

client/ayon_deadline/repository/custom/plugins/Ayon/Ayon.param

@@ -33,3 +33,12 @@ CategoryOrder=2
 Index=0
 Default=
 Description=API key for service account on Ayon Server
+
+[AyonAdditionalServerUrls]
+Type=multilinestring
+Label=Additional AYON Servers
+Category=Additional AYON Servers
+CategoryOrder=3
+Index=0
+Default=
+Description=An AYON server URL per line suffixed with `@APIKEY` from a service user on that AYON server, e.g. `http://server:5000@veryinsecureapikey`.

client/ayon_deadline/repository/custom/plugins/GlobalJobPreLoad.py

@@ -13,7 +13,7 @@
     FileUtils,
     DirectoryUtils,
 )
-__version__ = "1.1.3"
+__version__ = "1.1.4"
 VERSION_REGEX = re.compile(
     r"(?P<major>0|[1-9]\d*)"
     r"\.(?P<minor>0|[1-9]\d*)"
@@ -410,6 +410,43 @@ def inject_openpype_environment(deadlinePlugin):
         raise
 
 
+def get_ayon_api_key_from_additional_servers(config, server):
+    """Get AYON API key from the list of additional servers.
+
+    The additional servers are configured on the DeadlineRepository AYON
+    Plug-in settings using the `AyonAdditionalServerUrls` param. Each line
+    represents a server URL with an API key, like:
+        server1:port@APIKEY1
+        server2:port@APIKEY2
+
+    Returns:
+        Optional[str]: If the server URL is found in the additional servers
+            then return the API key for that server.
+
+    """
+    additional_servers: str = config.GetConfigEntryWithDefault(
+        "AyonAdditionalServerUrls", "").strip()
+    if not additional_servers:
+        return
+
+    for line in additional_servers:
+        line = line.strip()
+        # Ignore empty lines
+        if not line:
+            continue
+
+        # Log warning if additional server URL is misconfigured
+        # without an API key
+        if "@" not in line:
+            print("Configured additional server URL lacks "
+                  f"`@APIKEY` suffix: {line}")
+            continue
+
+        additional_server, api_key = line.split("@", 1)
+        if additional_server == server:
+            return api_key
+
+
 def inject_ayon_environment(deadlinePlugin):
     """ Pull env vars from AYON and push them to rendering process.
 
@@ -439,14 +476,35 @@ def inject_ayon_environment(deadlinePlugin):
             )
 
         config = RepositoryUtils.GetPluginConfig("Ayon")
-        ayon_server_url = (
-            job.GetJobEnvironmentKeyValue("AYON_SERVER_URL") or
-            config.GetConfigEntryWithDefault("AyonServerUrl", "")
-        )
-        ayon_api_key = (
-            job.GetJobEnvironmentKeyValue("AYON_API_KEY") or
-            config.GetConfigEntryWithDefault("AyonApiKey", "")
-        )
+
+        ayon_server_url = config.GetConfigEntryWithDefault("AyonServerUrl", "")
+        ayon_api_key = config.GetConfigEntryWithDefault("AyonApiKey", "")
+        job_ayon_server_url = job.GetJobEnvironmentKeyValue("AYON_SERVER_URL")
+        job_ayon_api_key = job.GetJobEnvironmentKeyValue("AYON_API_KEY")
+
+        # API key submitted with job environment will always take priority
+        if job_ayon_api_key:
+            ayon_api_key = job_ayon_api_key
+
+        # Allow custom AYON API key per server URL if server URL is submitted
+        # along with the job. The custom API keys can be configured on the
+        # Deadline Repository AYON Plug-in settings, in the format of
+        # `SERVER:PORT@APIKEY` per line.
+        elif job_ayon_server_url and job_ayon_server_url != ayon_server_url:
+            ayon_server_url = job_ayon_server_url
+            api_key = get_ayon_api_key_from_additional_servers(
+                config, job_ayon_server_url)
+            if api_key:
+                ayon_api_key = api_key
+            else:
+                print(
+                    "AYON Server URL submitted with job"
+                    f" '{job_ayon_server_url}' is not the Deadline AYON"
+                    f" Plug-in default server URL '{ayon_server_url}' but"
+                    " has no API key defined in Additional Server URLs."
+                    " Falling back to default API key configured in"
+                    " Deadline repository for the AYON plug-in."
+                )
 
         if not all([ayon_server_url, ayon_api_key]):
             raise RuntimeError((

server/settings/publish_plugins.py

@@ -7,6 +7,10 @@
 )
 
 
+class CollectAYONServerToFarmJobModel(BaseSettingsModel):
+    enabled: bool = SettingsField(False, title="Enabled")
+
+
 class CollectDeadlinePoolsModel(BaseSettingsModel):
     """Settings Deadline default pools."""
 
@@ -373,6 +377,15 @@ class PublishPluginsModel(BaseSettingsModel):
     CollectDeadlinePools: CollectDeadlinePoolsModel = SettingsField(
         default_factory=CollectDeadlinePoolsModel,
         title="Default Pools")
+    CollectAYONServerToFarmJob: CollectAYONServerToFarmJobModel = SettingsField(  # noqa
+        default_factory=CollectAYONServerToFarmJobModel,
+        title="Add AYON server to farm job",
+        description=(
+            "When enabled submit along your `AYON_SERVER_URL` to the farm job."
+            " On the Deadline AYON Plug-in on the Deadline Repository settings"
+            " you can specify a custom API key for those server URLs."
+        )
+    )
     ValidateExpectedFiles: ValidateExpectedFilesModel = SettingsField(
         default_factory=ValidateExpectedFilesModel,
         title="Validate Expected Files"
@@ -425,6 +438,9 @@ class PublishPluginsModel(BaseSettingsModel):
         "primary_pool": "",
         "secondary_pool": ""
     },
+    "CollectAYONServerToFarmJob": {
+        "enabled": False
+    },
     "ValidateExpectedFiles": {
         "enabled": True,
         "active": True,