chore(*): add comments

caicloud · Nov 17, 2020 · 9bade06 · 9bade06
1 parent 33f211f
commit 9bade06
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/pkg/workflow/common/const.go b/pkg/workflow/common/const.go
@@ -121,6 +121,8 @@ const (
 	// ResultFileDir contains the file `__result__` to hold execution result of a container that need to be synced to
 	// WorkflowRun status. Each line of the result should be in format: <key>:<value>
 	ResultFileDir = "/cyclone/results"
+	// ResultDirSubPath defines the subPath of ResultFileDir in coordinator sidecar volume
+	ResultDirSubPath = "__results__"
 
 	// OutputResourcesDir contains the output resources generated by workload container
 	OutputResourcesDir = "/cyclone/resources"

diff --git a/pkg/workflow/workload/pod/builder.go b/pkg/workflow/workload/pod/builder.go
@@ -462,6 +462,7 @@ func (m *Builder) ResolveInputResources() error {
 					MountPath: common.ToolboxPath,
 				},
 				{
+					// input container might write the __result__ file.
 					Name:      common.CoordinatorSidecarVolumeName,
 					MountPath: common.ResultFileDir,
 					SubPath:   common.ResultSubPath(containerName),
@@ -849,7 +850,7 @@ func (m *Builder) AddCoordinator() error {
 			{
 				Name:      common.CoordinatorSidecarVolumeName,
 				MountPath: filepath.Join(common.CoordinatorWorkspacePath, "results"),
-				SubPath:   "__results__",
+				SubPath:   common.ResultDirSubPath,
 			},
 		},
 		ImagePullPolicy: controller.ImagePullPolicy(),