BYOC: Support template build for team clusters #766

sitole · 2025-06-13T00:16:11Z

Implements abstraction for template managers in API to support edge clusters.

linear · 2025-06-13T00:16:13Z

E2B-2473 Make API template management compatible with clusters

packages/api/internal/template-manager/template_manager.go

Copilot

Pull Request Overview

This PR introduces support for building templates on remote clusters by abstracting build placement and integrating a cluster edge pool.

Added database migrations and queries to track clusters and build nodes.
Defined a BuildPlacement interface with local and clustered implementations.
Updated API handlers and cache to propagate cluster and node IDs.

Reviewed Changes

Copilot reviewed 65 out of 65 changed files in this pull request and generated 3 comments.

File	Description
packages/db/migrations/20250611172307_clusgter_node_for_builds.sql	Adds `cluster_node_id` column to track build node assignment
packages/api/internal/template-manager/placement_local.go	Implements local build placement and log fetching via Loki
packages/api/internal/template-manager/template_manager.go	Central `TemplateManager` wiring for placement, creation, deletion
packages/api/internal/template-manager/template_manager_test.go	Tests for polling status adjusted for new client fields

Comments suppressed due to low confidence (1)

packages/api/internal/template-manager/template_manager_test.go:118

The test initializer still uses statusClient, but PollBuildStatus no longer has that field. Update the test to construct with the new fields (placement, templateManagerClient, etc.).

c := &PollBuildStatus{

packages/db/migrations/20250611172307_clusgter_node_for_builds.sql

packages/api/internal/template-manager/placement_local.go

packages/api/internal/template-manager/template_manager.go

sitole · 2025-06-19T18:31:29Z

Need to implement migrations and schema changes removed from #795

… builder

dobrac

I would mainly unite the syncing logic, as it's there now twice, but doing basically the same thing

packages/db/migrations/20250624001048_cluster_for_templates.sql

packages/api/internal/template-manager/logs.go

packages/api/internal/template-manager/template_manager.go

packages/api/internal/edge/cluster.go

packages/api/internal/template-manager/template_manager.go

We have multiple places where we need to implement workflow that synchronizes items storage with some pool that do lot of different stuff. Basics such as adding newly discovered and removing not discovered items is used always so we abstracted this

dobrac · 2025-06-27T22:37:35Z

packages/api/internal/handlers/template_build_status.go

-				logs = append(logs, line["message"].(string))
-			}
-		}
+	l, err := a.templateManager.GetLogs(ctx, buildUUID, templateID, team.ClusterID, buildInfo.ClusterNodeId, params.LogsOffset)


Suggested change

l, err := a.templateManager.GetLogs(ctx, buildUUID, templateID, team.ClusterID, buildInfo.ClusterNodeId, params.LogsOffset)

l, err := a.templateManager.GetLogs(ctx, buildUUID, templateID, team.ClusterID, buildInfo.ClusterNodeID, params.LogsOffset)

dobrac · 2025-06-27T22:39:38Z

packages/api/internal/template-manager/logs.go

