update using sandbox spec runtimeconfig instend of annotation flag

Signed-off-by: jicheng.sk <jicheng.sk@alibaba-inc.com>

Author: BH4AWS

api/v1alpha1/sandbox_types.go

@@ -36,17 +36,18 @@ const (
 	// Sandbox Manager or Sandbox Claim creates high-priority sandboxes by default.
 	SandboxAnnotationPriority = "agents.kruise.io/sandbox-priority"
 
-	// ShouldInjectCsiMount is the annotation key for inject csi mount plugin container.
-	// If set, the csi sidecar will be injected into the pod when the sandbox is created.
-	// The csi mount sidecar is used to mount the remote oss/nas storage to the sandbox container.
-	ShouldInjectCsiMount = "agents.kruise.io/inject-csi-plugin"
-
-	// ShouldInjectAgentRuntime is the annotation key for inject agent runtime sidecar in init container.
-	// If set, the agent runtime sidecar will be injected into the pod when the sandbox is created.
-	// Some binary tools which are contained in the init agent runtime container. These are the basic tools for sandbox running.
-	ShouldInjectAgentRuntime = "agents.kruise.io/inject-agent-runtime"
+	// RuntimeConfigForInjectCsiMount is a valid value for RuntimeConfig.Name.
+	// When set, enables CSI mount sidecar injection for the sandbox.
+	RuntimeConfigForInjectCsiMount = "csi"
+	// RuntimeConfigForInjectAgentRuntime is a valid value for RuntimeConfig.Name.
+	// When set, enables agent runtime sidecar injection for the sandbox.
+	RuntimeConfigForInjectAgentRuntime = "agent-runtime"
 )
 
