[Elastic Agent] Fix Docker container to allow state to properly be handled

x-pack/elastic-agent/CHANGELOG.next.asciidoc

@@ -77,3 +77,4 @@
 - Add TLS support for Fleet Server {pull}24142[24142]
 - Add support for Fleet Server running under Elastic Agent {pull}24220[24220]
 - Add CA support to Elastic Agent docker image {pull}24486[24486]
+- Add STATE_PATH to Elastic Agent docker image {pull}24817[24817]

x-pack/elastic-agent/pkg/agent/application/filters/stream_checker_test.go

@@ -249,7 +249,7 @@ func TestStreamCheck(t *testing.T) {
 		},
 	}
 
-	log, err := logger.New("")
+	log, err := logger.New("", false)
 	assert.NoError(t, err)
 
 	for _, tc := range testCases {

x-pack/elastic-agent/pkg/agent/application/fleet_server_bootstrap.go

@@ -56,7 +56,7 @@ func newFleetServerBootstrap(
 	}
 
 	if log == nil {
-		log, err = logger.NewFromConfig("", cfg.Settings.LoggingConfig)
+		log, err = logger.NewFromConfig("", cfg.Settings.LoggingConfig, false)
 		if err != nil {
 			return nil, err
 		}

x-pack/elastic-agent/pkg/agent/application/gateway/fleet/fleet_gateway_test.go

@@ -118,7 +118,7 @@ func withGateway(agentInfo agentInfo, settings *fleetGatewaySettings, fn withGat
 		client := newTestingClient()
 		dispatcher := newTestingDispatcher()
 
-		log, _ := logger.New("fleet_gateway")
+		log, _ := logger.New("fleet_gateway", false)
 		rep := getReporter(agentInfo, log, t)
 
 		ctx, cancel := context.WithCancel(context.Background())
@@ -252,7 +252,7 @@ func TestFleetGateway(t *testing.T) {
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
 
-		log, _ := logger.New("tst")
+		log, _ := logger.New("tst", false)
 		stateStore, err := store.NewStateStore(log, storage.NewDiskStore(paths.AgentStateStoreFile()))
 		require.NoError(t, err)
 
@@ -342,7 +342,7 @@ func TestFleetGateway(t *testing.T) {
 		dispatcher := newTestingDispatcher()
 
 		ctx, cancel := context.WithCancel(context.Background())
-		log, _ := logger.New("tst")
+		log, _ := logger.New("tst", false)
 
 		stateStore, err := store.NewStateStore(log, storage.NewDiskStore(paths.AgentStateStoreFile()))
 		require.NoError(t, err)

x-pack/elastic-agent/pkg/agent/application/local_mode.go

@@ -76,7 +76,7 @@ func newLocal(
 	}
 
 	if log == nil {
-		log, err = logger.NewFromConfig("", cfg.Settings.LoggingConfig)
+		log, err = logger.NewFromConfig("", cfg.Settings.LoggingConfig, true)
 		if err != nil {
 			return nil, err
 		}

x-pack/elastic-agent/pkg/agent/application/managed_mode_test.go

@@ -41,7 +41,7 @@ func TestManagedModeRouting(t *testing.T) {
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 
-	log, _ := logger.New("")
+	log, _ := logger.New("", false)
 	router, _ := router.New(log, streamFn)
 	agentInfo, _ := info.NewAgentInfo()
 	nullStore := &storage.NullStore{}

x-pack/elastic-agent/pkg/agent/application/paths/common.go

@@ -16,24 +16,33 @@ import (
 )
 
 const (
-	tempSubdir = "tmp"
+	// DefaultConfigName is the default name of the configuration file.
+	DefaultConfigName = "elastic-agent.yml"
+	// AgentLockFileName is the name of the overall Elastic Agent file lock.
+	AgentLockFileName = "agent.lock"
+	tempSubdir        = "tmp"
 )
 
 var (
-	topPath    string
-	configPath string
-	logsPath   string
-	tmpCreator sync.Once
+	topPath         string
+	configPath      string
+	configFilePath  string
+	logsPath        string
+	unversionedHome bool
+	tmpCreator      sync.Once
 )
 
 func init() {
 	topPath = initialTop()
 	configPath = topPath
 	logsPath = topPath
+	unversionedHome = false // only versioned by container subcommand
 
 	fs := flag.CommandLine
 	fs.StringVar(&topPath, "path.home", topPath, "Agent root path")
+	fs.BoolVar(&unversionedHome, "path.home.unversioned", unversionedHome, "Agent root path is versioned based on build")
 	fs.StringVar(&configPath, "path.config", configPath, "Config path is the directory Agent looks for its config file")
+	fs.StringVar(&configFilePath, "c", DefaultConfigName, "Configuration file, relative to path.config")
 	fs.StringVar(&logsPath, "path.logs", logsPath, "Logs path contains Agent log output")
 }
 
@@ -43,6 +52,14 @@ func Top() string {
 	return topPath
 }
 
+// SetTop overrides the Top path.
+//
+// Used by the container subcommand to adjust the overall top path allowing state can be maintained between container
+// restarts.
+func SetTop(path string) {
+	topPath = path
+}
+
 // TempDir returns agent temp dir located within data dir.
 func TempDir() string {
 	tmpDir := filepath.Join(Data(), tempSubdir)
@@ -55,14 +72,49 @@ func TempDir() string {
 
 // Home returns a directory where binary lives
 func Home() string {
+	if unversionedHome {
+		return topPath
+	}
 	return versionedHome(topPath)
 }
 
+// IsVersionHome returns true if the Home path is versioned based on build.
+func IsVersionHome() bool {
+	return !unversionedHome
+}
+
+// SetVersionHome sets if the Home path is versioned based on build.
+//
+// Used by the container subcommand to adjust the home path allowing state can be maintained between container
+// restarts.
+func SetVersionHome(version bool) {
+	unversionedHome = !version
+}
+
 // Config returns a directory where configuration file lives
 func Config() string {
 	return configPath
 }
 
+// SetConfig overrides the Config path.
+//
+// Used by the container subcommand to adjust the overall config path allowing state can be maintained between container
+// restarts.
+func SetConfig(path string) {
+	configPath = path
+}
+
+// ConfigFile returns the path to the configuration file.
+func ConfigFile() string {
+	if configFilePath == "" || configFilePath == DefaultConfigName {
+		return filepath.Join(Config(), DefaultConfigName)
+	}
+	if filepath.IsAbs(configFilePath) {
+		return configFilePath
+	}
+	return filepath.Join(Config(), configFilePath)
+}
+
 // Data returns the data directory for Agent
 func Data() string {
 	return filepath.Join(Top(), "data")
@@ -73,6 +125,11 @@ func Logs() string {
 	return logsPath
 }
 
+// SetLogs updates the path for the logs.
+func SetLogs(path string) {
+	logsPath = path
+}
+
 // initialTop returns the initial top-level path for the binary
 //
 // When nested in top-level/data/elastic-agent-${hash}/ the result is top-level/.

x-pack/elastic-agent/pkg/agent/application/pipeline/actions/handlers/handler_action_policy_change_test.go

@@ -34,7 +34,7 @@ func (m *mockEmitter) Emitter(policy *config.Config) error {
 }
 
 func TestPolicyChange(t *testing.T) {
-	log, _ := logger.New("")
+	log, _ := logger.New("", false)
 	ack := noopacker.NewAcker()
 	agentInfo, _ := info.NewAgentInfo()
 	nullStore := &storage.NullStore{}
@@ -89,7 +89,7 @@ func TestPolicyChange(t *testing.T) {
 }
 
 func TestPolicyAcked(t *testing.T) {
-	log, _ := logger.New("")
+	log, _ := logger.New("", false)
 	agentInfo, _ := info.NewAgentInfo()
 	nullStore := &storage.NullStore{}
 

x-pack/elastic-agent/pkg/agent/application/pipeline/dispatcher/dispatcher.go

@@ -31,7 +31,7 @@ type ActionDispatcher struct {
 func New(ctx context.Context, log *logger.Logger, def actions.Handler) (*ActionDispatcher, error) {
 	var err error
 	if log == nil {
-		log, err = logger.New("action_dispatcher")
+		log, err = logger.New("action_dispatcher", false)
 		if err != nil {
 			return nil, err
 		}

x-pack/elastic-agent/pkg/agent/application/pipeline/router/router.go

@@ -26,7 +26,7 @@ type router struct {
 func New(log *logger.Logger, factory pipeline.StreamFunc) (pipeline.Router, error) {
 	var err error
 	if log == nil {
-		log, err = logger.New("router")
+		log, err = logger.New("router", false)
 		if err != nil {
 			return nil, err
 		}

x-pack/elastic-agent/pkg/agent/application/upgrade/crash_checker_test.go

@@ -129,7 +129,7 @@ func TestChecker(t *testing.T) {
 
 func testableChecker(t *testing.T, pider *testPider) (*CrashChecker, chan error) {
 	errChan := make(chan error, 1)
-	l, _ := logger.New("")
+	l, _ := logger.New("", false)
 	ch, err := NewCrashChecker(context.Background(), errChan, l)
 	require.NoError(t, err)
 

x-pack/elastic-agent/pkg/agent/cmd/common.go

@@ -7,37 +7,16 @@ package cmd
 import (
 	"flag"
 	"os"
-	"path/filepath"
 
 	"github.com/spf13/cobra"
 
 	// import logp flags
 	_ "github.com/elastic/beats/v7/libbeat/logp/configure"
 
-	"github.com/elastic/beats/v7/x-pack/elastic-agent/pkg/agent/application/paths"
 	"github.com/elastic/beats/v7/x-pack/elastic-agent/pkg/basecmd"
 	"github.com/elastic/beats/v7/x-pack/elastic-agent/pkg/cli"
 )
 
-const (
-	defaultConfig     = "elastic-agent.yml"
-	hashLen           = 6
-	commitFile        = ".elastic-agent.active.commit"
-	agentLockFileName = "agent.lock"
-)
-
-type globalFlags struct {
-	PathConfigFile string
-}
-
-// Config returns path which identifies configuration file.
-func (f *globalFlags) Config() string {
-	if len(f.PathConfigFile) == 0 || f.PathConfigFile == defaultConfig {
-		return filepath.Join(paths.Config(), defaultConfig)
-	}
-	return f.PathConfigFile
-}
-
 // NewCommand returns the default command for the agent.
 func NewCommand() *cobra.Command {
 	return NewCommandWithArgs(os.Args, cli.NewIOStreams())
@@ -49,13 +28,13 @@ func NewCommandWithArgs(args []string, streams *cli.IOStreams) *cobra.Command {
 		Use: "elastic-agent [subcommand]",
 	}
 
-	flags := &globalFlags{}
-
 	// path flags
 	cmd.PersistentFlags().AddGoFlag(flag.CommandLine.Lookup("path.home"))
+	cmd.PersistentFlags().AddGoFlag(flag.CommandLine.Lookup("path.home.unversioned"))
+	cmd.PersistentFlags().MarkHidden("path.home.unversioned") // hidden used internally by container subcommand
 	cmd.PersistentFlags().AddGoFlag(flag.CommandLine.Lookup("path.config"))
+	cmd.PersistentFlags().AddGoFlag(flag.CommandLine.Lookup("c"))
 	cmd.PersistentFlags().AddGoFlag(flag.CommandLine.Lookup("path.logs"))
-	cmd.PersistentFlags().StringVarP(&flags.PathConfigFile, "c", "c", defaultConfig, `Configuration file, relative to path.config`)
 
 	// logging flags
 	cmd.PersistentFlags().AddGoFlag(flag.CommandLine.Lookup("v"))
@@ -64,19 +43,19 @@ func NewCommandWithArgs(args []string, streams *cli.IOStreams) *cobra.Command {
 	cmd.PersistentFlags().AddGoFlag(flag.CommandLine.Lookup("environment"))
 
 	// sub-commands
-	run := newRunCommandWithArgs(flags, args, streams)
+	run := newRunCommandWithArgs(args, streams)
 	cmd.AddCommand(basecmd.NewDefaultCommandsWithArgs(args, streams)...)
 	cmd.AddCommand(run)
-	cmd.AddCommand(newInstallCommandWithArgs(flags, args, streams))
-	cmd.AddCommand(newUninstallCommandWithArgs(flags, args, streams))
-	cmd.AddCommand(newUpgradeCommandWithArgs(flags, args, streams))
-	cmd.AddCommand(newEnrollCommandWithArgs(flags, args, streams))
-	cmd.AddCommand(newInspectCommandWithArgs(flags, args, streams))
-	cmd.AddCommand(newWatchCommandWithArgs(flags, args, streams))
-	cmd.AddCommand(newContainerCommand(flags, args, streams))
+	cmd.AddCommand(newInstallCommandWithArgs(args, streams))
+	cmd.AddCommand(newUninstallCommandWithArgs(args, streams))
+	cmd.AddCommand(newUpgradeCommandWithArgs(args, streams))
+	cmd.AddCommand(newEnrollCommandWithArgs(args, streams))
+	cmd.AddCommand(newInspectCommandWithArgs(args, streams))
+	cmd.AddCommand(newWatchCommandWithArgs(args, streams))
+	cmd.AddCommand(newContainerCommand(args, streams))
 
 	// windows special hidden sub-command (only added on windows)
-	reexec := newReExecWindowsCommand(flags, args, streams)
+	reexec := newReExecWindowsCommand(args, streams)
 	if reexec != nil {
 		cmd.AddCommand(reexec)
 	}