wmit/jupyterhub-k8s-hub-casauth

JupyterHub with CAS Authentication 镜像文档

镜像概述和主要用途

本Docker镜像集成了https://github.com/cwaldbieser/jhub_cas_authenticator%E5%BA%93%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%9E%84%E5%BB%BA%E6%94%AF%E6%8C%81CAS%EF%BC%88%E4%B8%AD%E5%A4%AE%E8%AE%A4%E8%AF%81%E6%9C%8D%E5%8A%A1%EF%BC%89%E8%BA%AB%E4%BB%BD%E9%AA%8C%E8%AF%81%E7%9A%84JupyterHub%E7%8E%AF%E5%A2%83%E3%80%82%E4%B8%BB%E8%A6%81%E7%94%A8%E9%80%94%E6%98%AF%E5%9C%A8Kubernetes%E9%9B%86%E7%BE%A4%E4%B8%AD%E9%83%A8%E7%BD%B2JupyterHub%E6%97%B6%EF%BC%8C%E9%80%9A%E8%BF%87CAS%E6%9C%8D%E5%8A%A1%E5%AE%9E%E7%8E%B0%E7%94%A8%E6%88%B7%E8%BA%AB%E4%BB%BD%E7%BB%9F%E4%B8%80%E8%AE%A4%E8%AF%81%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8E%E9%9C%80%E8%A6%81%E4%B8%8E%E7%8E%B0%E6%9C%89CAS%E7%B3%BB%E7%BB%9F%E9%9B%86%E6%88%90%E7%9A%84%E6%9C%BA%E6%9E%84%E6%88%96%E7%BB%84%E7%BB%87%E3%80%82

核心功能和特性

• CAS认证集成：内置JupyterHub CAS Authenticator库，支持通过CAS服务验证用户身份
• 多CAS版本兼容：支持CAS 3和CAS 5版本的服务验证URL配置
• Kubernetes兼容：可配合kubespawner在Kubernetes环境中管理用户容器
• Helm部署支持：提供Helm图表配置示例，简化在K8s集群中的部署流程

使用场景和适用范围

• 需要集中身份认证的教育机构、企业部署JupyterHub
• 已使用CAS系统进行统一身份管理的组织
• 在Kubernetes集群中搭建多用户JupyterHub环境
• 需实现用户身份统一验证和访问控制的场景

使用方法和配置说明

前置要求

• 已安装Helm包管理工具
• 已配置Kubernetes集群环境
• 可访问的CAS服务（CAS 3或CAS 5版本）

部署步骤

通过Helm安装JupyterHub时，使用自定义配置指定本镜像及CAS认证参数：

1. 创建或修改Helm配置文件（如config.yaml）

2. 应用配置部署JupyterHub：

   bash
   helm upgrade --install jupyterhub jupyterhub/jupyterhub --namespace jupyterhub --create-namespace -f config.yaml
   

配置示例

以下是完整的Helm配置示例（config.yaml）：

yaml
---
prePuller:
  enabled: false  # 禁用镜像预拉取
rbac:
  enabled: false  # 禁用RBAC权限控制（根据实际环境调整）
hub:
  image:
    name: wmit/jupyterhub-k8s-hub-casauth  # 使用本CAS认证镜像
    tag: v0.5.0  # 镜像版本
  extraConfig: |
    import jhub_cas_authenticator.cas_auth  # 导入CAS认证模块
proxy:
  secretToken: "your-secret-token-here"  # 代理服务密钥（需替换为实际安全密钥）
auth:
  type: custom  # 指定自定义认证类型
  custom:
    className: jhub_cas_authenticator.cas_auth.CASAuthenticator  # CAS认证器类
    config:
      cas_login_url: https://cas.example.edu/cas/login  # CAS登录URL（替换为实际CAS服务地址）
      cas_service_url: https://jupyterhub.example.edu/login  # JupyterHub服务URL（替换为实际部署地址）
      cas_service_validate_url: https://cas.example.edu/cas/p3/serviceValidate  # CAS 5服务验证URL
      # cas_service_validate_url: https://cas.example.edu/cas/serviceValidate  # CAS 3服务验证URL（根据CAS版本选择）
  admin:
    users:
      - user1  # 管理员用户列表
      - user2

关键配置参数说明

配置文件获取

示例配置文件也可在GitHub仓库中获取：https://github.com/WMInfoTech/jupyterhub-k8s-hub-casauth/blob/master/config.yaml