!1 可通过 YAML 创建 CRD DevcontainerApp (StatefulSet + NodePort_Service)

* 优化 DevcontainerApp Reconciler 逻辑 * Added Readiness Probing * Updated port num validation * Updated Quickstart Doc * Replaced Nginx Ingress Controller with NodePort Service * Updated resource creation: * Added resource creation * Added .editorconfig
2025-09-09 03:25:50 +00:00 · 2024-09-25 01:51:11 +00:00
parent 5c990464ee
commit c10befe9f8
11 changed files with 494 additions and 61 deletions
--- a/internal/controller/devcontainerapp_controller.go
+++ b/internal/controller/devcontainerapp_controller.go
@@ -19,12 +19,19 @@ package controller
 import (
 	"context"

+	"k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/types"
+
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/log"

-	devcontainerv1 "devstar.cn/DevcontainerApp/api/v1"
+	devcontainer_v1 "devstar.cn/DevcontainerApp/api/v1"
+	devcontainer_controller_utils "devstar.cn/DevcontainerApp/internal/controller/utils"
+	apps_v1 "k8s.io/api/apps/v1"
+	core_v1 "k8s.io/api/core/v1"
+	k8s_sigs_controller_runtime_utils "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 )

 // DevcontainerAppReconciler reconciles a DevcontainerApp object
@@ -39,7 +46,7 @@ type DevcontainerAppReconciler struct {

 // Reconcile is part of the main kubernetes reconciliation loop which aims to
 // move the current state of the cluster closer to the desired state.
-// TODO(user): Modify the Reconcile function to compare the state specified by
+// Modify the Reconcile function to compare the state specified by
 // the DevcontainerApp object against the actual cluster state, and then
 // perform operations to make the cluster state reflect the state specified by
 // the user.
@@ -47,16 +54,83 @@ type DevcontainerAppReconciler struct {
 // For more details, check Reconcile and its Result here:
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.19.0/pkg/reconcile
 func (r *DevcontainerAppReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	_ = log.FromContext(ctx)
+	logger := log.FromContext(ctx)
+	var err error

-	// TODO(user): your logic here
+	// 1. 读取缓存中的 DevcontainerApp
+	app := &devcontainer_v1.DevcontainerApp{}
+	err = r.Get(ctx, req.NamespacedName, app)
+	if err != nil {
+		// 当 CRD 资源 “DevcontainerApp” 被删除后，直接返回空结果，跳过剩下步骤
+		return ctrl.Result{}, client.IgnoreNotFound(err)
+	}

+	// 2. 根据 DevcontainerApp 配置信息进行处理
+	// 2.1 StatefulSet 处理
+	statefulSet := devcontainer_controller_utils.NewStatefulSet(app)
+	err = k8s_sigs_controller_runtime_utils.SetControllerReference(app, statefulSet, r.Scheme)
+	if err != nil {
+		return ctrl.Result{}, err
+	}
+
+	// 2.2 查找 集群中同名称的 StatefulSet
+	statefulSetInNamespace := &apps_v1.StatefulSet{}
+	err = r.Get(ctx, req.NamespacedName, statefulSetInNamespace)
+	if err != nil {
+		if !errors.IsNotFound(err) {
+			return ctrl.Result{}, err
+		}
+		err = r.Create(ctx, statefulSet)
+		if err != nil && !errors.IsAlreadyExists(err) {
+			logger.Error(err, "Failed to create StatefulSet")
+			return ctrl.Result{}, err
+		}
+	} else {
+		// 这里会反复触发更新
+		// 原因：在 SetupWithManager方法中，监听了 StatefulSet ，所以只要更新 StatefulSet 就会触发
+		//     此处更新和 controllerManager 更新 StatefulSet 都会触发更新事件，导致循环触发
+		//修复方法：加上判断条件，仅在 app.Spec.StatefulSet.Image != statefulSet.Spec.Template.Spec.Containers[0].Image 时才更新 StatefulSet
+		if app.Spec.StatefulSet.Image != statefulSet.Spec.Template.Spec.Containers[0].Image {
+			if err := r.Update(ctx, statefulSet); err != nil {
+				return ctrl.Result{}, err
+			}
+		}
+	}
+
+	// 2.2 Service 处理
+	service := devcontainer_controller_utils.NewService(app)
+	if err := k8s_sigs_controller_runtime_utils.SetControllerReference(app, service, r.Scheme); err != nil {
+		return ctrl.Result{}, err
+	}
+	serviceInCluster := &core_v1.Service{}
+	err = r.Get(ctx, types.NamespacedName{Name: app.Name, Namespace: app.Namespace}, serviceInCluster)
+	if err != nil {
+		if !errors.IsNotFound(err) {
+			return ctrl.Result{}, err
+		}
+		err = r.Create(ctx, service)
+		if err == nil {
+			// 创建 NodePort Service 成功只执行一次 ==> 将NodePort 端口分配信息更新到 app.Status
+			logger.Info("[DevStar][DevContainer] NodePort Assigned", "nodePortAssigned", service.Spec.Ports[0].NodePort)
+
+			app.Status.NodePortAssigned = uint16(service.Spec.Ports[0].NodePort)
+			if err := r.Status().Update(ctx, app); err != nil {
+				logger.Error(err, "Failed to update NodePort of DevcontainerApp", "nodePortAssigned", service.Spec.Ports[0].NodePort)
+				return ctrl.Result{}, err
+			}
+		} else if !errors.IsAlreadyExists(err) {
+			logger.Error(err, "Failed to create DevcontainerApp NodePort Service", "nodePortServiceName", service.Name)
+			return ctrl.Result{}, err
+		}
+	}
 	return ctrl.Result{}, nil
 }

 // SetupWithManager sets up the controller with the Manager.
 func (r *DevcontainerAppReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
-		For(&devcontainerv1.DevcontainerApp{}).
+		For(&devcontainer_v1.DevcontainerApp{}).
+		Owns(&apps_v1.StatefulSet{}).
+		Owns(&core_v1.Service{}).
 		Complete(r)
 }
--- a/internal/controller/templates/service.yaml
+++ b/internal/controller/templates/service.yaml
@@ -0,0 +1,24 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{.ObjectMeta.Name}}-svc
+  namespace: {{.ObjectMeta.Namespace}}
+spec:
+  selector:
+    app: {{.ObjectMeta.Name}}
+    devstar-resource-type: devstar-devcontainer
+  sessionAffinity: None
+  type: NodePort
+  externalTrafficPolicy: Cluster
+  internalTrafficPolicy: Cluster
+  ipFamilyPolicy: SingleStack
+  ipFamilies:
+  - IPv4
+  ports:
+  - name: ssh-port
+    protocol: TCP
+    port: 22
+    targetPort: {{.Spec.StatefulSet.ContainerPort}}
+    {{ if .Spec.Service.NodePort}}
+    nodePort: {{.Spec.Service.NodePort}}
+    {{ end }}
--- a/internal/controller/templates/statefulset.yaml
+++ b/internal/controller/templates/statefulset.yaml
@@ -0,0 +1,74 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: {{.ObjectMeta.Name}}
+  namespace: {{.ObjectMeta.Namespace}}
+  labels:
+    app: {{.ObjectMeta.Name}}
+    devstar-resource-type: devstar-devcontainer
+spec:
+  podManagementPolicy: OrderedReady
+  replicas: 1
+  selector:
+    matchLabels:
+      app: {{.ObjectMeta.Name}}
+      devstar-resource-type: devstar-devcontainer
+  template:
+    metadata:
+      labels:
+        app: {{.ObjectMeta.Name}}
+        devstar-resource-type: devstar-devcontainer
+    spec:
+      containers:
+        - name: {{.ObjectMeta.Name}}
+          image: {{.Spec.StatefulSet.Image}}
+          command:
+          {{range .Spec.StatefulSet.Command}}
+          - {{.}}
+          {{end}}
+          imagePullPolicy: IfNotPresent
+          ports:
+            - name: ssh-port
+              protocol: TCP
+              containerPort: {{.Spec.StatefulSet.ContainerPort}}
+          volumeMounts:
+          - name: pvc-devcontainer
+            mountPath: /data
+          livenessProbe:
+            exec:
+              command:
+              - /bin/sh
+              - -c
+              - exec ls ~
+            failureThreshold: 6
+            initialDelaySeconds: 10
+            periodSeconds: 10
+            successThreshold: 1
+            timeoutSeconds: 5
+          readinessProbe:
+            exec:
+              command:
+              - /bin/sh
+              - -c
+              - exec cat /etc/ssh/ssh_host*.pub
+          resources:
+            limits:
+              cpu: 300m
+              ephemeral-storage: 8Gi
+              memory: 512Mi
+            requests:
+              cpu: 100m
+              ephemeral-storage: 50Mi
+              memory: 128Mi
+  volumeClaimTemplates:
+    - apiVersion: v1
+      kind: PersistentVolumeClaim
+      metadata:
+        name: pvc-devcontainer
+      spec:
+        storageClassName: openebs-hostpath
+        accessModes:
+        - ReadWriteOnce
+        resources:
+          requests:
+            storage: 10Gi
--- a/internal/controller/utils/template_utils.go
+++ b/internal/controller/utils/template_utils.go
@@ -0,0 +1,60 @@
+package utils
+
+import (
+	"bytes"
+	"text/template"
+
+	devcontainer_apps_v1 "devstar.cn/DevcontainerApp/api/v1"
+	app_v1 "k8s.io/api/apps/v1"
+	core_v1 "k8s.io/api/core/v1"
+	yaml_util "k8s.io/apimachinery/pkg/util/yaml"
+)
+
+const (
+	TemplatePath = "internal/controller/templates/"
+)
+
+// parseTemplate 解析 Go Template 模板文件
+func parseTemplate(templateName string, app *devcontainer_apps_v1.DevcontainerApp) []byte {
+	tmpl, err := template.
+		New(templateName + ".yaml").
+		Funcs(template.FuncMap{"default": DefaultFunc}).
+		ParseFiles(TemplatePath + templateName + ".yaml")
+	if err != nil {
+		panic(err)
+	}
+	b := new(bytes.Buffer)
+	err = tmpl.Execute(b, app)
+	if err != nil {
+		panic(err)
+	}
+	return b.Bytes()
+}
+
+// NewStatefulSet 创建 StatefulSet
+func NewStatefulSet(app *devcontainer_apps_v1.DevcontainerApp) *app_v1.StatefulSet {
+	statefulSet := &app_v1.StatefulSet{}
+	err := yaml_util.Unmarshal(parseTemplate("statefulset", app), statefulSet)
+	if err != nil {
+		panic(err)
+	}
+	return statefulSet
+}
+
+// NewService 创建 Service
+func NewService(app *devcontainer_apps_v1.DevcontainerApp) *core_v1.Service {
+	service := &core_v1.Service{}
+	err := yaml_util.Unmarshal(parseTemplate("service", app), service)
+	if err != nil {
+		panic(err)
+	}
+	return service
+}
+
+// DefaultFunc 函数用于实现默认值
+func DefaultFunc(value interface{}, defaultValue interface{}) interface{} {
+	if value == nil || value == "" {
+		return defaultValue
+	}
+	return value
+}