ucsdets/group-sync

group-sync 镜像文档

镜像概述

group-sync是一个用于从AWSEd同步用户组到DSMLP（Data Science and Machine Learning Platform）的工具，主要功能包括创建工作区和管理Pod安全策略（目前已被OPA取代）。该镜像旨在简化Kubernetes环境中用户组与工作区的同步流程，适用于教育机构或需要集中管理Kubernetes工作区的场景。

核心功能与特性

• 组同步：从AWSEd平台同步用户组信息至DSMLP
• 工作区创建：根据同步的组信息自动创建对应的Kubernetes工作区
• Pod安全策略管理：支持创建和配置Pod安全策略（已被OPA取代，仅保留历史支持）
• 环境变量配置：通过环境变量灵活配置同步参数
• Kubernetes集成：支持通过Kubernetes配置文件或ConfigMap进行部署

使用场景

• 教育机构中管理课程或班级对应的Kubernetes工作区
• 需要从AWSEd平台同步用户组信息并自动配置工作环境的场景
• Kubernetes集群中批量创建和管理与用户组关联的工作区资源

使用方法

Docker 直接运行

bash
docker run --rm -it --network host \
-e AWSED_API_KEY=your_api_key \
-v /path/to/admin.conf:/root/.kube/config:ro \
docker.xuanyuan.run/ucsd-ets/group-sync:latest

Kubernetes 部署

bash
kubectl delete pod group-sync -n group-sync
kubectl run group-sync -it \
--namespace=group-sync \
--generator=run-pod/v1 \
--image=ucsdets/group-sync:latest \
--image-pull-policy=Always \
--env AWSED_ENDPOINT=https://awsed-dev.ucsd.edu/api \
--env AWSED_API_KEY=your_api_key \
--env AWSED_API_SLUG=dsmlp \
--env COURSE_IDS=BIPN162_S120_A00 \
--env PSP_ENABLED=False \
--env HOMES_ENABLED=True \
--env FORCE_CREATE=False \
--serviceaccount default \
--requests=cpu=100m,memory=256Mi

配置说明

环境变量

Kubernetes 配置

• Kubernetes配置文件需位于~/.kube/config或通过ConfigMap提供
• 需配置适当的RBAC权限以允许镜像操作Kubernetes资源

RBAC权限配置示例

yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: {{ include "group-sync.fullname" . }}
rules:
- apiGroups: ["extensions", "policy"]
  resources: ["podsecuritypolicies"]
  verbs: ["get", "patch", "update"]
- apiGroups: [""]
  resources:
  - persistentvolumeclaims
  verbs:
  - list
  - create
  - get
- apiGroups: [""]
  resources:
  - persistentvolumes
  verbs:
  - get
  - list
  - create
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: {{ include "group-sync.fullname" . }}
subjects:
- kind: ServiceAccount
  namespace: group-sync
  name: default
roleRef:
  kind: ClusterRole
  name: group-sync
  apiGroup: rbac.authorization.k8s.io

开发与测试

开发环境搭建

Ubuntu/WSL 2

bash
<cd to repository base>
sudo apt install python3.8-venv

macOS（使用Homebrew）

bash
<cd to repository base>
brew install python@3.8

通用步骤

bash
python3.8 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

测试

• 单元测试：

  bash
  tox
  

• 集成测试（需Docker环境）：

  bash
  ./run_integration_tests.sh
  

编译Protobuf文件

bash
tox -e protoc