+type RuntimeConfig struct {
+	Name string `json:"name"`
+}
+
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 
@@ -69,6 +70,10 @@ type SandboxSpec struct {
 	// +kubebuilder:validation:Format="date-time"
 	ShutdownTime *metav1.Time `json:"shutdownTime,omitempty"`
 
+	// Runtimes - Runtime configuration for sandbox object
+	// +optional
+	Runtimes []RuntimeConfig `json:"runtimes,omitempty"`
+
 	// PauseTime - Absolute time when the sandbox will be paused automatically.
 	// +kubebuilder:validation:Format="date-time"
 	PauseTime *metav1.Time `json:"pauseTime,omitempty"`

api/v1alpha1/sandboxclaim_types.go

@@ -78,6 +78,10 @@ type SandboxClaimSpec struct {
 	// +optional
 	DynamicVolumesMount []CSIMountConfig `json:"dynamicVolumesMount"`
 
+	// Runtimes - Runtime configuration for sandbox object
+	// +optional
+	Runtimes []RuntimeConfig `json:"runtimes,omitempty"`
+
 	// Set ReserveFailedSandbox to true to reserve failed sandboxes
 	// +optional
 	ReserveFailedSandbox bool `json:"reserveFailedSandbox,omitempty"`

api/v1alpha1/sandboxset_types.go

@@ -60,6 +60,10 @@ type SandboxSetSpec struct {
 	// PersistentContents indicates resume pod with persistent content, Enum: ip, memory, filesystem
 	PersistentContents []string `json:"persistentContents,omitempty"`
 
+	// Runtimes - Runtime configuration for sandbox object
+	// +optional
+	Runtimes []RuntimeConfig `json:"runtimes,omitempty"`
+
 	EmbeddedSandboxTemplate `json:",inline"`
 
 	// ScaleStrategy indicates the ScaleStrategy that will be employed to

api/v1alpha1/sandboxtemplate_types.go

@@ -38,6 +38,10 @@ type SandboxTemplateSpec struct {
 
 	// PersistentContents indicates resume pod with persistent content, Enum: ip, memory, filesystem
 	PersistentContents []string `json:"persistentContents,omitempty"`
+
+	// Runtimes - Runtime configuration for sandbox object
+	// +optional
+	Runtimes []RuntimeConfig `json:"runtimes,omitempty"`
 }
 
 // +genclient

api/v1alpha1/zz_generated.deepcopy.go

@@ -136,6 +136,16 @@ spec:
               reserveFailedSandbox:
                 description: Set ReserveFailedSandbox to true to reserve failed sandboxes
                 type: boolean
+              runtimes:
+                description: Runtimes - Runtime configuration for sandbox object
+                items:
+                  properties:
+                    name:
+                      type: string
+                  required:
+                  - name
+                  type: object
+                type: array
               shutdownTime:
                 description: |-
                   ShutdownTime specifies the absolute time when the sandbox should be shut down

config/crd/bases/agents.kruise.io_sandboxclaims.yaml

@@ -71,6 +71,16 @@ spec:
                 items:
                   type: string
                 type: array
+              runtimes:
+                description: Runtimes - Runtime configuration for sandbox object
+                items:
+                  properties:
+                    name:
+                      type: string
+                  required:
+                  - name
+                  type: object
+                type: array
               shutdownTime:
                 description: |-
                   ShutdownTime - Absolute time when the sandbox is deleted.

config/crd/bases/agents.kruise.io_sandboxes.yaml

@@ -66,6 +66,16 @@ spec:
                   available and creating ones.
                 format: int32
                 type: integer
+              runtimes:
+                description: Runtimes - Runtime configuration for sandbox object
+                items:
+                  properties:
+                    name:
+                      type: string
+                  required:
+                  - name
+                  type: object
+                type: array
               scaleStrategy:
                 description: |-
                   ScaleStrategy indicates the ScaleStrategy that will be employed to

config/crd/bases/agents.kruise.io_sandboxsets.yaml

@@ -1305,11 +1305,13 @@ func TestCommonControl_createPod_WithSidecarInjection(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					Name:      "test-sandbox",
 					Namespace: "default",
-					Annotations: map[string]string{
-						agentsv1alpha1.ShouldInjectAgentRuntime: "true",
-					},
 				},
 				Spec: agentsv1alpha1.SandboxSpec{
+					Runtimes: []agentsv1alpha1.RuntimeConfig{
+						{
+							Name: agentsv1alpha1.RuntimeConfigForInjectAgentRuntime,
+						},
+					},
 					EmbeddedSandboxTemplate: agentsv1alpha1.EmbeddedSandboxTemplate{
 						Template: &corev1.PodTemplateSpec{
 							Spec: corev1.PodSpec{
@@ -1359,11 +1361,13 @@ func TestCommonControl_createPod_WithSidecarInjection(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					Name:      "test-sandbox",
 					Namespace: "default",
-					Annotations: map[string]string{
-						agentsv1alpha1.ShouldInjectCsiMount: "true",
-					},
 				},
 				Spec: agentsv1alpha1.SandboxSpec{
+					Runtimes: []agentsv1alpha1.RuntimeConfig{
+						{
+							Name: agentsv1alpha1.RuntimeConfigForInjectCsiMount,
+						},
+					},
 					EmbeddedSandboxTemplate: agentsv1alpha1.EmbeddedSandboxTemplate{
 						Template: &corev1.PodTemplateSpec{
 							Spec: corev1.PodSpec{
@@ -1416,12 +1420,16 @@ func TestCommonControl_createPod_WithSidecarInjection(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					Name:      "test-sandbox",
 					Namespace: "default",
-					Annotations: map[string]string{
-						agentsv1alpha1.ShouldInjectAgentRuntime: "true",
-						agentsv1alpha1.ShouldInjectCsiMount:     "true",
-					},
 				},
 				Spec: agentsv1alpha1.SandboxSpec{
+					Runtimes: []agentsv1alpha1.RuntimeConfig{
+						{
+							Name: agentsv1alpha1.RuntimeConfigForInjectAgentRuntime,
+						},
+						{
+							Name: agentsv1alpha1.RuntimeConfigForInjectCsiMount,
+						},
+					},
 					EmbeddedSandboxTemplate: agentsv1alpha1.EmbeddedSandboxTemplate{
 						Template: &corev1.PodTemplateSpec{
 							Spec: corev1.PodSpec{

pkg/controller/sandbox/core/common_control_test.go

@@ -319,6 +319,10 @@ func (c *commonControl) buildClaimOptions(ctx context.Context, claim *agentsv1al
 		}
 	}
 
+	if len(claim.Spec.Runtimes) > 0 {
+		opts.RuntimeConfig = claim.Spec.Runtimes
+	}
+
 	// Validate and initialize
 	return sandboxcr.ValidateAndInitClaimOptions(opts)
 }