- Notifications
You must be signed in to change notification settings - Fork1k
feat(agent): wire up agentssh server to allow exec into container#16638
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
14 commits Select commitHold shift + click to select a range
36707f9 feat(agent): write up reconnectingpty server to container exec
johnstcn690e91c refactor: move SystemEnvInfo to usershell
johnstcn92130fe Apply suggestions from code review
johnstcn50f1c7f hide behind experimental flag
johnstcn46a6b7d simply naming of interface methods
johnstcn1eec238 make usershell tests external again
johnstcn0aae37f add experimental note
johnstcn6fffa6b mark usershell.HomeDir() as deprecated
johnstcn3127cba only log modified command at debug if changed
johnstcnf4c0eab clarify the why of ModifyCommand
johnstcnaafe13f rm unused runtime iotas
johnstcn12389d8 reduce diff size
johnstcn72d3ff1 purge container
johnstcn40a61fa add missing parameters for container and container_user
johnstcnFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
9 changes: 9 additions & 0 deletionsagent/agent.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -88,6 +88,8 @@ type Options struct { | ||
| BlockFileTransfer bool | ||
| Execer agentexec.Execer | ||
| ContainerLister agentcontainers.Lister | ||
| ExperimentalContainersEnabled bool | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| type Client interface { | ||
| @@ -188,6 +190,8 @@ func New(options Options) Agent { | ||
| metrics: newAgentMetrics(prometheusRegistry), | ||
| execer: options.Execer, | ||
| lister: options.ContainerLister, | ||
| experimentalDevcontainersEnabled: options.ExperimentalContainersEnabled, | ||
| } | ||
| // Initially, we have a closed channel, reflecting the fact that we are not initially connected. | ||
| // Each time we connect we replace the channel (while holding the closeMutex) with a new one | ||
| @@ -258,6 +262,8 @@ type agent struct { | ||
| metrics *agentMetrics | ||
| execer agentexec.Execer | ||
| lister agentcontainers.Lister | ||
| experimentalDevcontainersEnabled bool | ||
| } | ||
| func (a *agent) TailnetConn() *tailnet.Conn { | ||
| @@ -297,6 +303,9 @@ func (a *agent) init() { | ||
| a.sshServer, | ||
| a.metrics.connectionsTotal, a.metrics.reconnectingPTYErrors, | ||
| a.reconnectingPTYTimeout, | ||
| func(s *reconnectingpty.Server) { | ||
| s.ExperimentalContainersEnabled = a.experimentalDevcontainersEnabled | ||
| }, | ||
| ) | ||
| go a.runLoop() | ||
| } | ||
78 changes: 75 additions & 3 deletionsagent/agent_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
20 changes: 4 additions & 16 deletionsagent/agentcontainers/containers_dockercli.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -6,7 +6,6 @@ import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "os/user" | ||
| "slices" | ||
| "sort" | ||
| @@ -15,6 +14,7 @@ import ( | ||
| "time" | ||
| "github.com/coder/coder/v2/agent/agentexec" | ||
| "github.com/coder/coder/v2/agent/usershell" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| "golang.org/x/exp/maps" | ||
| @@ -37,6 +37,7 @@ func NewDocker(execer agentexec.Execer) Lister { | ||
| // DockerEnvInfoer is an implementation of agentssh.EnvInfoer that returns | ||
| // information about a container. | ||
| type DockerEnvInfoer struct { | ||
| usershell.SystemEnvInfo | ||
| container string | ||
| user *user.User | ||
| userShell string | ||
| @@ -122,26 +123,13 @@ func EnvInfo(ctx context.Context, execer agentexec.Execer, container, containerU | ||
| return &dei, nil | ||
| } | ||
| func (dei *DockerEnvInfoer)User() (*user.User, error) { | ||
| // Clone the user so that the caller can't modify it | ||
| u := *dei.user | ||
| return &u, nil | ||
| } | ||
Comment on lines -131 to -143 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. review: we now use the embedded | ||
| func (dei *DockerEnvInfoer) Shell(string) (string, error) { | ||
| return dei.userShell, nil | ||
| } | ||
6 changes: 3 additions & 3 deletionsagent/agentcontainers/containers_internal_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
66 changes: 19 additions & 47 deletionsagent/agentssh/agentssh.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -698,63 +698,24 @@ func (s *Server) sftpHandler(logger slog.Logger, session ssh.Session) { | ||
| _ = session.Exit(1) | ||
| } | ||
Comment on lines -701 to -739 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. review: moved to | ||
| // CreateCommand processes raw command input with OpenSSH-like behavior. | ||
| // If the script provided is empty, it will default to the users shell. | ||
| // This injects environment variables specified by the user at launch too. | ||
| // The final argument is an interface that allows the caller to provide | ||
| // alternative implementations for the dependencies of CreateCommand. | ||
| // This is useful when creating a command to be run in a separate environment | ||
| // (for example, a Docker container). Pass in nil to use the default. | ||
| func (s *Server) CreateCommand(ctx context.Context, script string, env []string,ei usershell.EnvInfoer) (*pty.Cmd, error) { | ||
| ifei == nil { | ||
| ei =&usershell.SystemEnvInfo{} | ||
| } | ||
| currentUser, err :=ei.User() | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("get current user: %w", err) | ||
| } | ||
| username := currentUser.Username | ||
| shell, err :=ei.Shell(username) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("get user shell: %w", err) | ||
| } | ||
| @@ -802,21 +763,32 @@ func (s *Server) CreateCommand(ctx context.Context, script string, env []string, | ||
| } | ||
| } | ||
| // Modify command prior to execution. This will usually be a no-op, but not | ||
| // always. For example, to run a command in a Docker container, we need to | ||
| // modify the command to be `docker exec -it <container> <command>`. | ||
| modifiedName, modifiedArgs := ei.ModifyCommand(name, args...) | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // Log if the command was modified. | ||
| if modifiedName != name && slices.Compare(modifiedArgs, args) != 0 { | ||
| s.logger.Debug(ctx, "modified command", | ||
| slog.F("before", append([]string{name}, args...)), | ||
| slog.F("after", append([]string{modifiedName}, modifiedArgs...)), | ||
| ) | ||
| } | ||
| cmd := s.Execer.PTYCommandContext(ctx, modifiedName, modifiedArgs...) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Didn't we also have a docker execer? Did we end up not implementing that change, and are only relying on env infoer now? Or are we modifying commands from multiple angles? If former, all good, if latter, I'm wondering if we could unify the concepts (perhaps infoer can be applied on the execer level or vice-versa). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. That's all in the envinfoer now. | ||
| cmd.Dir = s.config.WorkingDirectory() | ||
| // If the metadata directory doesn't exist, we run the command | ||
| // in the users home directory. | ||
| _, err = os.Stat(cmd.Dir) | ||
| if cmd.Dir == "" || err != nil { | ||
| // Default to user home if a directory is not set. | ||
| homedir, err :=ei.HomeDir() | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("get home dir: %w", err) | ||
| } | ||
| cmd.Dir = homedir | ||
| } | ||
| cmd.Env = append(ei.Environ(), env...) | ||
| cmd.Env = append(cmd.Env, fmt.Sprintf("USER=%s", username)) | ||
| // Set SSH connection environment variables (these are also set by OpenSSH | ||
10 changes: 7 additions & 3 deletionsagent/agentssh/agentssh_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.