feat(tidbcloud): add endpoint to tag tidbx images in TCMS (#388)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: wuhuizuo

.gitignore

@@ -20,3 +20,5 @@
 # go work files
 go.work
 go.work.sum
+
+.config

publisher/cmd/publisher/main.go

@@ -57,7 +57,7 @@ func main() {
 		logLevel = zerolog.DebugLevel
 	}
 	zerolog.SetGlobalLevel(logLevel)
-	logger := zerolog.New(os.Stderr).With().Timestamp().Str("service", tiup.ServiceName).Logger()
+	loggerCtx := zerolog.New(os.Stderr).With().Timestamp()
 
 	// Load and parse configuration
 	cfg, err := config.Load[config.Service](*configFile)
@@ -66,10 +66,14 @@ func main() {
 	}
 
 	// Initialize the services.
-	tiupSvc := impltiup.NewService(&logger, *cfg)
-	fsSvc := implfs.NewService(&logger, *cfg)
-	imgSvc := implimg.NewService(&logger, *cfg)
-	tidbcloudSvc := impltidbcloud.NewService(&logger, *cfg)
+	tiupLogger := loggerCtx.Str("service", "tiup").Logger()
+	tiupSvc := impltiup.NewService(&tiupLogger, *cfg)
+	fsLogger := loggerCtx.Str("service", "fileserver").Logger()
+	fsSvc := implfs.NewService(&fsLogger, *cfg)
+	imgLogger := loggerCtx.Str("service", "image").Logger()
+	imgSvc := implimg.NewService(&imgLogger, *cfg)
+	tidbcloudLogger := loggerCtx.Str("service", "tidbcloud").Logger()
+	tidbcloudSvc := impltidbcloud.NewService(&tidbcloudLogger, *cfg)
 
 	// Wrap the services in endpoints that can be invoked from other services
 	// potentially running in different processes.

publisher/configs/service-example.yaml

@@ -19,3 +19,4 @@ services:
 
   tidbcloud:
     # ops_config_file: "tidbcloud-ops-config.yaml" # should load from config map
+    # testplatforms_config_file: "testplatforms-config.yaml"

publisher/configs/testplatforms-config-example.yaml

@@ -0,0 +1,9 @@
+tcms:
+  api_base_url: "https://tcms.example.com/api"
+  auth_token: "tcms_token"
+
+# Optional credentials for private image access.
+image_auth:
+  username: "registry_user"
+  password: "registry_password"
+  use_default_keychain: false

publisher/internal/service/design/design.go

@@ -353,7 +353,7 @@ var _ = Service("tidbcloud", func() {
 				Example("prod")
 			})
 			Attribute("image", String, "container image with tag", func() {
-                                Example("xxx.com/component:v8.5.4")
+				Example("xxx.com/component:v8.5.4")
 			})
 
 			Required("stage", "image")
@@ -368,4 +368,50 @@ var _ = Service("tidbcloud", func() {
 			Response(StatusOK)
 		})
 	})
+	Method("add-tidbx-image-tag-in-tcms", func() {
+		Payload(func() {
+			Attribute("image", String, "container image with tag", func() {
+				Example("xxx.com/component:v8.5.4")
+			})
+			Attribute("github", func() { // Should read config from the image when the attribute is not given.
+				Description("git informations")
+				Attribute("full_repo", String, "full github repo name", func() {
+					Example("pingcap/tidb")
+				})
+				Attribute("ref", String, "git ref", func() {
+					Example("refs/heads/master")
+				})
+				Attribute("commit_sha", String, "full commit SHA", func() {
+					MinLength(40)
+					MaxLength(40)
+					Example("031069dfc0c70e839d996c9e1cf3d34930fc662f")
+				})
+				Required("full_repo", "commit_sha")
+			})
+			Required("image")
+
+		})
+		Result(func() {
+			Attribute("repo", String, "github full repo", func() {
+				Meta("struct:tag:json", "repo,omitempty")
+				Example("pingcap/tidb")
+			})
+			Attribute("branch", String, "github branch or tag name", func() {
+				Meta("struct:tag:json", "branch,omitempty")
+				Example("release-nextgen-20251011")
+			})
+			Attribute("sha", String, "github commit sha in the repo", func() {
+				Meta("struct:tag:json", "sha,omitempty")
+				Example("031069dfc0c70e839d996c9e1cf3d34930fc662f")
+			})
+			Attribute("imageTag", String, "image tag", func() {
+				Meta("struct:tag:json", "imageTag,omitempty")
+				Example("release-nextgen-20251011-031069d")
+			})
+		})
+		HTTP(func() {
+			POST("/tidbx-component-image-builds")
+			Response(StatusOK)
+		})
+	})
 })