Update Jupyterhub to allow user specification of a base URL and path

for the public facing proxy

Author: mcduffie

dev_env/cognito/cognito_client.tf

@@ -6,8 +6,8 @@ resource "aws_cognito_user_pool_client" "jupyter_cognito_client" {
   name          = "${var.resource_prefix}-jupyter-${var.tenant_identifier}-client"
   user_pool_id  = tolist(data.aws_cognito_user_pools.unity_user_pool.ids)[0]
 
-  callback_urls = var.jupyter_base_url != null ? ["${var.jupyter_base_url}/hub/oauth_callback"] : null
-  logout_urls   = var.jupyter_base_url != null ? ["${var.jupyter_base_url}/hub/login/oauth_callback/logout"] : null
+  callback_urls = var.jupyter_base_url != null ? ["${var.jupyter_base_url}/${var.jupyter_base_path}/hub/oauth_callback"] : null
+  logout_urls   = var.jupyter_base_url != null ? ["${var.jupyter_base_url}/${var.jupyter_base_path}/hub/login/oauth_callback/logout"] : null
 
   allowed_oauth_flows                           = var.jupyter_base_url != null ? ["code"] : null
   allowed_oauth_flows_user_pool_client          = var.jupyter_base_url != null ? true : null

dev_env/cognito/jupyter_url_env.sh

@@ -13,5 +13,7 @@ fi
 cd $(realpath $script_dir/..)/jupyterhub
 
 jupyter_url=$(terraform output -raw jupyter_base_url)
+jupyter_url=$(terraform output -raw jupyter_base_path)
 
 echo "export TF_VAR_jupyter_base_url=\"${jupyter_url}\""
+echo "export TF_VAR_jupyter_base_path=\"${jupyter_path}\""

dev_env/cognito/local_variables.tf

@@ -9,3 +9,9 @@ variable "jupyter_base_url" {
   type        = string
   default     = null
 }
+
+variable "jupyter_base_path" {
+  description = "Base path after URL of the JupyterHub instance"
+  type        = string
+  default     = null
+}

dev_env/jupyterhub/frontend.tf

@@ -36,6 +36,9 @@ module "frontend" {
   load_balancer_port = var.load_balancer_port
   jupyter_proxy_port = var.jupyter_proxy_port
 
+  jupyter_base_url = var.jupyter_base_url
+  jupyter_base_path = var.jupyter_base_path
+
   vpc_id = data.aws_ssm_parameter.vpc_id.value
   lb_subnet_ids = local.subnet_map["public"]
   security_group_id = aws_security_group.jupyter_lb_sg.id

dev_env/jupyterhub/jupyter_config.yaml

@@ -64,7 +64,7 @@ hub:
       binaryData: ${unity_auth_py}
   config:
     OAuthenticator:
-      oauth_callback_url: ${jupyter_base_url}/hub/oauth_callback
+      oauth_callback_url: ${oauth_callback_url}
       client_id: ${oauth_client_id}
       client_secret: ${oauth_client_secret}
       admin_users: ${admin_users}

dev_env/jupyterhub/jupyter_helm.tf

@@ -13,6 +13,7 @@ resource "helm_release" "jupyter_helm" {
       cognito_oauth_base_url = var.cognito_oauth_base_url
       oauth_client_id        = var.cognito_oauth_client_id
       oauth_client_secret    = var.cognito_oauth_client_secret
+      oauth_callback_url     = module.frontend.jupyter_base_path != "" ? "${module.frontend.jupyter_base_url}/${module.frontend.jupyter_base_path}/hub/oauth_callback" : "${module.frontend.jupyter_base_url}/hub/oauth_callback"
       jupyter_base_path      = module.frontend.jupyter_base_path != "" ? "/${module.frontend.jupyter_base_path}/" : "/"
       jupyter_base_url       = module.frontend.jupyter_base_url
       jupyter_proxy_port     = var.jupyter_proxy_port

dev_env/jupyterhub/jupyter_variables.tf

@@ -16,6 +16,22 @@ variable "jupyter_proxy_port" {
   default    = 32232
 }
 
+# Public facing URL minus jupyter_base_path
+# Do not supply trailing slashes
+variable "jupyter_base_url" {
+  description = "Base URL minus path for Jupyter as accessed at its public facing location"
+  type       = string
+  default    = null
+}
+
+# Base path for jupyter appended to base path of frontend module
+# Do not supply leading or trailing slashes
+variable "jupyter_base_path" {
+  description = "Base path for Jupyter as accessed at its public facing location"
+  type       = string
+  default    = ""
+}
+
 variable "cognito_oauth_base_url" {
   description = "Base URL for using the Cognito Open Auth 2 interface"
   type        = string

dev_env/jupyterhub/modules/load_balancer/main.tf

@@ -26,7 +26,7 @@ resource "aws_lb_target_group" "jupyter_alb_target_group" {
 
   # alter the destination of the health check
   health_check {
-    path = "/hub/health"
+    path = var.jupyter_base_path != "" ? "/${var.jupyter_base_path}/hub/health" : "/hub/health"
     port = var.jupyter_proxy_port
   }
 }

dev_env/jupyterhub/modules/load_balancer/outputs.tf

@@ -1,7 +1,7 @@
 output "jupyter_base_path" {
-  value = ""
+  value = var.jupyter_base_path
 }
 
 output "jupyter_base_url" {
-  value = "https://${aws_lb.jupyter_alb.dns_name}:${var.load_balancer_port}"
+  value = var.jupyter_base_url != null ? var.jupyter_base_url : "https://${aws_lb.jupyter_alb.dns_name}:${var.load_balancer_port}"
 }

dev_env/jupyterhub/modules/load_balancer/variables.tf

@@ -22,6 +22,20 @@ variable "jupyter_proxy_port" {
   type       = number
 }
 
+# Do not supply trailing slashes
+variable "jupyter_base_url" {
+  description = "Base URL minus path for Jupyter as accessed at its public facing location"
+  type       = string
+  default    = null
+}
+
+# Do not include leading or training slashes
+variable "jupyter_base_path" {
+  description = "Base path for Jupyter as accessed at its public facing location"
+  type       = string
+  default    = ""
+}
+
 ###################################
 # Frontend module common variables