Add documentation on kpod attach
Add a man page on how to achieve the same user experience as using kpod attach by using either the kpod logs or kpod exec commands. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
This commit is contained in:
parent
8c9fcfce0d
commit
df5110dfd5
4 changed files with 37 additions and 3 deletions
31
docs/kpod-attach.1.md
Normal file
31
docs/kpod-attach.1.md
Normal file
|
@ -0,0 +1,31 @@
|
|||
% kpod(1) kpod-attach - See the output of pid 1 of a container or enter the container
|
||||
% Dan Walsh
|
||||
# kpod-attach "1" "September 2017" "kpod"
|
||||
|
||||
## NAME
|
||||
kpod-attach - Attach to a running container
|
||||
|
||||
## Description
|
||||
|
||||
We chose not to implement the `attach` feature in `kpod` even though the upstream Docker
|
||||
project has it. The upstream project has had lots of issues with attaching to running
|
||||
processes that we did not want to replicate. The `kpod exec` and `kpod log` commands
|
||||
offer you the same functionality far more dependably.
|
||||
|
||||
**Reasons to attach to the primary PID of a container:**
|
||||
|
||||
|
||||
1) Executing commands inside of the container
|
||||
|
||||
We recommend that you use `kpod exec` to execute a command within a container
|
||||
|
||||
`kpod exec CONTAINERID /bin/sh`
|
||||
|
||||
2) Viewing the output stream of the primary process in the container
|
||||
|
||||
We recommend that you use `kpod logs` to see the output from the container
|
||||
|
||||
`kpod logs CONTAINERID`
|
||||
|
||||
## SEE ALSO
|
||||
kpod(1), kpod-exec(1), kpod-logs(1)
|
|
@ -6,7 +6,7 @@
|
|||
kpod-cp - Copy files/folders between a container and the local filesystem.
|
||||
|
||||
## Description
|
||||
We chose not to implement this feature in kpod even though the upstream docker
|
||||
We chose not to implement the `cp` feature in `kpod` even though the upstream Docker
|
||||
project has it. We have a much stronger capability. Using standard kpod-mount
|
||||
and kpod-umount, we can take advantage of the entire linux tool chain, rather
|
||||
then just cp.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue