Add annotations to task update request api

Signed-off-by: Kathryn Baldauf <[email protected]>

Author: katiewasnothere

api/next.pb.txt

@@ -4217,6 +4217,34 @@ file {
       type_name: ".google.protobuf.Any"
       json_name: "resources"
     }
+    field {
+      name: "annotations"
+      number: 3
+      label: LABEL_REPEATED
+      type: TYPE_MESSAGE
+      type_name: ".containerd.services.tasks.v1.UpdateTaskRequest.AnnotationsEntry"
+      json_name: "annotations"
+    }
+    nested_type {
+      name: "AnnotationsEntry"
+      field {
+        name: "key"
+        number: 1
+        label: LABEL_OPTIONAL
+        type: TYPE_STRING
+        json_name: "key"
+      }
+      field {
+        name: "value"
+        number: 2
+        label: LABEL_OPTIONAL
+        type: TYPE_STRING
+        json_name: "value"
+      }
+      options {
+        map_entry: true
+      }
+    }
   }
   message_type {
     name: "MetricsRequest"

api/services/tasks/v1/tasks.pb.go

@@ -188,6 +188,7 @@ message CheckpointTaskResponse {
 message UpdateTaskRequest {
 	string container_id = 1;
 	google.protobuf.Any resources = 2;
+	map<string, string> annotations = 3;
 }
 
 message MetricsRequest {

api/services/tasks/v1/tasks.proto

@@ -70,7 +70,7 @@ type Task interface {
 	// Checkpoint checkpoints a container to an image with live system data
 	Checkpoint(context.Context, string, *types.Any) error
 	// Update sets the provided resources to a running task
-	Update(context.Context, *types.Any) error
+	Update(context.Context, *types.Any, map[string]string) error
 	// Process returns a process within the task for the provided id
 	Process(context.Context, string) (Process, error)
 	// Stats returns runtime specific metrics for a task

runtime/task.go

@@ -306,7 +306,7 @@ func (t *Task) Checkpoint(ctx context.Context, path string, options *types.Any)
 }
 
 // Update changes runtime information of a running task
-func (t *Task) Update(ctx context.Context, resources *types.Any) error {
+func (t *Task) Update(ctx context.Context, resources *types.Any, _ map[string]string) error {
 	if _, err := t.shim.Update(ctx, &shim.UpdateTaskRequest{
 		Resources: resources,
 	}); err != nil {

runtime/v1/linux/task.go

@@ -420,10 +420,11 @@ func (s *shim) Checkpoint(ctx context.Context, path string, options *ptypes.Any)
 	return nil
 }
 
-func (s *shim) Update(ctx context.Context, resources *ptypes.Any) error {
+func (s *shim) Update(ctx context.Context, resources *ptypes.Any, annotations map[string]string) error {
 	if _, err := s.task.Update(ctx, &task.UpdateTaskRequest{
-		ID:        s.ID(),
-		Resources: resources,
+		ID:          s.ID(),
+		Resources:   resources,
+		Annotations: annotations,
 	}); err != nil {
 		return errdefs.FromGRPC(err)
 	}

runtime/v2/shim.go

@@ -132,6 +132,7 @@ message CheckpointTaskRequest {
 message UpdateTaskRequest {
 	string id = 1;
 	google.protobuf.Any resources = 2;
+	map<string, string> annotations = 3;
 }
 
 message StartRequest {

runtime/v2/task/shim.pb.go

@@ -560,7 +560,7 @@ func (l *local) Update(ctx context.Context, r *api.UpdateTaskRequest, _ ...grpc.
 	if err != nil {
 		return nil, err
 	}
-	if err := t.Update(ctx, r.Resources); err != nil {
+	if err := t.Update(ctx, r.Resources, r.Annotations); err != nil {
 		return nil, errdefs.ToGRPC(err)
 	}
 	return empty, nil

runtime/v2/task/shim.proto

@@ -503,6 +503,8 @@ func (t *task) Checkpoint(ctx context.Context, opts ...CheckpointTaskOpts) (Imag
 type UpdateTaskInfo struct {
 	// Resources updates a tasks resource constraints
 	Resources interface{}
+	// Annotations allows arbitrary and/or experimental resource constraints for task update
+	Annotations map[string]string
 }
 
 // UpdateTaskOpts allows a caller to update task settings
@@ -525,6 +527,9 @@ func (t *task) Update(ctx context.Context, opts ...UpdateTaskOpts) error {
 		}
 		request.Resources = any
 	}
+	if i.Annotations != nil {
+		request.Annotations = i.Annotations
+	}
 	_, err := t.client.TaskService().Update(ctx, request)
 	return errdefs.FromGRPC(err)
 }

services/tasks/local.go

@@ -209,3 +209,11 @@ func WithResources(resources interface{}) UpdateTaskOpts {
 		return nil
 	}
 }
+
+// WithAnnotations sets the provided annotations for task updates.
+func WithAnnotations(annotations map[string]string) UpdateTaskOpts {
+	return func(ctx context.Context, client *Client, r *UpdateTaskInfo) error {
+		r.Annotations = annotations
+		return nil
+	}
+}