feat: allow custom engine, core, files images

cli/cli/commands/engine/restart/restart.go

@@ -20,11 +20,13 @@ import (
 
 const (
 	engineVersionFlagKey           = "version"
+	engineAuthorFlagKey            = "author"
 	logLevelFlagKey                = "log-level"
 	enclavePoolSizeFlagKey         = "enclave-pool-size"
 	githubAuthTokenOverrideFlagKey = "github-auth-token"
 
 	defaultEngineVersion                   = ""
+	defaultEngineAuthor                    = "kurtosistech"
 	restartEngineOnSameVersionIfAnyRunning = false
 
 	defaultShouldRestartAPIContainers = "false"
@@ -44,6 +46,13 @@ var RestartCmd = &lowlevel.LowlevelKurtosisCommand{
 			Type:      flags.FlagType_String,
 			Default:   defaultEngineVersion,
 		},
+		{
+			Key:       engineAuthorFlagKey,
+			Usage:     "The author (Docker username) of the Kurtosis engine that should be started (blank will start the kurtosistech version)",
+			Shorthand: "",
+			Type:      flags.FlagType_String,
+			Default:   defaultEngineAuthor,
+		},
 		{
 			Key: logLevelFlagKey,
 			Usage: fmt.Sprintf(
@@ -142,9 +151,18 @@ func run(_ context.Context, flags *flags.ParsedFlags, _ *args.ParsedArgs) error
 		return stacktrace.Propagate(err, "Expected a value for the '%v' flag but failed to get it", restartAPIContainersFlagKey)
 	}
 
+	engineAuthor, err := flags.GetString(engineAuthorFlagKey)
+	if err != nil {
+		return stacktrace.Propagate(err, "Expected a value for the '%v' flag but failed to get it", engineAuthorFlagKey)
+	}
+
+	if engineAuthor != defaultEngineAuthor && engineVersion == defaultEngineVersion {
+		return stacktrace.NewError("Expected '%v' to be set as '%v' was set. Need to enter a custom engine veresion if a custom engine author is set", engineVersionFlagKey, engineAuthorFlagKey)
+	}
+
 	var engineClientCloseFunc func() error
 	var restartEngineErr error
-	_, engineClientCloseFunc, restartEngineErr = engineManager.RestartEngineIdempotently(ctx, logLevel, engineVersion, restartEngineOnSameVersionIfAnyRunning, enclavePoolSize, shouldStartInDebugMode, githubAuthTokenOverride, shouldRestartAPIContainers)
+	_, engineClientCloseFunc, restartEngineErr = engineManager.RestartEngineIdempotently(ctx, logLevel, engineVersion, engineAuthor, restartEngineOnSameVersionIfAnyRunning, enclavePoolSize, shouldStartInDebugMode, githubAuthTokenOverride, shouldRestartAPIContainers)
 	if restartEngineErr != nil {
 		return stacktrace.Propagate(restartEngineErr, "An error occurred restarting the Kurtosis engine")
 	}

cli/cli/commands/engine/start/start.go

@@ -20,11 +20,13 @@ import (
 
 const (
 	engineVersionFlagKey           = "version"
+	engineAuthorFlagKey            = "author"
 	logLevelFlagKey                = "log-level"
 	enclavePoolSizeFlagKey         = "enclave-pool-size"
 	githubAuthTokenOverrideFlagKey = "github-auth-token"
 
 	defaultEngineVersion          = ""
+	defaultEngineAuthor           = "kurtosistech"
 	kurtosisTechEngineImagePrefix = "kurtosistech/engine"
 	imageVersionDelimiter         = ":"
 
@@ -45,6 +47,13 @@ var StartCmd = &lowlevel.LowlevelKurtosisCommand{
 			Type:      flags.FlagType_String,
 			Default:   defaultEngineVersion,
 		},
+		{
+			Key:       engineAuthorFlagKey,
+			Usage:     "The author (Docker username) of the Kurtosis engine that should be started (blank will start the kurtosistech version)",
+			Shorthand: "",
+			Type:      flags.FlagType_String,
+			Default:   defaultEngineAuthor,
+		},
 		{
 			Key: logLevelFlagKey,
 			Usage: fmt.Sprintf(
@@ -138,16 +147,30 @@ func run(_ context.Context, flags *flags.ParsedFlags, _ *args.ParsedArgs) error
 		return stacktrace.Propagate(err, "Expected a value for the '%v' flag but failed to get it", restartAPIContainersFlagKey)
 	}
 
+	engineAuthor, err := flags.GetString(engineAuthorFlagKey)
+	if err != nil {
+		return stacktrace.Propagate(err, "Expected a value for the '%v' flag but failed to get it", engineAuthorFlagKey)
+	}
+
+	if engineAuthor != defaultEngineAuthor && engineVersion == defaultEngineVersion {
+		return stacktrace.NewError("Expected '%v' to be set as '%v' was set. Need to enter a custom engine veresion if a custom engine author is set", engineVersionFlagKey, engineAuthorFlagKey)
+	}
+
+	imageForLogging := kurtosisTechEngineImagePrefix
+	if engineAuthor != defaultEngineAuthor {
+		imageForLogging = strings.Replace(imageForLogging, defaultEngineAuthor, engineAuthor, 1)
+	}
+
 	if engineVersion == defaultEngineVersion && isDebugMode {
 		engineDebugVersion := fmt.Sprintf("%s-%s", kurtosis_version.KurtosisVersion, defaults.DefaultKurtosisContainerDebugImageNameSuffix)
-		logrus.Infof("Starting Kurtosis engine in debug mode from image '%v%v%v'...", kurtosisTechEngineImagePrefix, imageVersionDelimiter, engineDebugVersion)
-		_, engineClientCloseFunc, startEngineErr = engineManager.StartEngineIdempotentlyWithCustomVersion(ctx, engineDebugVersion, logLevel, enclavePoolSize, true, githubAuthTokenOverride, shouldRestartAPIContainers)
+		logrus.Infof("Starting Kurtosis engine in debug mode from image '%v%v%v'...", imageForLogging, imageVersionDelimiter, engineDebugVersion)
+		_, engineClientCloseFunc, startEngineErr = engineManager.StartEngineIdempotentlyWithCustomVersion(ctx, engineDebugVersion, engineAuthor, logLevel, enclavePoolSize, true, githubAuthTokenOverride, shouldRestartAPIContainers)
 	} else if engineVersion == defaultEngineVersion {
-		logrus.Infof("Starting Kurtosis engine from image '%v%v%v'...", kurtosisTechEngineImagePrefix, imageVersionDelimiter, kurtosis_version.KurtosisVersion)
+		logrus.Infof("Starting Kurtosis engine from image '%v%v%v'...", imageForLogging, imageVersionDelimiter, kurtosis_version.KurtosisVersion)
 		_, engineClientCloseFunc, startEngineErr = engineManager.StartEngineIdempotentlyWithDefaultVersion(ctx, logLevel, enclavePoolSize, githubAuthTokenOverride, shouldRestartAPIContainers)
 	} else {
-		logrus.Infof("Starting Kurtosis engine from image '%v%v%v'...", kurtosisTechEngineImagePrefix, imageVersionDelimiter, engineVersion)
-		_, engineClientCloseFunc, startEngineErr = engineManager.StartEngineIdempotentlyWithCustomVersion(ctx, engineVersion, logLevel, enclavePoolSize, defaults.DefaultEnableDebugMode, githubAuthTokenOverride, shouldRestartAPIContainers)
+		logrus.Infof("Starting Kurtosis engine from image '%v%v%v'...", imageForLogging, imageVersionDelimiter, engineVersion)
+		_, engineClientCloseFunc, startEngineErr = engineManager.StartEngineIdempotentlyWithCustomVersion(ctx, engineVersion, engineAuthor, logLevel, enclavePoolSize, defaults.DefaultEnableDebugMode, githubAuthTokenOverride, shouldRestartAPIContainers)
 	}
 	if startEngineErr != nil {
 		return stacktrace.Propagate(startEngineErr, "An error occurred starting the Kurtosis engine")

cli/cli/commands/github/login/login.go

@@ -18,6 +18,7 @@ import (
 
 const (
 	defaultEngineVersion                   = ""
+	defaultEngineAuthor                    = "kurtosistech"
 	restartEngineOnSameVersionIfAnyRunning = true
 )
 
@@ -71,7 +72,7 @@ func RestartEngineAfterGitHubAuth(ctx context.Context) error {
 	var engineClientCloseFunc func() error
 	var restartEngineErr error
 	dontRestartAPIContainers := false
-	_, engineClientCloseFunc, restartEngineErr = engineManager.RestartEngineIdempotently(ctx, defaults.DefaultEngineLogLevel, defaultEngineVersion, restartEngineOnSameVersionIfAnyRunning, defaults.DefaultEngineEnclavePoolSize, defaults.DefaultEnableDebugMode, defaults.DefaultGitHubAuthTokenOverride, dontRestartAPIContainers)
+	_, engineClientCloseFunc, restartEngineErr = engineManager.RestartEngineIdempotently(ctx, defaults.DefaultEngineLogLevel, defaultEngineVersion, defaultEngineAuthor, restartEngineOnSameVersionIfAnyRunning, defaults.DefaultEngineEnclavePoolSize, defaults.DefaultEnableDebugMode, defaults.DefaultGitHubAuthTokenOverride, dontRestartAPIContainers)
 	if restartEngineErr != nil {
 		return stacktrace.Propagate(restartEngineErr, "An error occurred restarting the Kurtosis engine")
 	}

cli/cli/helpers/engine_manager/engine_existence_guarantor.go

@@ -23,6 +23,7 @@ import (
 const (
 	// If set to empty, then we'll use whichever default version the launcher provides
 	defaultEngineImageVersionTag                                           = ""
+	defaultEngineAuthor                                                    = "kurtosistech"
 	shouldForceLogsComponentsContainersRestartWhenEngineContainerIsStopped = true
 	shouldForceLogsComponentsContainersRestartWhenEngineContainerIsRunning = false
 )
@@ -84,6 +85,9 @@ type engineExistenceGuarantor struct {
 
 	// To restart the current API containers after the engine has been restarted
 	restartAPIContainers bool
+
+	// The author of the repository where the engine is
+	engineAuthor string
 }
 
 func newEngineExistenceGuarantorWithDefaultVersion(
@@ -110,6 +114,7 @@ func newEngineExistenceGuarantorWithDefaultVersion(
 		shouldSendMetrics,
 		engineServerKurtosisBackendConfigSupplier,
 		defaultEngineImageVersionTag,
+		defaultEngineAuthor,
 		logLevel,
 		maybeCurrentlyRunningEngineVersionTag,
 		kurtosisClusterType,
@@ -130,6 +135,7 @@ func newEngineExistenceGuarantorWithCustomVersion(
 	shouldSendMetrics bool,
 	engineServerKurtosisBackendConfigSupplier engine_server_launcher.KurtosisBackendConfigSupplier,
 	imageVersionTag string,
+	engineAuthor string,
 	logLevel logrus.Level,
 	maybeCurrentlyRunningEngineVersionTag string,
 	kurtosisClusterType resolved_config.KurtosisClusterType,
@@ -160,6 +166,7 @@ func newEngineExistenceGuarantorWithCustomVersion(
 		shouldRunInDebugMode:                      shouldRunInDebugMode,
 		githubAuthTokenOverride:                   githubAuthTokenOverride,
 		restartAPIContainers:                      restartAPIContainers,
+		engineAuthor:                              engineAuthor,
 	}
 }
 
@@ -221,9 +228,10 @@ func (guarantor *engineExistenceGuarantor) VisitStopped() error {
 			guarantor.restartAPIContainers,
 		)
 	} else {
-		_, _, engineLaunchErr = guarantor.engineServerLauncher.LaunchWithCustomVersion(
+		_, _, engineLaunchErr = guarantor.engineServerLauncher.LaunchWithCustomImageAuthor(
 			guarantor.ctx,
 			guarantor.imageVersionTag,
+			guarantor.engineAuthor,
 			guarantor.logLevel,
 			kurtosis_context.DefaultGrpcEngineServerPortNum,
 			metricsUserId,

cli/cli/helpers/engine_manager/engine_manager.go

@@ -219,6 +219,7 @@ func (manager *EngineManager) StartEngineIdempotentlyWithDefaultVersion(
 func (manager *EngineManager) StartEngineIdempotentlyWithCustomVersion(
 	ctx context.Context,
 	engineImageVersionTag string,
+	engineAuthor string,
 	logLevel logrus.Level,
 	poolSize uint8,
 	shouldStartInDebugMode bool,
@@ -238,6 +239,7 @@ func (manager *EngineManager) StartEngineIdempotentlyWithCustomVersion(
 		manager.shouldSendMetrics,
 		manager.engineServerKurtosisBackendConfigSupplier,
 		engineImageVersionTag,
+		engineAuthor,
 		logLevel,
 		engineVersion,
 		clusterType,
@@ -343,6 +345,7 @@ func (manager *EngineManager) RestartEngineIdempotently(
 	ctx context.Context,
 	logLevel logrus.Level,
 	optionalVersionToUse string,
+	engineAuthor string,
 	restartEngineOnSameVersionIfAnyRunning bool,
 	poolSize uint8,
 	shouldStartInDebugMode bool,
@@ -373,7 +376,7 @@ func (manager *EngineManager) RestartEngineIdempotently(
 	var engineClientCloseFunc func() error
 	var restartEngineErr error
 	if versionOfNewEngine != defaultEngineVersion {
-		_, engineClientCloseFunc, restartEngineErr = manager.StartEngineIdempotentlyWithCustomVersion(ctx, versionOfNewEngine, logLevel, poolSize, shouldStartInDebugMode, githubAuthTokenOverride, shouldRestartAPIContainers)
+		_, engineClientCloseFunc, restartEngineErr = manager.StartEngineIdempotentlyWithCustomVersion(ctx, versionOfNewEngine, engineAuthor, logLevel, poolSize, shouldStartInDebugMode, githubAuthTokenOverride, shouldRestartAPIContainers)
 	} else {
 		_, engineClientCloseFunc, restartEngineErr = manager.StartEngineIdempotentlyWithDefaultVersion(ctx, logLevel, poolSize, githubAuthTokenOverride, shouldRestartAPIContainers)
 	}

core/launcher/api_container_launcher/api_container_launcher.go

@@ -21,7 +21,9 @@ const (
 	enclaveDataVolumeDirpath = "/kurtosis-data"
 
 	// TODO This should come from the same logic that builds the server image!!!!!
-	containerImage = "kurtosistech/core"
+	defaultImageAuthor       = "kurtosistech"
+	authorImageNameSeparator = "/"
+	containerImage           = "core"
 )
 
 type ApiContainerLauncher struct {
@@ -90,6 +92,45 @@ func (launcher ApiContainerLauncher) LaunchWithCustomVersion(
 ) (
 	resultApiContainer *api_container.APIContainer,
 	resultErr error,
+) {
+	return launcher.LaunchWithCustomImageAuthor(
+		ctx,
+		imageVersionTag,
+		defaultImageAuthor,
+		logLevel,
+		enclaveUuid,
+		grpcPortNum,
+		backendConfigSupplier,
+		enclaveEnvVars,
+		isProductionEnclave,
+		metricsUserID,
+		didUserAcceptSendingMetrics,
+		isCI,
+		cloudUserID,
+		cloudInstanceID,
+		shouldStartInDebugMode,
+	)
+}
+
+func (launcher ApiContainerLauncher) LaunchWithCustomImageAuthor(
+	ctx context.Context,
+	imageVersionTag string,
+	imageAuthor string,
+	logLevel logrus.Level,
+	enclaveUuid enclave.EnclaveUUID,
+	grpcPortNum uint16,
+	backendConfigSupplier KurtosisBackendConfigSupplier,
+	enclaveEnvVars string,
+	isProductionEnclave bool,
+	metricsUserID string,
+	didUserAcceptSendingMetrics bool,
+	isCI bool,
+	cloudUserID metrics_client.CloudUserID,
+	cloudInstanceID metrics_client.CloudInstanceID,
+	shouldStartInDebugMode bool,
+) (
+	resultApiContainer *api_container.APIContainer,
+	resultErr error,
 ) {
 	kurtosisBackendType, kurtosisBackendConfig := backendConfigSupplier.getKurtosisBackendConfig()
 	argsObj, err := args.NewAPIContainerArgs(
@@ -107,6 +148,7 @@ func (launcher ApiContainerLauncher) LaunchWithCustomVersion(
 		isCI,
 		cloudUserID,
 		cloudInstanceID,
+		imageAuthor,
 	)
 	if err != nil {
 		return nil, stacktrace.Propagate(err, "An error occurred creating the API container args")
@@ -119,7 +161,7 @@ func (launcher ApiContainerLauncher) LaunchWithCustomVersion(
 
 	containerImageAndTag := fmt.Sprintf(
 		"%v:%v",
-		containerImage,
+		imageAuthor+authorImageNameSeparator+containerImage,
 		imageVersionTag,
 	)
 

core/launcher/args/api_container_args.go

@@ -54,6 +54,10 @@ type APIContainerArgs struct {
 
 	// The Cloud Instance ID of the current user if available
 	CloudInstanceID metrics_client.CloudInstanceID `json:"cloud_instance_id"`
+
+	// The author of the image for the APIC, Engine and Files Artifact Expander
+	// In case someone is using a non Kurtosis published image
+	ImageAuthor string `json:"image_author"`
 }
 
 var skipValidation = map[string]bool{
@@ -110,6 +114,7 @@ func NewAPIContainerArgs(
 	isCI bool,
 	cloudUserID metrics_client.CloudUserID,
 	cloudInstanceID metrics_client.CloudInstanceID,
+	imageAuthor string,
 ) (*APIContainerArgs, error) {
 	result := &APIContainerArgs{
 		Version:                     version,
@@ -126,6 +131,7 @@ func NewAPIContainerArgs(
 		IsCI:                        isCI,
 		CloudUserID:                 cloudUserID,
 		CloudInstanceID:             cloudInstanceID,
+		ImageAuthor:                 imageAuthor,
 	}
 
 	if err := result.validate(); err != nil {

core/server/api_container/main.go

@@ -278,6 +278,7 @@ func createServiceNetwork(
 		ownIpAddress,
 		args.GrpcListenPortNum,
 		args.Version,
+		args.ImageAuthor,
 	)
 
 	serviceNetwork, err := service_network.NewDefaultServiceNetwork(

core/server/api_container/server/service_network/api_container_info.go

@@ -8,17 +8,21 @@ type ApiContainerInfo struct {
 	grpcPortNum uint16
 
 	version string
+
+	imageAuthor string
 }
 
 func NewApiContainerInfo(
 	ipAddress net.IP,
 	grpcPortNum uint16,
 	version string,
+	imageAuthor string,
 ) *ApiContainerInfo {
 	return &ApiContainerInfo{
 		ipAddress:   ipAddress,
 		grpcPortNum: grpcPortNum,
 		version:     version,
+		imageAuthor: imageAuthor,
 	}
 }
 
@@ -33,3 +37,7 @@ func (apic *ApiContainerInfo) GetGrpcPortNum() uint16 {
 func (apic *ApiContainerInfo) GetVersion() string {
 	return apic.version
 }
+
+func (apic *ApiContainerInfo) GetImageAuthor() string {
+	return apic.imageAuthor
+}

core/server/api_container/server/service_network/default_service_network_test.go

@@ -52,6 +52,7 @@ var (
 		testIpFromInt(0),
 		uint16(1234),
 		"0.0.0",
+		"kurtosistech",
 	)
 	unusedEnclaveDataDir *enclave_data_directory.EnclaveDataDirectory
 

core/server/api_container/server/startosis_engine/kurtosis_starlark_framework/test_engine/service_config_full_framework_backward_compatible_test.go

@@ -22,7 +22,7 @@ type serviceConfigFullTestCaseBackwardCompatible struct {
 
 func (suite *KurtosisTypeConstructorTestSuite) TestServiceConfigFullBackwardCompatible() {
 	suite.serviceNetwork.EXPECT().GetApiContainerInfo().Times(1).Return(
-		service_network.NewApiContainerInfo(net.IPv4(0, 0, 0, 0), 0, "0.0.0"),
+		service_network.NewApiContainerInfo(net.IPv4(0, 0, 0, 0), 0, "0.0.0", testImageAuthor),
 	)
 
 	suite.run(&serviceConfigFullTestCaseBackwardCompatible{

core/server/api_container/server/startosis_engine/kurtosis_starlark_framework/test_engine/service_config_full_framework_test.go

@@ -25,7 +25,7 @@ type serviceConfigFullTestCase struct {
 
 func (suite *KurtosisTypeConstructorTestSuite) TestServiceConfigFull() {
 	suite.serviceNetwork.EXPECT().GetApiContainerInfo().Times(1).Return(
-		service_network.NewApiContainerInfo(net.IPv4(0, 0, 0, 0), 0, "0.0.0"),
+		service_network.NewApiContainerInfo(net.IPv4(0, 0, 0, 0), 0, "0.0.0", testImageAuthor),
 	)
 
 	suite.run(&serviceConfigFullTestCase{

core/server/api_container/server/startosis_engine/kurtosis_starlark_framework/test_engine/service_config_multiple_files_in_same_folder_test.go

@@ -22,7 +22,7 @@ type serviceConfigMultipleFilesInSameFolderTestCase struct {
 func (suite *KurtosisTypeConstructorTestSuite) TestServiceConfigMultipleFilesInSameFolder() {
 
 	suite.serviceNetwork.EXPECT().GetApiContainerInfo().Times(1).Return(
-		service_network.NewApiContainerInfo(net.IPv4(0, 0, 0, 0), 0, "0.0.0"),
+		service_network.NewApiContainerInfo(net.IPv4(0, 0, 0, 0), 0, "0.0.0", testImageAuthor),
 	)
 
 	suite.run(&serviceConfigMultipleFilesInSameFolderTestCase{

core/server/api_container/server/startosis_engine/kurtosis_starlark_framework/test_engine/static_constants.go

@@ -151,4 +151,6 @@ var (
 	testTolerationSeconds = int64(64)
 
 	testFilesToBeMoved = "test.txt"
+
+	testImageAuthor = "kurtosistech"
 )