feature: add spec annotation flag

apis/swagger.yml

@@ -1751,6 +1751,11 @@ definitions:
         x-nullable: true
         additionalProperties:
           type: "string"
+      SpecAnnotation:
+        description: "annotations send to runtime spec."
+        type: "object"
+        additionalProperties:
+          type: "string"
 
   ContainerCreateResp:
     description: "response returned by daemon when container create successfully"

cli/common_flags.go

@@ -91,5 +91,8 @@ func addCommonFlags(flagSet *pflag.FlagSet) *container {
 	// disk quota
 	flagSet.StringSliceVar(&c.diskQuota, "disk-quota", nil, "Set disk quota for container")
 
+	// additional runtime spec annotations
+	flagSet.StringSliceVar(&c.specAnnotation, "annotation", nil, "Additional annotation for runtime")
+
 	return c
 }

cli/container.go

@@ -63,6 +63,7 @@ type container struct {
 	IntelRdtL3Cbm        string
 	diskQuota            []string
 	oomScoreAdj          int64
+	specAnnotation       []string
 
 	cgroupParent string
 
@@ -121,6 +122,11 @@ func (c *container) config() (*types.ContainerCreateConfig, error) {
 		return nil, err
 	}
 
+	specAnnotation, err := validateAnnotation(c.specAnnotation)
+	if err != nil {
+		return nil, err
+	}
+
 	var networkMode string
 	if len(c.networks) == 0 {
 		networkMode = "bridge"
@@ -194,18 +200,19 @@ func (c *container) config() (*types.ContainerCreateConfig, error) {
 	}
 	config := &types.ContainerCreateConfig{
 		ContainerConfig: types.ContainerConfig{
-			Tty:          c.tty,
-			Env:          c.env,
-			Entrypoint:   strings.Fields(c.entrypoint),
-			WorkingDir:   c.workdir,
-			User:         c.user,
-			Hostname:     strfmt.Hostname(c.hostname),
-			Labels:       labels,
-			Rich:         c.rich,
-			RichMode:     c.richMode,
-			InitScript:   c.initScript,
-			ExposedPorts: ports,
-			DiskQuota:    diskQuota,
+			Tty:            c.tty,
+			Env:            c.env,
+			Entrypoint:     strings.Fields(c.entrypoint),
+			WorkingDir:     c.workdir,
+			User:           c.user,
+			Hostname:       strfmt.Hostname(c.hostname),
+			Labels:         labels,
+			Rich:           c.rich,
+			RichMode:       c.richMode,
+			InitScript:     c.initScript,
+			ExposedPorts:   ports,
+			DiskQuota:      diskQuota,
+			SpecAnnotation: specAnnotation,
 		},
 
 		HostConfig: &types.HostConfig{
@@ -461,3 +468,19 @@ func validateOOMScore(score int64) error {
 
 	return nil
 }
+
+// validateAnnotation validates runtime annotations format.
+func validateAnnotation(annotations []string) (map[string]string, error) {
+	specAnnotation := make(map[string]string)
+
+	for _, annotation := range annotations {
+		splits := strings.Split(annotation, "=")
+		if len(splits) != 2 || splits[0] == "" || splits[1] == "" {
+			return nil, fmt.Errorf("invalid format for spec annotation: %s, correct format should be key=value, neither should be nil", annotation)
+		}
+
+		specAnnotation[splits[0]] = splits[1]
+	}
+
+	return specAnnotation, nil
+}

daemon/mgr/spec_annotations.go

@@ -3,6 +3,8 @@ package mgr
 import (
 	"context"
 	"strconv"
+
+	"github.com/sirupsen/logrus"
 )
 
 // setupAnnotations extracts other related options from HostConfig and locate them in spec's annotations which will be dealt by vendored runc.
@@ -25,5 +27,15 @@ func setupAnnotations(ctx context.Context, meta *ContainerMeta, spec *SpecWrappe
 
 	s.Annotations["__schedule_latency_switch"] = strconv.FormatInt(r.ScheLatSwitch, 10)
 
+	// add additional spec annotations
+	annotations := meta.Config.SpecAnnotation
+	for k, v := range annotations {
+		if _, exist := s.Annotations[k]; exist {
+			logrus.Warnf("Duplicate spec annotation: %s=%s", k, v)
+			continue
+		}
+		s.Annotations[k] = v
+	}
+
 	return nil
 }

test/cli_create_test.go

@@ -2,12 +2,14 @@ package main
 
 import (
 	"encoding/json"
+	"fmt"
 	"runtime"
 	"strings"
 
 	"github.com/alibaba/pouch/apis/types"
 	"github.com/alibaba/pouch/test/command"
 	"github.com/alibaba/pouch/test/environment"
+	"github.com/alibaba/pouch/test/util"
 
 	"github.com/go-check/check"
 	"github.com/gotestyourself/gotestyourself/icmd"
@@ -410,3 +412,25 @@ func (suite *PouchCreateSuite) TestCreateWithOOMOption(c *check.C) {
 	c.Assert(result.HostConfig.OomScoreAdj, check.Equals, int64(100))
 	c.Assert(*result.HostConfig.OomKillDisable, check.Equals, true)
 }
+
+// TestCreateWithAnnotation tests creating container with annotation.
+func (suite *PouchCreateSuite) TestCreateWithAnnotation(c *check.C) {
+	cname := "TestCreateWithAnnotation"
+	command.PouchRun("create", "--annotation", "a=b", "--annotation", "foo=bar", "--name", cname, busyboxImage).Stdout()
+
+	output := command.PouchRun("inspect", cname).Stdout()
+	result := &types.ContainerJSON{}
+	if err := json.Unmarshal([]byte(output), result); err != nil {
+		c.Errorf("failed to decode inspect output: %v", err)
+	}
+
+	// kv in map not in order.
+	var annotationSlice []string
+	for k, v := range result.Config.SpecAnnotation {
+		annotationSlice = append(annotationSlice, fmt.Sprintf("%s=%s", k, v))
+	}
+	annotationStr := strings.Join(annotationSlice, " ")
+
+	c.Assert(util.PartialEqual(annotationStr, "a=b"), check.IsNil)
+	c.Assert(util.PartialEqual(annotationStr, "foo=bar"), check.IsNil)
+}

test/cli_run_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/alibaba/pouch/apis/types"
 	"github.com/alibaba/pouch/test/command"
 	"github.com/alibaba/pouch/test/environment"
+	"github.com/alibaba/pouch/test/util"
 
 	"github.com/go-check/check"
 	"github.com/gotestyourself/gotestyourself/icmd"
@@ -789,3 +790,25 @@ func (suite *PouchRunSuite) TestRunWithDiskQuota(c *check.C) {
 
 	c.Assert(found, check.Equals, true)
 }
+
+// TestRunWithAnnotation is to verify the valid running container with annotation, and verify SpecAnnotation filed has been in inspect output.
+func (suite *PouchRunSuite) TestRunWithAnnotation(c *check.C) {
+	cname := "TestRunWithAnnotation"
+	command.PouchRun("run", "-d", "--annotation", "a=b", "--annotation", "foo=bar", "--name", cname, busyboxImage).Stdout()
+
+	output := command.PouchRun("inspect", cname).Stdout()
+	result := &types.ContainerJSON{}
+	if err := json.Unmarshal([]byte(output), result); err != nil {
+		c.Errorf("failed to decode inspect output: %v", err)
+	}
+
+	// kv in map not in order.
+	var annotationSlice []string
+	for k, v := range result.Config.SpecAnnotation {
+		annotationSlice = append(annotationSlice, fmt.Sprintf("%s=%s", k, v))
+	}
+	annotationStr := strings.Join(annotationSlice, " ")
+
+	c.Assert(util.PartialEqual(annotationStr, "a=b"), check.IsNil)
+	c.Assert(util.PartialEqual(annotationStr, "foo=bar"), check.IsNil)
+}

test/cli_start_test.go

@@ -233,3 +233,14 @@ func (suite *PouchStartSuite) TestStartWithPrivilege(c *check.C) {
 
 	command.PouchRun("start", name).Assert(c, icmd.Success)
 }
+
+// TestStartWithAnnotation starts a container with annotation.
+func (suite *PouchStartSuite) TestStartWithAnnotation(c *check.C) {
+	name := "start-annotation"
+
+	res := command.PouchRun("create", "--name", name, "--annotation", "a=b", busyboxImage)
+	res.Assert(c, icmd.Success)
+	defer DelContainerForceMultyTime(c, name)
+
+	command.PouchRun("start", name).Assert(c, icmd.Success)
+}