sandbox: add all sandbox information to Create method

abel-von · f00589305 · commit d2d434b7d654 · 2023-10-16T21:17:50.000+08:00
When call sandbox controller to create sandbox, we change the param from
sandbox id to total sandbox object to git all information to controller,
so that sandbox controller do not rely on the sandbox store anymore,
this is more decouple for the sandbox controller plugin inside
containerd, and it is neccesary for remote sandbox controller plugins as
it is not able to get sandbox from the sandbox store anymore.

Signed-off-by: Abel Feng &lt;fshb1988@gmail.com&gt;
diff --git a/api/next.pb.txt b/api/next.pb.txt
@@ -5528,6 +5528,13 @@ file {
       type: TYPE_STRING
       json_name: "sandboxId"
     }
+    field {
+      name: "sandboxer"
+      number: 10
+      label: LABEL_OPTIONAL
+      type: TYPE_STRING
+      json_name: "sandboxer"
+    }
   }
   message_type {
     name: "ControllerMetricsResponse"
diff --git a/api/services/sandbox/v1/sandbox.pb.go b/api/services/sandbox/v1/sandbox.pb.go
diff --git a/api/services/sandbox/v1/sandbox.proto b/api/services/sandbox/v1/sandbox.proto
@@ -174,6 +174,7 @@ message ControllerShutdownResponse {}
 
 message ControllerMetricsRequest {
 	string sandbox_id = 1;
+	string sandboxer = 10;
 }
 
 message ControllerMetricsResponse {
diff --git a/pkg/cri/server/podsandbox/sandbox_run.go b/pkg/cri/server/podsandbox/sandbox_run.go
@@ -273,7 +273,7 @@ func (c *Controller) Start(ctx context.Context, id string) (cin sandbox.Controll
 	return
 }
 
-func (c *Controller) Create(ctx context.Context, _id string, _ ...sandbox.CreateOpt) error {
+func (c *Controller) Create(ctx context.Context, _info sandbox.Sandbox, _ ...sandbox.CreateOpt) error {
 	// Not used by pod-sandbox implementation as there is no need to split pause containers logic.
 	return nil
 }
diff --git a/pkg/cri/server/sandbox_run.go b/pkg/cri/server/sandbox_run.go
@@ -249,7 +249,7 @@ func (c *criService) RunPodSandbox(ctx context.Context, r *runtime.RunPodSandbox
 		return nil, fmt.Errorf("unable to update extensions for sandbox %q: %w", id, err)
 	}
 
-	if err := controller.Create(ctx, id, sb.WithOptions(config), sb.WithNetNSPath(sandbox.NetNSPath)); err != nil {
+	if err := controller.Create(ctx, sandboxInfo, sb.WithOptions(config), sb.WithNetNSPath(sandbox.NetNSPath)); err != nil {
 		return nil, fmt.Errorf("failed to create sandbox %q: %w", id, err)
 	}
 
diff --git a/plugins/sandbox/controller.go b/plugins/sandbox/controller.go
@@ -59,20 +59,13 @@ func init() {
 				return nil, err
 			}
 
-			sbPlugin, err := ic.GetByID(plugins.SandboxStorePlugin, "local")
-			if err != nil {
-				return nil, err
-			}
-
 			var (
 				shims     = shimPlugin.(*v2.ShimManager)
 				publisher = exchangePlugin.(*exchange.Exchange)
-				store     = sbPlugin.(sandbox.Store)
 			)
 
 			return &controllerLocal{
 				shims:     shims,
-				store:     store,
 				publisher: publisher,
 			}, nil
 		},
@@ -81,7 +74,6 @@ func init() {
 
 type controllerLocal struct {
 	shims     *v2.ShimManager
-	store     sandbox.Store
 	publisher events.Publisher
 }
 
@@ -106,8 +98,9 @@ func (c *controllerLocal) cleanupShim(ctx context.Context, sandboxID string, svc
 	}
 }
 
-func (c *controllerLocal) Create(ctx context.Context, sandboxID string, opts ...sandbox.CreateOpt) error {
+func (c *controllerLocal) Create(ctx context.Context, info sandbox.Sandbox, opts ...sandbox.CreateOpt) error {
 	var coptions sandbox.CreateOptions
+	sandboxID := info.ID
 	for _, opt := range opts {
 		opt(&coptions)
 	}
@@ -116,11 +109,6 @@ func (c *controllerLocal) Create(ctx context.Context, sandboxID string, opts ...
 		return fmt.Errorf("sandbox %s already running: %w", sandboxID, errdefs.ErrAlreadyExists)
 	}
 
-	info, err := c.store.Get(ctx, sandboxID)
-	if err != nil {
-		return fmt.Errorf("failed to query sandbox metadata from store: %w", err)
-	}
-
 	shim, err := c.shims.Start(ctx, sandboxID, runtime.CreateOpts{
 		Spec:           info.Spec,
 		RuntimeOptions: info.Runtime.Options,
diff --git a/sandbox/controller.go b/sandbox/controller.go
@@ -94,7 +94,7 @@ func WithTimeout(timeout time.Duration) StopOpt {
 // Shim lifetimes are now managed manually via sandbox API by the containerd's client.
 type Controller interface {
 	// Create is used to initialize sandbox environment. (mounts, any)
-	Create(ctx context.Context, sandboxID string, opts ...CreateOpt) error
+	Create(ctx context.Context, sandboxInfo Sandbox, opts ...CreateOpt) error
 	// Start will start previously created sandbox.
 	Start(ctx context.Context, sandboxID string) (ControllerInstance, error)
 	// Platform returns target sandbox OS that will be used by Controller.
diff --git a/sandbox/proxy/controller.go b/sandbox/proxy/controller.go
@@ -40,13 +40,13 @@ func NewSandboxController(client api.ControllerClient) sandbox.Controller {
 	return &remoteSandboxController{client: client}
 }
 
-func (s *remoteSandboxController) Create(ctx context.Context, sandboxID string, opts ...sandbox.CreateOpt) error {
+func (s *remoteSandboxController) Create(ctx context.Context, sandboxInfo sandbox.Sandbox, opts ...sandbox.CreateOpt) error {
 	var options sandbox.CreateOptions
 	for _, opt := range opts {
 		opt(&options)
 	}
 	_, err := s.client.Create(ctx, &api.ControllerCreateRequest{
-		SandboxID: sandboxID,
+		SandboxID: sandboxInfo.ID,
 		Rootfs:    mount.ToProto(options.Rootfs),
 		Options: &anypb.Any{
 			TypeUrl: options.Options.GetTypeUrl(),
diff --git a/services/sandbox/controller_service.go b/services/sandbox/controller_service.go
@@ -103,7 +103,7 @@ func (s *controllerService) Create(ctx context.Context, req *api.ControllerCreat
 	if err != nil {
 		return nil, errdefs.ToGRPC(err)
 	}
-	err = ctrl.Create(ctx, req.GetSandboxID(), sandbox.WithOptions(req.GetOptions()))
+	err = ctrl.Create(ctx, sandbox.Sandbox{ID: req.GetSandboxID()}, sandbox.WithOptions(req.GetOptions()))
 	if err != nil {
 		return &api.ControllerCreateResponse{}, errdefs.ToGRPC(err)
 	}
@@ -217,8 +217,11 @@ func (s *controllerService) Shutdown(ctx context.Context, req *api.ControllerShu
 
 func (s *controllerService) Metrics(ctx context.Context, req *api.ControllerMetricsRequest) (*api.ControllerMetricsResponse, error) {
 	log.G(ctx).WithField("req", req).Debug("sandbox metrics")
-
-	metrics, err := s.local.Metrics(ctx, req.GetSandboxID())
+	ctrl, err := s.getController(req.Sandboxer)
+	if err != nil {
+		return nil, errdefs.ToGRPC(err)
+	}
+	metrics, err := ctrl.Metrics(ctx, req.GetSandboxID())
 	if err != nil {
 		return &api.ControllerMetricsResponse{}, errdefs.ToGRPC(err)
 	}

Original file line number	Diff line number	Diff line change
`@@ -5528,6 +5528,13 @@ file {`
`5528`	`5528`	`type: TYPE_STRING`
`5529`	`5529`	`json_name: "sandboxId"`
`5530`	`5530`	`}`
	`5531`	`+ field {`
	`5532`	`+ name: "sandboxer"`
	`5533`	`+ number: 10`
	`5534`	`+ label: LABEL_OPTIONAL`
	`5535`	`+ type: TYPE_STRING`
	`5536`	`+ json_name: "sandboxer"`
	`5537`	`+ }`
`5531`	`5538`	`}`
`5532`	`5539`	`message_type {`
`5533`	`5540`	`name: "ControllerMetricsResponse"`
Original file line number	Diff line number	Diff line change
`@@ -174,6 +174,7 @@ message ControllerShutdownResponse {}`
`174`	`174`
`175`	`175`	`message ControllerMetricsRequest {`
`176`	`176`	`string sandbox_id = 1;`
	`177`	`+ string sandboxer = 10;`
`177`	`178`	`}`
`178`	`179`
`179`	`180`	`message ControllerMetricsResponse {`
Original file line number	Diff line number	Diff line change
`@@ -273,7 +273,7 @@ func (c *Controller) Start(ctx context.Context, id string) (cin sandbox.Controll`
`273`	`273`	`return`
`274`	`274`	`}`
`275`	`275`
`276`		`-func (c *Controller) Create(ctx context.Context, _id string, _ ...sandbox.CreateOpt) error {`
	`276`	`+func (c *Controller) Create(ctx context.Context, _info sandbox.Sandbox, _ ...sandbox.CreateOpt) error {`
`277`	`277`	`// Not used by pod-sandbox implementation as there is no need to split pause containers logic.`
`278`	`278`	`return nil`
`279`	`279`	`}`
Original file line number	Diff line number	Diff line change
`@@ -249,7 +249,7 @@ func (c criService) RunPodSandbox(ctx context.Context, r runtime.RunPodSandbox`
`249`	`249`	`return nil, fmt.Errorf("unable to update extensions for sandbox %q: %w", id, err)`
`250`	`250`	`}`
`251`	`251`
`252`		`- if err := controller.Create(ctx, id, sb.WithOptions(config), sb.WithNetNSPath(sandbox.NetNSPath)); err != nil {`
	`252`	`+ if err := controller.Create(ctx, sandboxInfo, sb.WithOptions(config), sb.WithNetNSPath(sandbox.NetNSPath)); err != nil {`
`253`	`253`	`return nil, fmt.Errorf("failed to create sandbox %q: %w", id, err)`
`254`	`254`	`}`
`255`	`255`