Add field for ActorTemplate API

Author: minhngo248

charts/substrate-crds/templates/ate.dev_actortemplates.yaml

@@ -256,6 +256,13 @@ spec:
                 - message: All images must be pinned (changing the image invalidates
                     snapshots)
                   rule: self.contains('@')
+              requiredWorkerPoolName:
+                description: |-
+                  RequiredWorkerPoolName restricts actors from this template to one WorkerPool.
+                  When set, the scheduler only considers workers owned by that WorkerPool.
+                  If no worker in that pool is free, ResumeActor fails instead of falling
+                  back to another eligible pool.
+                type: string
               sandboxClass:
                 default: gvisor
                 description: |-

cmd/ateapi/internal/controlapi/create_actor.go

@@ -37,16 +37,19 @@ func (s *Service) CreateActor(ctx context.Context, req *ateapipb.CreateActorRequ
 	templateNamespace := in.GetActorTemplateNamespace()
 	templateName := in.GetActorTemplateName()
 
-	setSpanActorRefAttributes(ctx, in.GetMetadata().GetAtespace(), in.GetMetadata().GetName())
-
-	_, err := s.actorTemplateLister.ActorTemplates(templateNamespace).Get(templateName)
+	actorTemplate, err := s.actorTemplateLister.ActorTemplates(templateNamespace).Get(templateName)
 	if err != nil {
 		if k8serrors.IsNotFound(err) {
 			return nil, status.Errorf(codes.FailedPrecondition, "ActorTemplate %s/%s not found", templateNamespace, templateName)
 		}
 		return nil, fmt.Errorf("while getting ActorTemplate: %w", err)
 	}
 
+	requiredWorkerPoolName := in.GetRequiredWorkerPoolName()
+	if requiredWorkerPoolName == "" {
+		requiredWorkerPoolName = actorTemplate.Spec.RequiredWorkerPoolName
+	}
+
 	atespace := in.GetMetadata().GetAtespace()
 	name := in.GetMetadata().GetName()
 
@@ -68,7 +71,7 @@ func (s *Service) CreateActor(ctx context.Context, req *ateapipb.CreateActorRequ
 		ActorTemplateNamespace: templateNamespace,
 		ActorTemplateName:      templateName,
 		WorkerSelector:         in.GetWorkerSelector(),
-		RequiredWorkerPoolName: in.GetRequiredWorkerPoolName(),
+		RequiredWorkerPoolName: requiredWorkerPoolName,
 	}
 	stored, err := s.persistence.CreateActor(ctx, actor)
 	if err != nil {

cmd/ateapi/internal/controlapi/functional_test.go

@@ -1333,6 +1333,47 @@ func TestResumeActor_NoWorkers(t *testing.T) {
 	assertGrpcError(t, err, codes.FailedPrecondition, "no free workers available")
 }
 
+func TestCreateActor_DefaultsRequiredWorkerPoolFromTemplate(t *testing.T) {
+	ns := namespaceForTest("ns-template-required-pool")
+	tc := setupTest(t, ns)
+	defer tc.cleanup()
+
+	ensureDefaultGvisorSandboxConfig(t, tc)
+	createWorkerPool(t, tc, ns, "pool-a", map[string]string{"group": ns})
+
+	actorTemplate := &atev1alpha1.ActorTemplate{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "tmpl-required-pool",
+			Namespace: ns,
+		},
+		Spec: atev1alpha1.ActorTemplateSpec{
+			PauseImage: "pause@sha256:abc",
+			SnapshotsConfig: atev1alpha1.SnapshotsConfig{
+				Location: "gs://fake-fake-fake",
+			},
+			Containers: []atev1alpha1.Container{
+				{Name: "main", Image: "main@sha256:abc", Command: []string{"/main"}},
+			},
+			RequiredWorkerPoolName: "pool-a",
+		},
+	}
+	if _, err := tc.substrateClient.ApiV1alpha1().ActorTemplates(ns).Create(context.Background(), actorTemplate, metav1.CreateOptions{}); err != nil {
+		t.Fatalf("failed to create actor template: %v", err)
+	}
+
+	resp, err := tc.client.CreateActor(context.Background(), &ateapipb.CreateActorRequest{Actor: &ateapipb.Actor{
+		Metadata:               &ateapipb.ResourceMetadata{Atespace: testAtespace, Name: "id1"},
+		ActorTemplateNamespace: ns,
+		ActorTemplateName:      "tmpl-required-pool",
+	}})
+	if err != nil {
+		t.Fatalf("CreateActor failed: %v", err)
+	}
+	if got := resp.GetRequiredWorkerPoolName(); got != "pool-a" {
+		t.Fatalf("expected required_worker_pool_name to default from template, got %q", got)
+	}
+}
+
 func TestResumeActor_RequiredWorkerPoolDoesNotFallback(t *testing.T) {
 	ns := namespaceForTest("ns-required-pool-no-fallback")
 	tc := setupTest(t, ns)

manifests/ate-install/generated/ate.dev_actortemplates.yaml

@@ -257,6 +257,13 @@ spec:
                 - message: All images must be pinned (changing the image invalidates
                     snapshots)
                   rule: self.contains('@')
+              requiredWorkerPoolName:
+                description: |-
+                  RequiredWorkerPoolName restricts actors from this template to one WorkerPool.
+                  When set, the scheduler only considers workers owned by that WorkerPool.
+                  If no worker in that pool is free, ResumeActor fails instead of falling
+                  back to another eligible pool.
+                type: string
               sandboxClass:
                 default: gvisor
                 description: |-

pkg/api/v1alpha1/actortemplate_types.go

@@ -323,6 +323,14 @@ type ActorTemplateSpec struct {
 	// +kubebuilder:default=gvisor
 	SandboxClass SandboxClass `json:"sandboxClass,omitempty"`
 
+	// RequiredWorkerPoolName restricts actors from this template to one WorkerPool.
+	// When set, the scheduler only considers workers owned by that WorkerPool.
+	// If no worker in that pool is free, ResumeActor fails instead of falling
+	// back to another eligible pool.
+	//
+	// +optional
+	RequiredWorkerPoolName string `json:"requiredWorkerPoolName,omitempty"`
+
 	// WorkerSelector restricts which worker pools actors from this template may
 	// use. The scheduler only considers pools whose labels match this selector.
 	// If nil, all pools are eligible (subject to the actor's own worker_selector).