fix for issue # 119

Author: barney-s

api/v1alpha1/sandbox_types.go

@@ -119,8 +119,38 @@ type SandboxSpec struct {
 	Replicas *int32 `json:"replicas,omitempty"`
 }
 
+// SandboxPhase is a label for the condition of a sandbox at the current time.
+type SandboxPhase string
+
+// These are the valid phases of a sandbox.
+const (
+	// SandboxPhasePending means the sandbox has been accepted by the system, but one or more of the components
+	// has not been created. This includes time before pods have been scheduled as well as time spent
+	// pulling images over the network, which can take a while.
+	SandboxPhasePending SandboxPhase = "Pending"
+	// SandboxPhaseRunning means the sandbox has been bound to a node and all of the components have been started.
+	// At least one container is still running or is in the process of being restarted.
+	SandboxPhaseRunning SandboxPhase = "Running"
+	// SandboxPhasePaused means the sandbox has been paused.
+	SandboxPhasePaused SandboxPhase = "Paused"
+	// SandboxPhaseFailed means that all components in the sandbox have terminated, and at least one component has
+	// terminated in a failure (exited with a non-zero exit code or was stopped by the system).
+	SandboxPhaseFailed SandboxPhase = "Failed"
+	// SandboxPhaseUnknown means that for reasons outside the system's control, the state of the sandbox could not be obtained,
+	// typically due to an error in communicating with the host of the sandbox.
+	SandboxPhaseUnknown SandboxPhase = "Unknown"
+)
+
 // SandboxStatus defines the observed state of Sandbox.
 type SandboxStatus struct {
+	// The phase of a Sandbox is a simple, high-level summary of where the Sandbox is in its lifecycle.
+	// The conditions array, the reason and message fields, and the individual container status arrays contain
+	// more detail about the pod's status.
+	// If specified, must be one of the following values:
+	// Pending, Running, Paused, Failed, Unknown
+	// +optional
+	Phase SandboxPhase `json:"phase,omitempty"`
+
 	// FQDN that is valid for default cluster settings
 	// Limitation: Hardcoded to the domain .cluster.local
 	// e.g. sandbox-example.default.svc.cluster.local

controllers/sandbox_controller.go

@@ -107,6 +107,10 @@ func (r *SandboxReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 	if expired {
 		log.Info("Sandbox has expired, deleting pod and service")
 		err = r.handleSandboxExpiry(ctx, sandbox)
+	} else if *sandbox.Spec.Replicas == 0 {
+		log.Info("Sandbox is paused")
+		sandbox.Status.Phase = sandboxv1alpha1.SandboxPhasePaused
+		err = r.reconcileChildResources(ctx, sandbox)
 	} else {
 		err = r.reconcileChildResources(ctx, sandbox)
 	}
@@ -135,9 +139,11 @@ func (r *SandboxReconciler) reconcileChildResources(ctx context.Context, sandbox
 	pod, err := r.reconcilePod(ctx, sandbox, nameHash)
 	allErrors = errors.Join(allErrors, err)
 	if pod == nil {
+		sandbox.Status.Phase = sandboxv1alpha1.SandboxPhasePending
 		sandbox.Status.Replicas = 0
 		sandbox.Status.LabelSelector = ""
 	} else {
+		sandbox.Status.Phase = sandboxv1alpha1.SandboxPhase(pod.Status.Phase)
 		sandbox.Status.Replicas = 1
 		sandbox.Status.LabelSelector = fmt.Sprintf("%s=%s", sandboxLabel, NameHash(sandbox.Name))
 	}
@@ -431,6 +437,7 @@ func (r *SandboxReconciler) handleSandboxExpiry(ctx context.Context, sandbox *sa
 		Message:            "Sandbox has expired",
 	})
 
+	sandbox.Status.Phase = sandboxv1alpha1.SandboxPhaseFailed
 	sandbox.Status.Replicas = 0
 	sandbox.Status.LabelSelector = ""
 

controllers/sandbox_controller_test.go

@@ -227,6 +227,7 @@ func TestReconcile(t *testing.T) {
 			},
 			// Verify Sandbox status
 			wantStatus: sandboxv1alpha1.SandboxStatus{
+				Phase:         sandboxv1alpha1.SandboxPhasePending,
 				Service:       sandboxName,
 				ServiceFQDN:   "sandbox-name.sandbox-ns.svc.cluster.local",
 				Replicas:      1,
@@ -237,7 +238,7 @@ func TestReconcile(t *testing.T) {
 						Status:             "False",
 						ObservedGeneration: 1,
 						Reason:             "DependenciesNotReady",
-						Message:            "Pod exists with phase: ; Service Exists",
+						Message:            "Pod does not exist; Service Exists",
 					},
 				},
 			},
@@ -320,6 +321,7 @@ func TestReconcile(t *testing.T) {
 			},
 			// Verify Sandbox status
 			wantStatus: sandboxv1alpha1.SandboxStatus{
+				Phase:         sandboxv1alpha1.SandboxPhasePending,
 				Service:       sandboxName,
 				ServiceFQDN:   "sandbox-name.sandbox-ns.svc.cluster.local",
 				Replicas:      1,
@@ -330,7 +332,7 @@ func TestReconcile(t *testing.T) {
 						Status:             "False",
 						ObservedGeneration: 1,
 						Reason:             "DependenciesNotReady",
-						Message:            "Pod exists with phase: ; Service Exists",
+						Message:            "Pod does not exist; Service Exists",
 					},
 				},
 			},
@@ -406,6 +408,58 @@ func TestReconcile(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "sandbox is paused",
+			// Input sandbox spec
+			sandboxSpec: sandboxv1alpha1.SandboxSpec{
+				Replicas: ptr.To(int32(0)),
+				PodTemplate: sandboxv1alpha1.PodTemplate{
+					Spec: corev1.PodSpec{
+						Containers: []corev1.Container{
+							{
+								Name: "test-container",
+							},
+						},
+					},
+				},
+			},
+			// Verify Sandbox status
+			wantStatus: sandboxv1alpha1.SandboxStatus{
+				Phase:       sandboxv1alpha1.SandboxPhasePaused,
+				Service:     sandboxName,
+				ServiceFQDN: "sandbox-name.sandbox-ns.svc.cluster.local",
+				Replicas:    0,
+				Conditions: []metav1.Condition{
+					{
+						Type:               "Ready",
+						Status:             "True",
+						ObservedGeneration: 1,
+						Reason:             "DependenciesReady",
+						Message:            "Pod does not exist, replicas is 0; Service Exists",
+					},
+				},
+			},
+			wantObjs: []client.Object{
+				// Verify Service
+				&corev1.Service{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:            sandboxName,
+						Namespace:       sandboxNs,
+						ResourceVersion: "1",
+						Labels: map[string]string{
+							"agents.x-k8s.io/sandbox-name-hash": "ab179450",
+						},
+						OwnerReferences: []metav1.OwnerReference{sandboxControllerRef(sandboxName)},
+					},
+					Spec: corev1.ServiceSpec{
+						Selector: map[string]string{
+							"agents.x-k8s.io/sandbox-name-hash": "ab179450",
+						},
+						ClusterIP: "None",
+					},
+				},
+			},
+		},
 	}
 
 	for _, tc := range testCases {