+)
+
+type PlacementLogsProvider interface {
+	GetLogs(ctx context.Context, buildId string, templateId string, offset *int32) ([]string, error)


Suggested change

GetLogs(ctx context.Context, buildId string, templateId string, offset *int32) ([]string, error)

GetLogs(ctx context.Context, templateID string, buildID string, offset *int32) ([]string, error)

dobrac · 2025-06-27T22:40:21Z

packages/api/internal/template-manager/template_manager.go

+	TemplateId string
+
+	ClusterId     *uuid.UUID
+	ClusterNodeId *string


Suggested change

TemplateId string

ClusterId *uuid.UUID

ClusterNodeId *string

TemplateID string

ClusterID *uuid.UUID

ClusterNodeID *string

dobrac · 2025-06-27T22:40:54Z

packages/api/internal/template-manager/template_manager.go

+
+		localClient:       client,
+		localClientMutex:  sync.RWMutex{},
+		localClientStatus: infogrpc.ServiceInfoStatus_OrchestratorHealthy,


is it always healthy when you add it?

dobrac · 2025-06-27T22:42:11Z

packages/api/internal/template-manager/template_manager.go

-	}
+func (tm *TemplateManager) getBuilderClient(clusterID *uuid.UUID, nodeID *string, placement bool) (*grpclient.GRPCClient, metadata.MD, PlacementLogsProvider, error) {
+	if clusterID == nil || nodeID == nil {
+		tm.localClientMutex.RLock()


maybe put the RUnlock to defer here?

dobrac · 2025-06-27T22:51:24Z

packages/api/internal/template-manager/template_manager_local.go

+			err = utils.UnwrapGRPCError(err)
+			if err != nil {
+				zap.L().Error("Failed to get health status of template manager", zap.Error(err))
+				tm.setLocalClientStatus(orchestratorinfo.ServiceInfoStatus_OrchestratorDraining)


draining or unhealthy?

dobrac · 2025-06-27T22:55:47Z

packages/shared/pkg/synchronization/synchronization_test.go

@@ -0,0 +1,123 @@
+package synchronization


nice ❤️

dobrac · 2025-06-27T23:00:17Z

packages/api/internal/edge/pool.go

+	return p, nil
+}
+
+func (p *Pool) syncBackground() {


it should be probably something like start, etc. The function doesn't (and shouldn't) know if it's gonna be run in the background or not

dobrac · 2025-06-27T23:00:36Z

packages/api/internal/edge/pool.go

+		Store:            poolSynchronizationStore{pool: p},
+	}
+
+	synchronize.SyncInBackground(p.close, poolSyncInterval, poolSyncTimeout, true)


same for this name, the SyncInBackground runs it actually in the foreground

dobrac · 2025-06-27T23:01:27Z

packages/shared/pkg/synchronization/synchronization.go

+	return nil
+}
+
+func (s *Synchronize[SourceItem, SourceKey, PoolItem]) SyncInBackground(cancel chan struct{}, syncInterval time.Duration, syncRoundTimeout time.Duration, runInitialSync bool) {


I don't like the cancel channel passing here. I would prefer separate method to close/stop the loop, so the cancel will be inner property of the Synchronize type

sitole self-assigned this Jun 13, 2025

sitole added the feature New feature label Jun 13, 2025

sitole commented Jun 13, 2025

View reviewed changes

packages/api/internal/template-manager/template_manager.go Outdated Show resolved Hide resolved

sitole changed the title ~~Template management compatible with edge clusters e2b 2473~~ BYOC: Template management abstraction for calling remote clusters Jun 13, 2025

sitole force-pushed the edge-service-core-impl branch from 345856a to e58cdf7 Compare June 13, 2025 17:39

sitole force-pushed the template-management-compatible-with-edge-clusters-e2b-2473 branch from d3c8031 to 36016c6 Compare June 13, 2025 18:13

sitole requested a review from Copilot June 13, 2025 19:09

Copilot AI reviewed Jun 13, 2025

View reviewed changes

packages/db/migrations/20250611172307_clusgter_node_for_builds.sql Outdated Show resolved Hide resolved

packages/api/internal/template-manager/placement_local.go Outdated Show resolved Hide resolved

packages/api/internal/template-manager/template_manager.go Outdated Show resolved Hide resolved

sitole force-pushed the template-management-compatible-with-edge-clusters-e2b-2473 branch 2 times, most recently from 3a0b224 to 1c8c32e Compare June 13, 2025 23:03

sitole force-pushed the edge-service-core-impl branch 2 times, most recently from 0051d27 to eba9e11 Compare June 16, 2025 22:37

sitole mentioned this pull request Jun 16, 2025

Bring Your Own Compute support #620

Closed

Base automatically changed from edge-service-core-impl to main June 17, 2025 17:25

sitole force-pushed the template-management-compatible-with-edge-clusters-e2b-2473 branch 3 times, most recently from 3e0648a to 3875fc4 Compare June 17, 2025 21:26

sitole changed the base branch from main to api-edge-clusters-support June 17, 2025 21:27

sitole force-pushed the api-edge-clusters-support branch from 1de1bfd to 1de2706 Compare June 17, 2025 21:47

sitole force-pushed the template-management-compatible-with-edge-clusters-e2b-2473 branch 2 times, most recently from 7db10cf to afc1b03 Compare June 17, 2025 22:00

sitole force-pushed the api-edge-clusters-support branch from 25f2f66 to f534515 Compare June 19, 2025 19:46

sitole force-pushed the template-management-compatible-with-edge-clusters-e2b-2473 branch 2 times, most recently from a908f7c to 1fb8a74 Compare June 19, 2025 21:15

sitole changed the title ~~BYOC: Template management abstraction for calling remote clusters~~ BYOC: Support template build for team clusters Jun 19, 2025

sitole changed the base branch from api-edge-clusters-support to main June 19, 2025 21:21

sitole force-pushed the template-management-compatible-with-edge-clusters-e2b-2473 branch 2 times, most recently from 7f1e73b to d963648 Compare June 21, 2025 00:01

sitole added 6 commits June 26, 2025 10:22

fixed wrong status check

896c007

tracer spans for cluster, cluster nodes sync and cluster get template…

2c3b758

… builder

added explonation for template build start cluser node to assign err

97045e6

make back local template manager status sync

3983845

user template manager host instead of address

01e75f5

unwrap grpc error before checking

09032a9

sitole force-pushed the template-management-compatible-with-edge-clusters-e2b-2473 branch from e95b23d to 09032a9 Compare June 26, 2025 17:25

dobrac requested changes Jun 26, 2025

View reviewed changes

sitole added 19 commits June 26, 2025 15:02

renaming, simplify state and roles locking with get/set methods

18e33c9

removed node sync during discovery

86c741f

fix return logs not as pointer

1a8bf2b

nits

224c677

template status sync returns err inestead of loging it directly

f289668

local template manager client creation separated

b2f07c3

shared constants for edge auth and node id headers

844cef5

fixed missing return for template build status sync method

15634c7

template manager nit

a80da4a

grpc client for cluster separated

c0490a3

replace ctx with chan for cluster cancel

a8cd9c0

pool and clusters shutdown with use of channel instead of ctx

ab61efc

lower pool sync timeout

e4e9c57

pool chan without size

e859685

shared util for data synchronization

90ff6ac

We have multiple places where we need to implement workflow that synchronizes items storage with some pool that do lot of different stuff. Basics such as adding newly discovered and removing not discovered items is used always so we abstracted this

clusters pool is now using shared synchronization util

97f5194

cluster nodes sync is now using synchronization util

5a2a2d3

logs prefixes for synchronization util

3249423

synchronization: test propager pool propagation

a2921d2

sitole requested a review from dobrac June 27, 2025 02:23

call pool synchronize when item already exists

204932b

dobrac requested changes Jun 27, 2025

View reviewed changes

	l, err := a.templateManager.GetLogs(ctx, buildUUID, templateID, team.ClusterID, buildInfo.ClusterNodeId, params.LogsOffset)
	l, err := a.templateManager.GetLogs(ctx, buildUUID, templateID, team.ClusterID, buildInfo.ClusterNodeID, params.LogsOffset)

	GetLogs(ctx context.Context, buildId string, templateId string, offset *int32) ([]string, error)
	GetLogs(ctx context.Context, templateID string, buildID string, offset *int32) ([]string, error)

BYOC: Support template build for team clusters #766

Are you sure you want to change the base?

BYOC: Support template build for team clusters #766

Uh oh!

Conversation

sitole commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linear bot commented Jun 13, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sitole commented Jun 19, 2025

Uh oh!

dobrac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sitole commented Jun 13, 2025 •

edited

Loading