CRT op inactivity timeout refactoring and extending imagebuild to support the simple build engine

kcq · kcq · commit 9dd7eb393ec0 · 2024-10-13T22:59:50.000-07:00
Signed-off-by: Kyle Quest &lt;kcq.public@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -327,6 +327,9 @@ Global options:
 - `--host` - Docker host address or socket (prefix with `tcp://` or `unix://`)
 - `--crt-connection` - Container runtime connection (for non-Docker runtimes / for Docker user --host)
 - `--crt-context` - Container runtime context name if supported (for Docker similar to setting '--context' or DOCKER_CONTEXT)
+- `--crt-io-inactivity-timeout` - CRT I/O general inactivity timeout.
+- `--crt-save-inactivity-timeout` - CRT save image operation inactivity timeout (overrides the general I/O timeout). If not set, defaults to 30 seconds.
+- `--crt-copy-inactivity-timeout` - CRT copy from container operation inactivity timeout (overrides the general I/O timeout). If not set, defaults to 30 seconds.
 - `--tls` - use TLS connecting to Docker
 - `--tls-verify` - do TLS verification
 - `--tls-cert-path` - path to TLS cert files
diff --git a/pkg/app/master/command/build/handler.go b/pkg/app/master/command/build/handler.go
@@ -670,7 +670,14 @@ func OnCommand(
 				}
 
 				xc.Out.Info("image.data.inspection.save.image.start")
-				err = dockerutil.SaveImage(client, imageID, iaPath, false, false)
+				var saveInactivityTimeout int
+				if gparams.CRTSaveInactivityTimeout > 0 {
+					saveInactivityTimeout = gparams.CRTSaveInactivityTimeout
+				} else if gparams.CRTIOInactivityTimeout > 0 {
+					saveInactivityTimeout = gparams.CRTIOInactivityTimeout
+				}
+
+				err = dockerutil.SaveImage(client, imageID, iaPath, false, false, saveInactivityTimeout)
 				errutil.FailOn(err)
 
 				err = fsutil.Touch(iaPathReady)
