BuildExecutor.identifier for BinderHub /version endpoint

Author: manics

binderhub/app.py

@@ -865,6 +865,9 @@ def initialize(self, *args, **kwargs):
 
         launch_quota = self.launch_quota_class(parent=self, executor=self.executor)
 
+        # Construct a Builder so that we can extract the version string to pass to the
+        # /version handler
+        temporary_builder = self.builder_class(parent=self)
         self.tornado_settings.update(
             {
                 "log_function": log_request,
@@ -877,6 +880,7 @@ def initialize(self, *args, **kwargs):
                 "build_token_check_origin": self.build_token_check_origin,
                 "build_token_secret": self.build_token_secret,
                 "build_token_expires_seconds": self.build_token_expires_seconds,
+                "builder_identifier": temporary_builder.identifier,
                 "pod_quota": self.pod_quota,
                 "per_repo_quota": self.per_repo_quota,
                 "per_repo_quota_higher": self.per_repo_quota_higher,

binderhub/base.py

@@ -247,7 +247,7 @@ async def get(self):
         self.write(
             json.dumps(
                 {
-                    "builder": self.settings["build_image"],
+                    "builder": self.settings["builder_identifier"],
                     "binderhub": binder_version,
                 }
             )

binderhub/build.py

@@ -16,7 +16,7 @@
 from kubernetes import client, watch
 from tornado.ioloop import IOLoop
 from tornado.log import app_log
-from traitlets import Any, Bool, Dict, Integer, Unicode, default
+from traitlets import Any, Bool, Dict, Integer, Unicode, default, observe
 from traitlets.config import LoggingConfigurable
 
 from .utils import KUBE_REQUEST_TIMEOUT, rendezvous_rank
@@ -101,6 +101,15 @@ class BuildExecutor(LoggingConfigurable):
         config=True,
     )
 
+    identifier = Unicode(
+        "",
+        help=(
+            "Identifier or other metadata for the builder e.g. repo2docker version. "
+            "This is included in the BinderHub version endpoint"
+        ),
+        config=True,
+    )
+
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.main_loop = IOLoop.current()
@@ -239,6 +248,11 @@ def _default_namespace(self):
         config=True,
     )
 
+    @observe("build_image")
+    def _build_image_changed(self, change):
+        if not self.identifier:
+            self.identifier = change.new
+
     docker_host = Unicode(
         "/var/run/docker.sock",
         help=(