Skip to content

docs(stack ps): describe table columns and task vs container ID #7182

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
locker95 wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −0
Open

docs(stack ps): describe table columns and task vs container ID #7182

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/reference/commandline/stack_ps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,21 @@ Lists the tasks that are running as part of the specified stack.
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
> documentation.

### Output columns

Default table columns:

| Column | Meaning |
| --- | --- |
| `ID` | Swarm **task** ID (not the container ID). Pass it to `docker inspect` or use `-q` to list task IDs only. The container ID for a running task is under the task's `Status.ContainerStatus.ContainerID` in `docker inspect <task-id>`. |
| `NAME` | Task name as `<stack>_<service>.<replica>`. The numeric suffix is the replica slot (for example `voting_redis.2` is replica 2 of the `redis` service in stack `voting`). |
| `IMAGE` | Image the task is running (digest shown with `--no-trunc`). |
| `NODE` | Node name (or node ID with `--no-resolve`) where the task is scheduled. |
| `DESIRED STATE` | State the orchestrator wants for the task (`Running`, `Shutdown`, and so on). |
| `CURRENT STATE` | Actual task state plus how long ago it entered that state. |
| `ERROR` | Failure message when the task did not start or stopped unexpectedly (often truncated unless `--no-trunc`). |
| `PORTS` | Published ports for the task, when applicable. |

## Examples

### List the tasks that are part of a stack
Expand Down