add additionalPrinterColumns for devbox. (labring#5020)

* add additionalPrinterColumns for devbox. * add ResourceVersionChangedPredicate for devbox pod change status to reconcile devbox.
bearslyricattack · Aug 31, 2024 · 3d62549 · 3d62549
1 parent e3c9b62
commit 3d62549
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 11 deletions.
diff --git a/controllers/devbox/api/v1alpha1/devbox_types.go b/controllers/devbox/api/v1alpha1/devbox_types.go
@@ -121,6 +121,11 @@ type DevboxStatus struct {
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="State",type="string",JSONPath=".spec.state"
+// +kubebuilder:printcolumn:name="RuntimeRef",type="string",JSONPath=".spec.runtimeRef.name"
+// +kubebuilder:printcolumn:name="PodPhase",type="string",JSONPath=".status.podPhase"
+// +kubebuilder:printcolumn:name="NetworkType",type="string",JSONPath=".status.network.type"
+// +kubebuilder:printcolumn:name="NodePort",type="integer",JSONPath=".status.network.nodePort"
 
 // Devbox is the Schema for the devboxes API
 type Devbox struct {

diff --git a/controllers/devbox/config/crd/bases/devbox.sealos.io_devboxes.yaml b/controllers/devbox/config/crd/bases/devbox.sealos.io_devboxes.yaml
@@ -28,7 +28,23 @@ spec:
     singular: devbox
   scope: Namespaced
   versions:
-  - name: v1alpha1
+    - additionalPrinterColumns:
+        - jsonPath: .spec.state
+          name: State
+          type: string
+        - jsonPath: .spec.runtimeRef.name
+          name: RuntimeRef
+          type: string
+        - jsonPath: .status.podPhase
+          name: PodPhase
+          type: string
+        - jsonPath: .status.network.type
+          name: NetworkType
+          type: string
+        - jsonPath: .status.network.nodePort
+          name: NodePort
+          type: integer
+      name: v1alpha1
     schema:
       openAPIV3Schema:
         description: Devbox is the Schema for the devboxes API
@@ -131,7 +147,6 @@ spec:
             - state
             type: object
           status:
-            description: DevboxStatus defines the observed state of Devbox
             properties:
               commitHistory:
                 items:

diff --git a/controllers/devbox/config/rbac/role.yaml b/controllers/devbox/config/rbac/role.yaml
@@ -23,8 +23,7 @@ rules:
   resources:
     - events
   verbs:
-  - create
-  - patch
+    - '*'
 - apiGroups:
     - ""
   resources:

diff --git a/controllers/devbox/deploy/manifests/deploy.yaml.tmpl b/controllers/devbox/deploy/manifests/deploy.yaml.tmpl
@@ -1,3 +1,17 @@
+# Copyright © 2024 sealos.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 apiVersion: v1
 kind: Namespace
 metadata:
@@ -22,7 +36,23 @@ spec:
     singular: devbox
   scope: Namespaced
   versions:
-  - name: v1alpha1
+  - additionalPrinterColumns:
+    - jsonPath: .spec.state
+      name: State
+      type: string
+    - jsonPath: .spec.runtimeRef.name
+      name: RuntimeRef
+      type: string
+    - jsonPath: .status.podPhase
+      name: PodPhase
+      type: string
+    - jsonPath: .status.network.type
+      name: NetworkType
+      type: string
+    - jsonPath: .status.network.nodePort
+      name: NodePort
+      type: integer
+    name: v1alpha1
     schema:
       openAPIV3Schema:
         description: Devbox is the Schema for the devboxes API
@@ -576,11 +606,7 @@ rules:
   resources:
   - events
   verbs:
-  - create
-  - delete
-  - get
-  - list
-  - patch
+  - '*'
 - apiGroups:
   - ""
   resources:

diff --git a/controllers/devbox/internal/controller/devbox_controller.go b/controllers/devbox/internal/controller/devbox_controller.go
@@ -35,9 +35,12 @@ import (
 	"k8s.io/client-go/util/retry"
 	"k8s.io/utils/ptr"
 	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/builder"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
+	"sigs.k8s.io/controller-runtime/pkg/handler"
 	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 )
 
 const (
@@ -63,7 +66,7 @@ type DevboxReconciler struct {
 // +kubebuilder:rbac:groups="",resources=pods/status,verbs=get;update;patch
 // +kubebuilder:rbac:groups="",resources=services,verbs=*
 // +kubebuilder:rbac:groups="",resources=secrets,verbs=*
-// +kubebuilder:rbac:groups="",resources=events,verbs=create;patch
+// +kubebuilder:rbac:groups="",resources=events,verbs=*
 
 func (r *DevboxReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	logger := log.FromContext(ctx, "devbox", req.NamespacedName)
@@ -586,5 +589,10 @@ func (r *DevboxReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		For(&devboxv1alpha1.Devbox{}).
 		Owns(&corev1.Pod{}).
 		Owns(&corev1.Service{}).
+		Watches(
+			&corev1.Pod{},
+			handler.EnqueueRequestForOwner(mgr.GetScheme(), mgr.GetRESTMapper(), &devboxv1alpha1.Devbox{}),
+			builder.WithPredicates(predicate.ResourceVersionChangedPredicate{}),
+		).
 		Complete(r)
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,8 +23,7 @@ rules: @@
       resources:
         - events
       verbs:
-      - create
-      - patch
+        - '*'
     - apiGroups:
         - ""
       resources:
@@ Expand Down @@