feat(compose/agent): add stack.agent.ports option in config.yml to publish ports for agent

go.mod

@@ -28,6 +28,7 @@ require (
 	github.com/jedib0t/go-pretty v4.3.0+incompatible
 	github.com/magefile/mage v1.15.0
 	github.com/mholt/archiver/v3 v3.5.1
+	github.com/mitchellh/mapstructure v1.5.0
 	github.com/olekukonko/tablewriter v0.0.5
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2
 	github.com/shirou/gopsutil/v3 v3.24.3
@@ -119,7 +120,6 @@ require (
 	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/go-wordwrap v1.0.1 // indirect
-	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/moby/spdystream v0.2.0 // indirect
 	github.com/moby/term v0.5.0 // indirect

internal/profile/_static/config.yml.example

@@ -18,3 +18,8 @@
 # Flag to enable logstash in elastic-package stack profile config
 # stack.logstash_enabled: true
 
+## Specify agent ports to publish
+## port definition schema https://docs.docker.com/compose/compose-file/compose-file-v2/#ports
+# stack.agent.ports:
+# - 127.0.0.1:1514:1514/udp
+

internal/profile/config.go

@@ -12,6 +12,8 @@ import (
 	"github.com/elastic/go-ucfg/yaml"
 
 	"github.com/elastic/elastic-package/internal/common"
+
+	"github.com/mitchellh/mapstructure"
 )
 
 type config struct {
@@ -48,3 +50,18 @@ func (c *config) get(name string) (string, bool) {
 		return fmt.Sprintf("%v", v), true
 	}
 }
+
+func (c *config) Decode(name string, out any) error {
+	v, err := c.settings.GetValue(name)
+	if err != nil {
+		if errors.Is(err, common.ErrKeyNotFound) {
+			return nil
+		}
+		return err
+	}
+	if err := mapstructure.Decode(v, out); err != nil {
+		return err
+	}
+
+	return nil
+}

internal/profile/profile.go

@@ -141,13 +141,13 @@ type Profile struct {
 }
 
 // Path returns an absolute path to the given file
-func (profile Profile) Path(names ...string) string {
+func (profile *Profile) Path(names ...string) string {
 	elems := append([]string{profile.ProfilePath}, names...)
 	return filepath.Join(elems...)
 }
 
 // Config returns a configuration setting, or its default if setting not found
-func (profile Profile) Config(name string, def string) string {
+func (profile *Profile) Config(name string, def string) string {
 	v, found := profile.overrides[name]
 	if found {
 		return v
@@ -161,6 +161,10 @@ func (profile Profile) Config(name string, def string) string {
 	return def
 }
 
+func (profile *Profile) Decode(name string, dst any) error {
+	return profile.config.Decode(name, dst)
+}
+
 // RuntimeOverrides defines configuration overrides for the current session.
 func (profile *Profile) RuntimeOverrides(overrides map[string]string) {
 	profile.overrides = overrides
@@ -171,7 +175,7 @@ var ErrNotAProfile = errors.New("not a profile")
 
 // ComposeEnvVars returns a list of environment variables that can be passed
 // to docker-compose for the sake of filling out paths and names in the snapshot.yml file.
-func (profile Profile) ComposeEnvVars() []string {
+func (profile *Profile) ComposeEnvVars() []string {
 	return []string{
 		fmt.Sprintf("PROFILE_NAME=%s", profile.ProfileName),
 	}

internal/stack/_static/docker-compose-stack.yml.tmpl

@@ -139,6 +139,7 @@ services:
       interval: 5s
     hostname: docker-fleet-agent
     env_file: "./elastic-agent.env"
+    ports: [{{ fact "agent_publish_ports" }}]
     volumes:
     - "../certs/ca-cert.pem:/etc/ssl/certs/elastic-package.pem"
     - type: bind

internal/stack/resources.go

@@ -134,6 +134,11 @@ var (
 func applyResources(profile *profile.Profile, stackVersion string) error {
 	stackDir := filepath.Join(profile.ProfilePath, ProfileStackPath)
 
+	var agentPorts []string
+	if err := profile.Decode("stack.agent.ports", &agentPorts); err != nil {
+		return fmt.Errorf("failed to unmarshal stack.agent.ports: %w", err)
+	}
+
 	resourceManager := resource.NewManager()
 	resourceManager.AddFacter(resource.StaticFacter{
 		"registry_base_image":   PackageRegistryBaseImage,
@@ -152,9 +157,12 @@ func applyResources(profile *profile.Profile, stackVersion string) error {
 		"geoip_dir":            profile.Config(configGeoIPDir, "./ingest-geoip"),
 		"logstash_enabled":     profile.Config(configLogstashEnabled, "false"),
 		"self_monitor_enabled": profile.Config(configSelfMonitorEnabled, "false"),
+		"agent_publish_ports":  strings.Join(agentPorts, ","),
 	})
 
-	os.MkdirAll(stackDir, 0755)
+	if err := os.MkdirAll(stackDir, 0755); err != nil {
+		return fmt.Errorf("failed to create stack directory: %w", err)
+	}
 	resourceManager.RegisterProvider("file", &resource.FileProvider{
 		Prefix: stackDir,
 	})