mirror of https://github.com/docker/cli.git
Add `--format` to `docker service ps`
This fix tries to address the issue raised in 27189 where it is not possible to support configured formatting stored in config.json. Since `--format` was not supported in `docker service ps`, the flag `--format` has also been added in this fix. This fix 1. Add `--format` to `docker service ps` 2. Add `tasksFormat` to config.json 3. Add `--format` to `docker stack ps` 4. Add `--format` to `docker node ps` The related docs has been updated. An integration test has been added. This fix fixes 27189. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
This commit is contained in:
parent
8279870a1f
commit
1328bb4440
|
@ -22,10 +22,12 @@ Usage: docker node ps [OPTIONS] [NODE...]
|
||||||
List tasks running on one or more nodes, defaults to current node.
|
List tasks running on one or more nodes, defaults to current node.
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-f, --filter value Filter output based on conditions provided
|
-f, --filter filter Filter output based on conditions provided
|
||||||
|
--format string Pretty-print tasks using a Go template
|
||||||
--help Print usage
|
--help Print usage
|
||||||
--no-resolve Do not map IDs to Names
|
--no-resolve Do not map IDs to Names
|
||||||
--no-trunc Do not truncate output
|
--no-trunc Do not truncate output
|
||||||
|
-q, --quiet Only display task IDs
|
||||||
```
|
```
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
@ -105,6 +107,37 @@ redis.7.bg8c07zzg87di2mufeq51a2qp redis:3.0.6 swarm-manager1 Running R
|
||||||
The `desired-state` filter can take the values `running`, `shutdown`, and `accepted`.
|
The `desired-state` filter can take the values `running`, `shutdown`, and `accepted`.
|
||||||
|
|
||||||
|
|
||||||
|
### Formatting
|
||||||
|
|
||||||
|
The formatting options (`--format`) pretty-prints tasks output
|
||||||
|
using a Go template.
|
||||||
|
|
||||||
|
Valid placeholders for the Go template are listed below:
|
||||||
|
|
||||||
|
Placeholder | Description
|
||||||
|
----------------|------------------------------------------------------------------------------------------
|
||||||
|
`.Name` | Task name
|
||||||
|
`.Image` | Task image
|
||||||
|
`.Node` | Node ID
|
||||||
|
`.DesiredState` | Desired state of the task (`running`, `shutdown`, and `accepted`)
|
||||||
|
`.CurrentState` | Current state of the task
|
||||||
|
`.Error` | Error
|
||||||
|
`.Ports` | Task published ports
|
||||||
|
|
||||||
|
When using the `--format` option, the `node ps` command will either
|
||||||
|
output the data exactly as the template declares or, when using the
|
||||||
|
`table` directive, includes column headers as well.
|
||||||
|
|
||||||
|
The following example uses a template without headers and outputs the
|
||||||
|
`ID` and `Driver` entries separated by a colon for all tasks:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker node ps --format "{{.Name}}: {{.Image}}"
|
||||||
|
top.1: busybox
|
||||||
|
top.2: busybox
|
||||||
|
top.3: busybox
|
||||||
|
```
|
||||||
|
|
||||||
## Related commands
|
## Related commands
|
||||||
|
|
||||||
* [node demote](node_demote.md)
|
* [node demote](node_demote.md)
|
||||||
|
|
|
@ -23,6 +23,7 @@ List the tasks of one or more services
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-f, --filter filter Filter output based on conditions provided
|
-f, --filter filter Filter output based on conditions provided
|
||||||
|
--format string Pretty-print tasks using a Go template
|
||||||
--help Print usage
|
--help Print usage
|
||||||
--no-resolve Do not map IDs to Names
|
--no-resolve Do not map IDs to Names
|
||||||
--no-trunc Do not truncate output
|
--no-trunc Do not truncate output
|
||||||
|
@ -152,6 +153,38 @@ ID NAME IMAGE NODE DESIRED STATE CURRENT STATE
|
||||||
The `desired-state` filter can take the values `running`, `shutdown`, and `accepted`.
|
The `desired-state` filter can take the values `running`, `shutdown`, and `accepted`.
|
||||||
|
|
||||||
|
|
||||||
|
### Formatting
|
||||||
|
|
||||||
|
The formatting options (`--format`) pretty-prints tasks output
|
||||||
|
using a Go template.
|
||||||
|
|
||||||
|
Valid placeholders for the Go template are listed below:
|
||||||
|
|
||||||
|
Placeholder | Description
|
||||||
|
----------------|------------------------------------------------------------------------------------------
|
||||||
|
`.ID` | Task ID
|
||||||
|
`.Name` | Task name
|
||||||
|
`.Image` | Task image
|
||||||
|
`.Node` | Node ID
|
||||||
|
`.DesiredState` | Desired state of the task (`running`, `shutdown`, and `accepted`)
|
||||||
|
`.CurrentState` | Current state of the task
|
||||||
|
`.Error` | Error
|
||||||
|
`.Ports` | Task published ports
|
||||||
|
|
||||||
|
When using the `--format` option, the `service ps` command will either
|
||||||
|
output the data exactly as the template declares or, when using the
|
||||||
|
`table` directive, includes column headers as well.
|
||||||
|
|
||||||
|
The following example uses a template without headers and outputs the
|
||||||
|
`ID` and `Driver` entries separated by a colon for all tasks:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker service ps --format "{{.Name}}: {{.Image}}" top
|
||||||
|
top.1: busybox
|
||||||
|
top.2: busybox
|
||||||
|
top.3: busybox
|
||||||
|
```
|
||||||
|
|
||||||
## Related commands
|
## Related commands
|
||||||
|
|
||||||
* [service create](service_create.md)
|
* [service create](service_create.md)
|
||||||
|
|
|
@ -22,9 +22,11 @@ List the tasks in the stack
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-f, --filter filter Filter output based on conditions provided
|
-f, --filter filter Filter output based on conditions provided
|
||||||
|
--format string Pretty-print tasks using a Go template
|
||||||
--help Print usage
|
--help Print usage
|
||||||
--no-resolve Do not map IDs to Names
|
--no-resolve Do not map IDs to Names
|
||||||
--no-trunc Do not truncate output
|
--no-trunc Do not truncate output
|
||||||
|
-q, --quiet Only display task IDs
|
||||||
```
|
```
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
Loading…
Reference in New Issue