add client settings endpoint to the api

Author: real-danm

cmd/lk/agent.go

@@ -331,6 +331,10 @@ func createAgent(ctx context.Context, cmd *cli.Command) error {
 
 		logger.Debugw("using existing agent toml")
 	} else if !exists && !cmd.Bool("silent") {
+		if cmd.String("name") == "" {
+			return fmt.Errorf("name is required")
+		}
+
 		var createFile bool
 		form := huh.NewForm(
 			huh.NewGroup(
@@ -472,7 +476,17 @@ func createAgent(ctx context.Context, cmd *cli.Command) error {
 			return fmt.Errorf("dockerfile is required to create agent")
 		}
 
-		err = agentfs.CreateDockerfile(workingDir)
+		clientSettingsResponse, err := agentsClient.GetClientSettings(ctx, &lkproto.ClientSettingsRequest{})
+		if err != nil {
+			return err
+		}
+
+		settingsMap := make(map[string]string)
+		for _, setting := range clientSettingsResponse.Params {
+			settingsMap[setting.Name] = setting.Value
+		}
+
+		err = agentfs.CreateDockerfile(workingDir, settingsMap)
 		if err != nil {
 			return err
 		}

go.mod

@@ -14,8 +14,8 @@ require (
 	github.com/go-logr/logr v1.4.2
 	github.com/go-task/task/v3 v3.41.0
 	github.com/joho/godotenv v1.5.1
-	github.com/livekit/protocol v1.35.1-0.20250318183545-6398b13899ef
-	github.com/livekit/server-sdk-go/v2 v2.5.1-0.20250318183233-08dd3a3be254
+	github.com/livekit/protocol v1.35.1-0.20250318204333-4d4ff652a17d
+	github.com/livekit/server-sdk-go/v2 v2.5.1-0.20250318212316-91c09b0802df
 	github.com/moby/buildkit v0.20.1
 	github.com/pion/rtcp v1.2.15
 	github.com/pion/rtp v1.8.13

go.sum

@@ -262,10 +262,14 @@ github.com/livekit/mediatransportutil v0.0.0-20250310153736-45596af895b6 h1:6Zht
 github.com/livekit/mediatransportutil v0.0.0-20250310153736-45596af895b6/go.mod h1:36s+wwmU3O40IAhE+MjBWP3W71QRiEE9SfooSBvtBqY=
 github.com/livekit/protocol v1.35.1-0.20250318183545-6398b13899ef h1:ode6TNcDsOMa4NriI2uaRsP636Ck4u6Qtw/kX34lcUE=
 github.com/livekit/protocol v1.35.1-0.20250318183545-6398b13899ef/go.mod h1:WrT/CYRxtMNOVUjnIPm5OjWtEkmreffTeE1PRZwlRg4=
+github.com/livekit/protocol v1.35.1-0.20250318204333-4d4ff652a17d h1:ZfNCLWTqbOhTGl/Hpm27KXo9emfXU+ZKHqV6PjG/2B8=
+github.com/livekit/protocol v1.35.1-0.20250318204333-4d4ff652a17d/go.mod h1:WrT/CYRxtMNOVUjnIPm5OjWtEkmreffTeE1PRZwlRg4=
 github.com/livekit/psrpc v0.6.1-0.20250205181828-a0beed2e4126 h1:fzuYpAQbCid7ySPpQWWePfQOWUrs8x6dJ0T3Wl07n+Y=
 github.com/livekit/psrpc v0.6.1-0.20250205181828-a0beed2e4126/go.mod h1:X5WtEZ7OnEs72Fi5/J+i0on3964F1aynQpCalcgMqRo=
 github.com/livekit/server-sdk-go/v2 v2.5.1-0.20250318183233-08dd3a3be254 h1:PZQRohKe3BgpCOW5o4OASJwcM57PevH9fzDdRiZWbrk=
 github.com/livekit/server-sdk-go/v2 v2.5.1-0.20250318183233-08dd3a3be254/go.mod h1:eowx46iqkpz5YmUak7iwAW6jgc9Id5oH9Yc5U4UMvl8=
+github.com/livekit/server-sdk-go/v2 v2.5.1-0.20250318212316-91c09b0802df h1:/hG3IEbDxn0hFiVFi6m9MytZ40ufj6U4X2bEy7iaZ0c=
+github.com/livekit/server-sdk-go/v2 v2.5.1-0.20250318212316-91c09b0802df/go.mod h1:vLpNwytvvqrRXroOz6EjRNXmuKeJaKfTHPZjLE7xw7s=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
 github.com/magefile/mage v1.15.0 h1:BvGheCMAsG3bWUDbZ8AyXXpCNwU9u5CB6sM+HNb9HYg=

pkg/agentfs/docker.go

@@ -15,14 +15,6 @@ import (
 	"github.com/livekit/protocol/logger"
 )
 
-const (
-	pythonDockerfileURL   = "https://raw.githubusercontent.com/livekit-examples/agent-deployment/refs/heads/main/python-agent-example-app/Dockerfile"
-	pythonDockerIgnoreURL = "https://raw.githubusercontent.com/livekit-examples/agent-deployment/refs/heads/main/python-agent-example-app/.dockerignore"
-	pythonEntrypoint      = "main.py"
-	nodeDockerfileURL     = "https://raw.githubusercontent.com/livekit-examples/agent-deployment/refs/heads/main/node-agent-example-docker/Dockerfile"
-	nodeDockerIgnoreURL   = "https://raw.githubusercontent.com/livekit-examples/agent-deployment/refs/heads/main/node-agent-example-docker/.dockerignore"
-)
-
 func FindDockerfile(dir string) (bool, error) {
 	entries, err := os.ReadDir(dir)
 	if err != nil {
@@ -37,7 +29,11 @@ func FindDockerfile(dir string) (bool, error) {
 	return false, nil
 }
 
-func CreateDockerfile(dir string) error {
+func CreateDockerfile(dir string, settingsMap map[string]string) error {
+	if len(settingsMap) == 0 {
+		return fmt.Errorf("unable to fetch client settings from server, please try again later")
+	}
+
 	projectType := ""
 	if isNode(dir) {
 		projectType = "node"
@@ -52,27 +48,37 @@ func CreateDockerfile(dir string) error {
 	var err error
 	switch projectType {
 	case "python":
-		dockerfileContent, err = downloadFile(pythonDockerfileURL)
+		err = validateSettingsMap(settingsMap, []string{"python_docker_file", "python_docker_ignore"})
 		if err != nil {
 			return err
 		}
-		dockerIgnoreContent, err = downloadFile(pythonDockerIgnoreURL)
+		dockerfileContent, err = downloadFile(settingsMap["python_docker_file"])
+		if err != nil {
+			return err
+		}
+
+		dockerIgnoreContent, err = downloadFile(settingsMap["python_docker_ignore"])
 		if err != nil {
 			return err
 		}
 	case "node":
-		dockerfileContent, err = downloadFile(nodeDockerfileURL)
+		err = validateSettingsMap(settingsMap, []string{"node_docker_file", "node_docker_ignore"})
 		if err != nil {
 			return err
 		}
-		dockerIgnoreContent, err = downloadFile(nodeDockerIgnoreURL)
+
+		dockerfileContent, err = downloadFile(settingsMap["node_docker_file"])
+		if err != nil {
+			return err
+		}
+		dockerIgnoreContent, err = downloadFile(settingsMap["node_docker_ignore"])
 		if err != nil {
 			return err
 		}
 	}
 
 	if projectType == "python" {
-		dockerfileContent, err = validateEntrypoint(dir, dockerfileContent, projectType)
+		dockerfileContent, err = validateEntrypoint(dir, dockerfileContent, projectType, settingsMap)
 		if err != nil {
 			return err
 		}
@@ -110,7 +116,7 @@ func downloadFile(url string) ([]byte, error) {
 	return data, nil
 }
 
-func validateEntrypoint(dir string, dockerfileContent []byte, projectType string) ([]byte, error) {
+func validateEntrypoint(dir string, dockerfileContent []byte, projectType string, settingsMap map[string]string) ([]byte, error) {
 	fileList := make(map[string]bool)
 	entries, err := os.ReadDir(dir)
 	if err != nil {
@@ -168,6 +174,12 @@ func validateEntrypoint(dir string, dockerfileContent []byte, projectType string
 		return selected, nil
 	}
 
+	err = validateSettingsMap(settingsMap, []string{"python_entrypoint"})
+	if err != nil {
+		return nil, err
+	}
+
+	pythonEntrypoint := settingsMap["python_entrypoint"]
 	newEntrypoint, err := valFile(pythonEntrypoint)
 	if err != nil {
 		return nil, err

pkg/agentfs/utils.go

@@ -50,3 +50,12 @@ func ParseMem(mem string, suffix bool) (string, error) {
 	}
 	return fmt.Sprintf("%.2g", memGB), nil
 }
+
+func validateSettingsMap(settingsMap map[string]string, keys []string) error {
+	for _, key := range keys {
+		if _, ok := settingsMap[key]; !ok {
+			return fmt.Errorf("client setting %s is required, please try again later", key)
+		}
+	}
+	return nil
+}