diff options
author | Matthew Heon <matthew.heon@gmail.com> | 2018-04-11 13:09:41 -0400 |
---|---|---|
committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-04-13 18:43:44 +0000 |
commit | 5e03cec7ec83f8ff8b31a89a6180dda203b04d9c (patch) | |
tree | b32484a6c5d15f430fca12f07db974e354636ccc | |
parent | b8394600d855a88b38f01feeadf5a63e703183cd (diff) | |
download | podman-5e03cec7ec83f8ff8b31a89a6180dda203b04d9c.tar.gz podman-5e03cec7ec83f8ff8b31a89a6180dda203b04d9c.tar.bz2 podman-5e03cec7ec83f8ff8b31a89a6180dda203b04d9c.zip |
Changes to attach to enable per-stream attaching
This allows us to attach to attach to just stdout or stderr or
stdin, or any combination of these.
Signed-off-by: Matthew Heon <matthew.heon@gmail.com>
Closes: #608
Approved by: baude
-rw-r--r-- | cmd/podman/attach.go | 9 | ||||
-rw-r--r-- | cmd/podman/run.go | 39 | ||||
-rw-r--r-- | cmd/podman/start.go | 9 | ||||
-rw-r--r-- | cmd/podman/utils.go | 87 | ||||
-rw-r--r-- | libpod/container_api.go | 11 | ||||
-rw-r--r-- | libpod/container_attach.go | 71 |
6 files changed, 158 insertions, 68 deletions
diff --git a/cmd/podman/attach.go b/cmd/podman/attach.go index 20c1c306d..4b16d013c 100644 --- a/cmd/podman/attach.go +++ b/cmd/podman/attach.go @@ -1,6 +1,8 @@ package main import ( + "os" + "github.com/pkg/errors" "github.com/projectatomic/libpod/libpod" "github.com/urfave/cli" @@ -71,7 +73,12 @@ func attachCmd(c *cli.Context) error { ProxySignals(ctr) } - if err := ctr.Attach(c.Bool("no-stdin"), c.String("detach-keys")); err != nil { + inputStream := os.Stdin + if c.Bool("no-stdin") { + inputStream = nil + } + + if err := attachCtr(ctr, os.Stdout, os.Stderr, inputStream, c.String("detach-keys")); err != nil { return errors.Wrapf(err, "error attaching to container %s", ctr.ID()) } diff --git a/cmd/podman/run.go b/cmd/podman/run.go index 4966316c5..b8d6e0968 100644 --- a/cmd/podman/run.go +++ b/cmd/podman/run.go @@ -144,9 +144,42 @@ func runCmd(c *cli.Context) error { return nil } - // TODO: that "false" should probably be linked to -i - // Handle this when we split streams to allow attaching just stdin/out/err - attachChan, err := ctr.StartAndAttach(false, c.String("detach-keys")) + outputStream := os.Stdout + errorStream := os.Stderr + inputStream := os.Stdin + + // If -i is not set, clear stdin + if !c.Bool("interactive") { + inputStream = nil + } + + // If attach is set, clear stdin/stdout/stderr and only attach requested + if c.IsSet("attach") { + outputStream = nil + errorStream = nil + inputStream = nil + + attachTo := c.StringSlice("attach") + for _, stream := range attachTo { + switch strings.ToLower(stream) { + case "stdout": + outputStream = os.Stdout + case "stderr": + errorStream = os.Stderr + case "stdin": + inputStream = os.Stdin + default: + return errors.Wrapf(libpod.ErrInvalidArg, "invalid stream %q for --attach - must be one of stdin, stdout, or stderr", stream) + } + } + + // If --interactive is set, restore stdin + if c.Bool("interactive") { + inputStream = os.Stdin + } + } + + attachChan, err := startAttachCtr(ctr, outputStream, errorStream, inputStream, c.String("detach-keys")) if err != nil { // This means the command did not exist exitCode = 127 diff --git a/cmd/podman/start.go b/cmd/podman/start.go index 1a57a538b..14b03ac7c 100644 --- a/cmd/podman/start.go +++ b/cmd/podman/start.go @@ -95,7 +95,7 @@ func startCmd(c *cli.Context) error { if c.Bool("interactive") && !ctr.Config().Stdin { return errors.Errorf("the container was not created with the interactive option") } - noStdIn := c.Bool("interactive") + tty, err := strconv.ParseBool(ctr.Spec().Annotations["io.kubernetes.cri-o.TTY"]) if err != nil { return errors.Wrapf(err, "unable to parse annotations in %s", ctr.ID()) @@ -105,7 +105,12 @@ func startCmd(c *cli.Context) error { // We only get a terminal session if both a tty was specified in the spec and // -a on the command-line was given. if attach && tty { - attachChan, err := ctr.StartAndAttach(noStdIn, c.String("detach-keys")) + inputStream := os.Stdin + if !c.Bool("interactive") { + inputStream = nil + } + + attachChan, err := startAttachCtr(ctr, os.Stdout, os.Stderr, inputStream, c.String("detach-keys")) if err != nil { return errors.Wrapf(err, "unable to start container %s", ctr.ID()) } diff --git a/cmd/podman/utils.go b/cmd/podman/utils.go index 8b59e1344..502424403 100644 --- a/cmd/podman/utils.go +++ b/cmd/podman/utils.go @@ -1,9 +1,18 @@ package main import ( + "os" + gosignal "os/signal" + "github.com/containers/storage" + "github.com/docker/docker/pkg/signal" + "github.com/docker/docker/pkg/term" + "github.com/pkg/errors" "github.com/projectatomic/libpod/libpod" + "github.com/sirupsen/logrus" "github.com/urfave/cli" + "golang.org/x/crypto/ssh/terminal" + "k8s.io/client-go/tools/remotecommand" ) // Generate a new libpod runtime configured by command line options @@ -54,3 +63,81 @@ func getRuntime(c *cli.Context) (*libpod.Runtime, error) { return libpod.NewRuntime(options...) } + +// Attach to a container +func attachCtr(ctr *libpod.Container, stdout, stderr, stdin *os.File, detachKeys string) error { + resize := make(chan remotecommand.TerminalSize) + + haveTerminal := terminal.IsTerminal(int(os.Stdin.Fd())) + + // Check if we are attached to a terminal. If we are, generate resize + // events, and set the terminal to raw mode + if haveTerminal { + logrus.Debugf("Handling terminal attach") + + resizeTty(resize) + + oldTermState, err := term.SaveState(os.Stdin.Fd()) + if err != nil { + return errors.Wrapf(err, "unable to save terminal state") + } + + term.SetRawTerminal(os.Stdin.Fd()) + + defer term.RestoreTerminal(os.Stdin.Fd(), oldTermState) + } + + return ctr.Attach(stdout, stderr, stdin, detachKeys, resize) +} + +// Start and attach to a container +func startAttachCtr(ctr *libpod.Container, stdout, stderr, stdin *os.File, detachKeys string) (<-chan error, error) { + resize := make(chan remotecommand.TerminalSize) + + haveTerminal := terminal.IsTerminal(int(os.Stdin.Fd())) + + // Check if we are attached to a terminal. If we are, generate resize + // events, and set the terminal to raw mode + if haveTerminal && ctr.Spec().Process.Terminal { + logrus.Debugf("Handling terminal attach") + + resizeTty(resize) + + oldTermState, err := term.SaveState(os.Stdin.Fd()) + if err != nil { + return nil, errors.Wrapf(err, "unable to save terminal state") + } + + term.SetRawTerminal(os.Stdin.Fd()) + + defer term.RestoreTerminal(os.Stdin.Fd(), oldTermState) + } + + return ctr.StartAndAttach(stdout, stderr, stdin, detachKeys, resize) +} + +// Helper for prepareAttach - set up a goroutine to generate terminal resize events +func resizeTty(resize chan remotecommand.TerminalSize) { + sigchan := make(chan os.Signal, 1) + gosignal.Notify(sigchan, signal.SIGWINCH) + sendUpdate := func() { + winsize, err := term.GetWinsize(os.Stdin.Fd()) + if err != nil { + logrus.Warnf("Could not get terminal size %v", err) + return + } + resize <- remotecommand.TerminalSize{ + Width: winsize.Width, + Height: winsize.Height, + } + } + go func() { + defer close(resize) + // Update the terminal size immediately without waiting + // for a SIGWINCH to get the correct initial size. + sendUpdate() + for range sigchan { + sendUpdate() + } + }() +} diff --git a/libpod/container_api.go b/libpod/container_api.go index bfe20b184..fb6c70fd0 100644 --- a/libpod/container_api.go +++ b/libpod/container_api.go @@ -1,6 +1,7 @@ package libpod import ( + "io" "io/ioutil" "os" "strconv" @@ -14,6 +15,7 @@ import ( "github.com/projectatomic/libpod/pkg/inspect" "github.com/sirupsen/logrus" "k8s.io/apimachinery/pkg/util/wait" + "k8s.io/client-go/tools/remotecommand" ) // Init creates a container in the OCI runtime @@ -123,7 +125,7 @@ func (c *Container) Start() (err error) { // attach call. // The channel will be closed automatically after the result of attach has been // sent -func (c *Container) StartAndAttach(noStdin bool, keys string) (attachResChan <-chan error, err error) { +func (c *Container) StartAndAttach(outputStream, errorStream io.WriteCloser, inputStream io.Reader, keys string, resize <-chan remotecommand.TerminalSize) (attachResChan <-chan error, err error) { if !c.locked { c.lock.Lock() defer c.lock.Unlock() @@ -176,7 +178,7 @@ func (c *Container) StartAndAttach(noStdin bool, keys string) (attachResChan <-c // Attach to the container before starting it go func() { - if err := c.attach(noStdin, keys); err != nil { + if err := c.attach(outputStream, errorStream, inputStream, keys, resize); err != nil { attachChan <- err } close(attachChan) @@ -404,8 +406,7 @@ func (c *Container) Exec(tty, privileged bool, env, cmd []string, user string) e } // Attach attaches to a container -// Returns fully qualified URL of streaming server for the container -func (c *Container) Attach(noStdin bool, keys string) error { +func (c *Container) Attach(outputStream, errorStream io.WriteCloser, inputStream io.Reader, keys string, resize <-chan remotecommand.TerminalSize) error { if !c.locked { c.lock.Lock() if err := c.syncContainer(); err != nil { @@ -420,7 +421,7 @@ func (c *Container) Attach(noStdin bool, keys string) error { return errors.Wrapf(ErrCtrStateInvalid, "can only attach to created or running containers") } - return c.attach(noStdin, keys) + return c.attach(outputStream, errorStream, inputStream, keys, resize) } // Mount mounts a container's filesystem on the host diff --git a/libpod/container_attach.go b/libpod/container_attach.go index 40d359ddd..2e65755d9 100644 --- a/libpod/container_attach.go +++ b/libpod/container_attach.go @@ -5,16 +5,13 @@ import ( "io" "net" "os" - gosignal "os/signal" "path/filepath" - "github.com/docker/docker/pkg/signal" "github.com/docker/docker/pkg/term" "github.com/pkg/errors" "github.com/projectatomic/libpod/pkg/kubeutils" "github.com/projectatomic/libpod/utils" "github.com/sirupsen/logrus" - "golang.org/x/crypto/ssh/terminal" "golang.org/x/sys/unix" "k8s.io/client-go/tools/remotecommand" ) @@ -26,33 +23,19 @@ const ( AttachPipeStderr = 3 ) -// resizeTty handles TTY resizing for Attach() -func resizeTty(resize chan remotecommand.TerminalSize) { - sigchan := make(chan os.Signal, 1) - gosignal.Notify(sigchan, signal.SIGWINCH) - sendUpdate := func() { - winsize, err := term.GetWinsize(os.Stdin.Fd()) - if err != nil { - logrus.Warnf("Could not get terminal size %v", err) - return - } - resize <- remotecommand.TerminalSize{ - Width: winsize.Width, - Height: winsize.Height, - } +// Attach to the given container +// Does not check if state is appropriate +func (c *Container) attach(outputStream, errorStream io.WriteCloser, inputStream io.Reader, keys string, resize <-chan remotecommand.TerminalSize) error { + if outputStream == nil && errorStream == nil && inputStream == nil { + return errors.Wrapf(ErrInvalidArg, "must provide at least one stream to attach to") + } + + // Do not allow stdin on containers without Stdin set + // Conmon was not configured properly + if inputStream != nil && !c.config.Stdin { + return errors.Wrapf(ErrInvalidArg, "this container was not created as interactive, cannot attach stdin") } - go func() { - defer close(resize) - // Update the terminal size immediately without waiting - // for a SIGWINCH to get the correct initial size. - sendUpdate() - for range sigchan { - sendUpdate() - } - }() -} -func (c *Container) attach(noStdin bool, keys string) error { // Check the validity of the provided keys first var err error detachKeys := []byte{} @@ -63,40 +46,14 @@ func (c *Container) attach(noStdin bool, keys string) error { } } - // TODO: allow resize channel to be passed in for CRI-O use - resize := make(chan remotecommand.TerminalSize) - if terminal.IsTerminal(int(os.Stdin.Fd())) { - resizeTty(resize) - } else { - defer close(resize) - } - logrus.Debugf("Attaching to container %s", c.ID()) - return c.attachContainerSocket(resize, noStdin, detachKeys) + return c.attachContainerSocket(resize, detachKeys, outputStream, errorStream, inputStream) } // attachContainerSocket connects to the container's attach socket and deals with the IO // TODO add a channel to allow interruptiong -func (c *Container) attachContainerSocket(resize <-chan remotecommand.TerminalSize, noStdIn bool, detachKeys []byte) error { - inputStream := os.Stdin - outputStream := os.Stdout - errorStream := os.Stderr - defer inputStream.Close() - if terminal.IsTerminal(int(inputStream.Fd())) { - oldTermState, err := term.SaveState(inputStream.Fd()) - if err != nil { - return errors.Wrapf(err, "unable to save terminal state") - } - - defer term.RestoreTerminal(inputStream.Fd(), oldTermState) - } - - // Put both input and output into raw when we have a terminal - if !noStdIn && c.config.Spec.Process.Terminal { - term.SetRawTerminal(inputStream.Fd()) - } - +func (c *Container) attachContainerSocket(resize <-chan remotecommand.TerminalSize, detachKeys []byte, outputStream, errorStream io.WriteCloser, inputStream io.Reader) error { kubeutils.HandleResizing(resize, func(size remotecommand.TerminalSize) { controlPath := filepath.Join(c.bundlePath(), "ctl") controlFile, err := os.OpenFile(controlPath, unix.O_WRONLY, 0) @@ -129,7 +86,7 @@ func (c *Container) attachContainerSocket(resize <-chan remotecommand.TerminalSi stdinDone := make(chan error) go func() { var err error - if inputStream != nil && !noStdIn { + if inputStream != nil { _, err = utils.CopyDetachable(conn, inputStream, detachKeys) conn.CloseWrite() } |