@@ -1113,6 +1120,8 @@ func OnCommand(
 		gparams.LogLevel,
 		gparams.LogFormat,
 		gparams.InContainer,
+		gparams.CRTIOInactivityTimeout,
+		gparams.CRTCopyInactivityTimeout,
 		rtaSourcePT,
 		doObfuscateMetadata,
 		obfuscateAppPackageNames,
diff --git a/pkg/app/master/command/build/image.go b/pkg/app/master/command/build/image.go
@@ -368,7 +368,7 @@ func buildOutputImage(
 		xc.FailOn(err)
 
 		opts := imagebuilder.SimpleBuildOptions{
-			ImageConfig: imagebuilder.ImageConfig{
+			ImageConfig: &imagebuilder.ImageConfig{
 				Architecture: imageBuildArch,
 				Config: imagebuilder.RunConfig{
 					ExposedPorts: map[string]struct{}{},
diff --git a/pkg/app/master/command/cliflags.go b/pkg/app/master/command/cliflags.go
@@ -15,26 +15,29 @@ import (
 
 // Global flag names
 const (
-	FlagCommandReport = "report"
-	FlagCheckVersion  = "check-version"
-	FlagDebug         = "debug"
-	FlagVerbose       = "verbose"
-	FlagQuietCLIMode  = "quiet"
-	FlagLogLevel      = "log-level"
-	FlagLog           = "log"
-	FlagLogFormat     = "log-format"
-	FlagAPIVersion    = "crt-api-version"
-	FlagUseTLS        = "tls"
-	FlagVerifyTLS     = "tls-verify"
-	FlagTLSCertPath   = "tls-cert-path"
-	FlagHost          = "host"
-	FlagCRTConnection = "crt-connection"
-	FlagCRTContext    = "crt-context"
-	FlagStatePath     = "state-path"
-	FlagInContainer   = "in-container"
-	FlagArchiveState  = "archive-state"
-	FlagNoColor       = "no-color"
-	FlagOutputFormat  = "output-format"
+	FlagCommandReport            = "report"
+	FlagCheckVersion             = "check-version"
+	FlagDebug                    = "debug"
+	FlagVerbose                  = "verbose"
+	FlagQuietCLIMode             = "quiet"
+	FlagLogLevel                 = "log-level"
+	FlagLog                      = "log"
+	FlagLogFormat                = "log-format"
+	FlagAPIVersion               = "crt-api-version"
+	FlagUseTLS                   = "tls"
+	FlagVerifyTLS                = "tls-verify"
+	FlagTLSCertPath              = "tls-cert-path"
+	FlagHost                     = "host"
+	FlagCRTConnection            = "crt-connection"
+	FlagCRTContext               = "crt-context"
+	FlagStatePath                = "state-path"
+	FlagInContainer              = "in-container"
+	FlagArchiveState             = "archive-state"
+	FlagNoColor                  = "no-color"
+	FlagOutputFormat             = "output-format"
+	FlagCRTIOInactivityTimeout   = "crt-io-inactivity-timeout"
+	FlagCRTSaveInactivityTimeout = "crt-save-inactivity-timeout"
+	FlagCRTCopyInactivityTimeout = "crt-copy-inactivity-timeout"
 )
 
 const (
@@ -64,6 +67,10 @@ const (
 	FlagInContainerUsage   = "app is running in a container"
 	FlagArchiveStateUsage  = "archive app state to the selected Docker volume (default volume - mint-state). By default, enabled when app is running in a container (disabled otherwise). Set it to 'off' to disable explicitly."
 	FlagNoColorUsage       = "disable color output"
+
+	FlagCRTIOInactivityTimeoutUsage   = "CRT I/O general inactivity timeout"
+	FlagCRTSaveInactivityTimeoutUsage = "CRT save image operation inactivity timeout (overrides the general I/O timeout)"
+	FlagCRTCopyInactivityTimeoutUsage = "CRT copy from container operation inactivity timeout (overrides the general I/O timeout)"
 )
 
 // Shared command flag names
@@ -402,6 +409,24 @@ func GlobalFlags() []cli.Flag {
 			Usage:   FlagCRTContextUsage,
 			EnvVars: []string{"DSLIM_CRT_CTX"},
 		},
+		&cli.IntFlag{
+			Name:    FlagCRTIOInactivityTimeout,
+			Value:   0,
+			Usage:   FlagCRTIOInactivityTimeoutUsage,
+			EnvVars: []string{"DSLIM_CRT_IO_INACTIVITY_TIMEOUT"},
+		},
+		&cli.IntFlag{
+			Name:    FlagCRTSaveInactivityTimeout,
+			Value:   0,
+			Usage:   FlagCRTSaveInactivityTimeoutUsage,
+			EnvVars: []string{"DSLIM_CRT_SAVE_INACTIVITY_TIMEOUT"},
+		},
+		&cli.IntFlag{
+			Name:    FlagCRTCopyInactivityTimeout,
+			Value:   0,
+			Usage:   FlagCRTCopyInactivityTimeoutUsage,
+			EnvVars: []string{"DSLIM_CRT_COPY_INACTIVITY_TIMEOUT"},
+		},
 		&cli.StringFlag{
 			Name:  FlagStatePath,
 			Value: "",
diff --git a/pkg/app/master/command/clifvgetter.go b/pkg/app/master/command/clifvgetter.go
@@ -396,6 +396,18 @@ func UpdateGlobalFlagValues(appOpts *config.AppOptions, values *GenericParams) *
 		values.CRTContext = *appOpts.Global.CRTContext
 	}
 
+	if appOpts.Global.CRTIOInactivityTimeout != nil {
+		values.CRTIOInactivityTimeout = *appOpts.Global.CRTIOInactivityTimeout
+	}
+
+	if appOpts.Global.CRTSaveInactivityTimeout != nil {
+		values.CRTSaveInactivityTimeout = *appOpts.Global.CRTSaveInactivityTimeout
+	}
+
+	if appOpts.Global.CRTCopyInactivityTimeout != nil {
+		values.CRTCopyInactivityTimeout = *appOpts.Global.CRTCopyInactivityTimeout
+	}
+
 	if appOpts.Global.UseTLS != nil {
 		values.ClientConfig.UseTLS = *appOpts.Global.UseTLS
 	}
@@ -421,19 +433,22 @@ func UpdateGlobalFlagValues(appOpts *config.AppOptions, values *GenericParams) *
 
 func GlobalFlagValues(ctx *cli.Context) *GenericParams {
 	values := GenericParams{
-		NoColor:        ctx.Bool(FlagNoColor),
-		CheckVersion:   ctx.Bool(FlagCheckVersion),
-		Debug:          ctx.Bool(FlagDebug),
-		Verbose:        ctx.Bool(FlagVerbose),
-		QuietCLIMode:   ctx.Bool(FlagQuietCLIMode),
-		LogLevel:       ctx.String(FlagLogLevel),
-		LogFormat:      ctx.String(FlagLogFormat),
-		OutputFormat:   ctx.String(FlagOutputFormat),
-		Log:            ctx.String(FlagLog),
-		StatePath:      ctx.String(FlagStatePath),
-		ReportLocation: ctx.String(FlagCommandReport),
-		CRTConnection:  ctx.String(FlagCRTConnection),
-		CRTContext:     ctx.String(FlagCRTContext),
+		NoColor:                  ctx.Bool(FlagNoColor),
+		CheckVersion:             ctx.Bool(FlagCheckVersion),
+		Debug:                    ctx.Bool(FlagDebug),
+		Verbose:                  ctx.Bool(FlagVerbose),
+		QuietCLIMode:             ctx.Bool(FlagQuietCLIMode),
+		LogLevel:                 ctx.String(FlagLogLevel),
+		LogFormat:                ctx.String(FlagLogFormat),
+		OutputFormat:             ctx.String(FlagOutputFormat),
+		Log:                      ctx.String(FlagLog),
+		StatePath:                ctx.String(FlagStatePath),
+		ReportLocation:           ctx.String(FlagCommandReport),
+		CRTConnection:            ctx.String(FlagCRTConnection),
+		CRTContext:               ctx.String(FlagCRTContext),
+		CRTIOInactivityTimeout:   ctx.Int(FlagCRTIOInactivityTimeout),
+		CRTSaveInactivityTimeout: ctx.Int(FlagCRTSaveInactivityTimeout),
+		CRTCopyInactivityTimeout: ctx.Int(FlagCRTCopyInactivityTimeout),
 	}
 
 	if values.ReportLocation == "off" {
diff --git a/pkg/app/master/command/common.go b/pkg/app/master/command/common.go
@@ -57,23 +57,26 @@ func CLIContextGet(ctx context.Context, key CLIContextKey) interface{} {
 /////////////////////////////////////////////////////////
 
 type GenericParams struct {
-	NoColor        bool
-	CheckVersion   bool
-	Debug          bool
-	Verbose        bool
-	QuietCLIMode   bool
-	LogLevel       string
-	LogFormat      string
-	OutputFormat   string
-	Log            string
-	StatePath      string
-	ReportLocation string
-	InContainer    bool
-	IsDSImage      bool
-	ArchiveState   string
-	CRTConnection  string
-	CRTContext     string
-	ClientConfig   *config.DockerClient
+	NoColor                  bool
+	CheckVersion             bool
+	Debug                    bool
+	Verbose                  bool
+	QuietCLIMode             bool
+	LogLevel                 string
+	LogFormat                string
+	OutputFormat             string
+	Log                      string
+	StatePath                string
+	ReportLocation           string
+	InContainer              bool
+	IsDSImage                bool
+	ArchiveState             string
+	CRTConnection            string
+	CRTContext               string
+	ClientConfig             *config.DockerClient
+	CRTIOInactivityTimeout   int
+	CRTSaveInactivityTimeout int
+	CRTCopyInactivityTimeout int
 }
 
 // TODO: spread these code types across all command definition, so it's not all defined here
diff --git a/pkg/app/master/command/merge/handler.go b/pkg/app/master/command/merge/handler.go
@@ -314,7 +314,6 @@ func OnCommand(
 
 	ensureImage("output", outputTags[0], cmdReport)
 	xc.Out.State("output.image.generate.done")
-	//////////////////////////////////////////////////
 
 	xc.Out.State(cmd.StateCompleted)
 	cmdReport.State = cmd.StateCompleted
diff --git a/pkg/app/master/command/profile/handler.go b/pkg/app/master/command/profile/handler.go
@@ -276,6 +276,8 @@ func OnCommand(
 		logLevel,
 		logFormat,
 		gparams.InContainer,
+		gparams.CRTIOInactivityTimeout,
+		gparams.CRTCopyInactivityTimeout,
 		true,  //rtaSourcePT
 		false, //doObfuscateMetadata
 		"",    //doObfuscateAPN
diff --git a/pkg/app/master/command/xray/handler.go b/pkg/app/master/command/xray/handler.go
@@ -454,7 +454,13 @@ func OnCommand(
 		}
 
 		xc.Out.Info("image.data.inspection.save.image.start")
-		err = crtClient.SaveImage(imageID, iaPath, false, false)
+		var saveInactivityTimeout int
+		if gparams.CRTSaveInactivityTimeout > 0 {
+			saveInactivityTimeout = gparams.CRTSaveInactivityTimeout
+		} else if gparams.CRTIOInactivityTimeout > 0 {
+			saveInactivityTimeout = gparams.CRTIOInactivityTimeout
+		}
+		err = crtClient.SaveImage(imageID, iaPath, false, false, saveInactivityTimeout)
 		errutil.FailOn(err)
 
 		err = fsutil.Touch(iaPathReady)
diff --git a/pkg/app/master/config/config.go b/pkg/app/master/config/config.go
@@ -24,25 +24,28 @@ type AppOptions struct {
 
 // GlobalAppOptions provides a set of global application parameters
 type GlobalAppOptions struct {
-	NoColor        *bool   `json:"no_color,omitempty"`
-	CheckVersion   *bool   `json:"check_version,omitempty"`
-	Debug          *bool   `json:"debug,omitempty"`
-	Verbose        *bool   `json:"verbose,omitempty"`
-	Quiet          *bool   `json:"quiet,omitempty"`
-	OutputFormat   *string `json:"output_format,omitempty"`
-	LogLevel       *string `json:"log_level,omitempty"`
-	Log            *string `json:"log,omitempty"`
-	LogFormat      *string `json:"log_format,omitempty"`
-	UseTLS         *bool   `json:"tls,omitempty"`
-	VerifyTLS      *bool   `json:"tls_verify,omitempty"`
-	TLSCertPath    *string `json:"tls_cert_path,omitempty"`
-	APIVersion     *string `json:"api_version,omitempty"`
-	Host           *string `json:"host,omitempty"`
-	StatePath      *string `json:"state_path,omitempty"`
-	ReportLocation *string `json:"report_location,omitempty"`
-	CRTConnection  *string `json:"crt_connection,omitempty"`
-	CRTContext     *string `json:"crt_context,omitempty"`
-	ArchiveState   *string `json:"archive_state,omitempty"`
+	NoColor                  *bool   `json:"no_color,omitempty"`
+	CheckVersion             *bool   `json:"check_version,omitempty"`
+	Debug                    *bool   `json:"debug,omitempty"`
+	Verbose                  *bool   `json:"verbose,omitempty"`
+	Quiet                    *bool   `json:"quiet,omitempty"`
+	OutputFormat             *string `json:"output_format,omitempty"`
+	LogLevel                 *string `json:"log_level,omitempty"`
+	Log                      *string `json:"log,omitempty"`
+	LogFormat                *string `json:"log_format,omitempty"`
+	UseTLS                   *bool   `json:"tls,omitempty"`
+	VerifyTLS                *bool   `json:"tls_verify,omitempty"`
+	TLSCertPath              *string `json:"tls_cert_path,omitempty"`
+	APIVersion               *string `json:"api_version,omitempty"`
+	Host                     *string `json:"host,omitempty"`
+	StatePath                *string `json:"state_path,omitempty"`
+	ReportLocation           *string `json:"report_location,omitempty"`
+	CRTConnection            *string `json:"crt_connection,omitempty"`
+	CRTContext               *string `json:"crt_context,omitempty"`
+	ArchiveState             *string `json:"archive_state,omitempty"`
+	CRTIOInactivityTimeout   *int    `json:"crt_io_inactivity_timeout,omitempty"`
+	CRTSaveInactivityTimeout *int    `json:"crt_save_inactivity_timeout,omitempty"`
+	CRTCopyInactivityTimeout *int    `json:"crt_copy_inactivity_timeout,omitempty"`
 }
 
 func NewAppOptionsFromFile(dir string) (*AppOptions, error) {
diff --git a/pkg/app/master/inspectors/container/container_inspector.go b/pkg/app/master/inspectors/container/container_inspector.go
@@ -137,6 +137,8 @@ type Inspector struct {
 	LogFormat                string
 	PrintState               bool
 	InContainer              bool
+	CRTIOInactivityTimeout   int
+	CRTCopyInactivityTimeout int
 	RTASourcePT              bool
 	DoObfuscateMetadata      bool
 	ObfuscateAppPackageNames string
@@ -221,6 +223,8 @@ func NewInspector(
 	logLevel string,
 	logFormat string,
 	inContainer bool,
+	crtIOInactivityTimeout int,
+	crtCopyInactivityTimeout int,
 	rtaSourcePT bool,
 	doObfuscateMetadata bool,
 	obfuscateAppPackageNames string,
@@ -282,6 +286,8 @@ func NewInspector(
 		LogFormat:                logFormat,
 		PrintState:               printState,
 		InContainer:              inContainer,
+		CRTIOInactivityTimeout:   crtIOInactivityTimeout,
+		CRTCopyInactivityTimeout: crtCopyInactivityTimeout,
 		RTASourcePT:              rtaSourcePT,
 		DoObfuscateMetadata:      doObfuscateMetadata,
 		ObfuscateAppPackageNames: obfuscateAppPackageNames,
@@ -1247,10 +1253,17 @@ func (i *Inspector) ShutdownContainer(terminateOnly bool) error {
 				deleteOrig = false
 			}
 
+			var copyInactivityTimeout int
+			if i.CRTCopyInactivityTimeout > 0 {
+				copyInactivityTimeout = i.CRTCopyInactivityTimeout
+			} else if i.CRTIOInactivityTimeout > 0 {
+				copyInactivityTimeout = i.CRTIOInactivityTimeout
+			}
+
 			//copy the container report
 			reportLocalPath := filepath.Join(i.LocalVolumePath, ArtifactsDir, ReportArtifactTar)
 			reportRemotePath := filepath.Join(app.DefaultArtifactsDirPath, report.DefaultContainerReportFileName)
-			err := dockerutil.CopyFromContainer(i.APIClient, i.ContainerID, reportRemotePath, reportLocalPath, true, deleteOrig)
+			err := dockerutil.CopyFromContainer(i.APIClient, i.ContainerID, reportRemotePath, reportLocalPath, true, deleteOrig, copyInactivityTimeout)
 			if err != nil {
 				logger.WithError(err).WithField("container", i.ContainerID).Error("dockerutil.CopyFromContainer")
 				//can't call errutil.FailOn() because we won't cleanup the target container
@@ -1261,7 +1274,7 @@ func (i *Inspector) ShutdownContainer(terminateOnly bool) error {
 				//copy the monitor data event log (if available)
 				mondelLocalPath := filepath.Join(i.LocalVolumePath, ArtifactsDir, MondelArtifactTar)
 				mondelRemotePath := filepath.Join(app.DefaultArtifactsDirPath, report.DefaultMonDelFileName)
-				err = dockerutil.CopyFromContainer(i.APIClient, i.ContainerID, mondelRemotePath, mondelLocalPath, true, deleteOrig)
+				err = dockerutil.CopyFromContainer(i.APIClient, i.ContainerID, mondelRemotePath, mondelLocalPath, true, deleteOrig, copyInactivityTimeout)
 				if err != nil {
 					//not a failure because the log might not be there (just log it)
 					logger.WithFields(log.Fields{
@@ -1290,7 +1303,7 @@ func (i *Inspector) ShutdownContainer(terminateOnly bool) error {
 
 			filesOutLocalPath := filepath.Join(i.LocalVolumePath, ArtifactsDir, FileArtifactsOutTar)
 			filesRemotePath := filepath.Join(app.DefaultArtifactsDirPath, app.ArtifactFilesDirName)
-			err = dockerutil.CopyFromContainer(i.APIClient, i.ContainerID, filesRemotePath, filesOutLocalPath, false, false)
+			err = dockerutil.CopyFromContainer(i.APIClient, i.ContainerID, filesRemotePath, filesOutLocalPath, false, false, copyInactivityTimeout)
 			if err != nil {
 				logger.WithError(err).WithField("container", i.ContainerID).Error("dockerutil.CopyFromContainer")
 				//can't call errutil.FailOn() because we won't cleanup the target container
diff --git a/pkg/crt/clients.go b/pkg/crt/clients.go
@@ -126,7 +126,7 @@ type InspectorAPIClient interface {
 }
 
 type ImageSaverAPIClient interface {
-	SaveImage(imageRef, localPath string, extract, removeOrig bool) error
+	SaveImage(imageRef, localPath string, extract, removeOrig bool, inactivityTimeout int) error
 }
 
 type ImageLoaderAPIClient interface {
diff --git a/pkg/crt/docker/dockercrtclient/dockercrtclient.go b/pkg/crt/docker/dockercrtclient/dockercrtclient.go
@@ -328,8 +328,8 @@ func (ref *Instance) GetRegistryAuthConfig(account, secret, configPath, registry
 	return cred, nil
 }
 
-func (ref *Instance) SaveImage(imageRef, localPath string, extract, removeOrig bool) error {
-	err := dockerutil.SaveImage(ref.pclient, imageRef, localPath, extract, removeOrig)
+func (ref *Instance) SaveImage(imageRef, localPath string, extract, removeOrig bool, inactivityTimeout int) error {
+	err := dockerutil.SaveImage(ref.pclient, imageRef, localPath, extract, removeOrig, inactivityTimeout)
 	if err != nil {
 		if err == dockerutil.ErrBadParam {
 			err = crt.ErrBadParam
diff --git a/pkg/crt/docker/dockerutil/dockerutil.go b/pkg/crt/docker/dockerutil/dockerutil.go
diff --git a/pkg/crt/podman/podmancrtclient/podmancrtclient.go b/pkg/crt/podman/podmancrtclient/podmancrtclient.go
diff --git a/pkg/crt/podman/podmanutil/podmanutil.go b/pkg/crt/podman/podmanutil/podmanutil.go
diff --git a/pkg/imagebuilder/imagebuilder.go b/pkg/imagebuilder/imagebuilder.go
diff --git a/pkg/imagebuilder/internalbuilder/engine.go b/pkg/imagebuilder/internalbuilder/engine.go
