Merge pull request moby#24816 from stevvooe/service-ps-over-tasks

cli: `docker service|node|stack ps` instead of tasks

api/client/node/cmd.go

@@ -28,7 +28,7 @@ func NewNodeCommand(dockerCli *client.DockerCli) *cobra.Command {
 		newListCommand(dockerCli),
 		newPromoteCommand(dockerCli),
 		newRemoveCommand(dockerCli),
-		newTasksCommand(dockerCli),
+		newPSCommand(dockerCli),
 		newUpdateCommand(dockerCli),
 	)
 	return cmd

api/client/node/tasks.go → api/client/node/ps.go

@@ -12,22 +12,22 @@ import (
 	"github.com/spf13/cobra"
 )
 
-type tasksOptions struct {
+type psOptions struct {
 	nodeID    string
 	noResolve bool
 	filter    opts.FilterOpt
 }
 
-func newTasksCommand(dockerCli *client.DockerCli) *cobra.Command {
-	opts := tasksOptions{filter: opts.NewFilterOpt()}
+func newPSCommand(dockerCli *client.DockerCli) *cobra.Command {
+	opts := psOptions{filter: opts.NewFilterOpt()}
 
 	cmd := &cobra.Command{
-		Use:   "tasks [OPTIONS] self|NODE",
+		Use:   "ps [OPTIONS] self|NODE",
 		Short: "List tasks running on a node",
 		Args:  cli.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			opts.nodeID = args[0]
-			return runTasks(dockerCli, opts)
+			return runPS(dockerCli, opts)
 		},
 	}
 	flags := cmd.Flags()
@@ -37,7 +37,7 @@ func newTasksCommand(dockerCli *client.DockerCli) *cobra.Command {
 	return cmd
 }
 
-func runTasks(dockerCli *client.DockerCli, opts tasksOptions) error {
+func runPS(dockerCli *client.DockerCli, opts psOptions) error {
 	client := dockerCli.Client()
 	ctx := context.Background()
 

api/client/service/cmd.go

@@ -22,7 +22,7 @@ func NewServiceCommand(dockerCli *client.DockerCli) *cobra.Command {
 	cmd.AddCommand(
 		newCreateCommand(dockerCli),
 		newInspectCommand(dockerCli),
-		newTasksCommand(dockerCli),
+		newPSCommand(dockerCli),
 		newListCommand(dockerCli),
 		newRemoveCommand(dockerCli),
 		newScaleCommand(dockerCli),

api/client/service/tasks.go → api/client/service/ps.go

@@ -13,22 +13,22 @@ import (
 	"github.com/spf13/cobra"
 )
 
-type tasksOptions struct {
+type psOptions struct {
 	serviceID string
 	noResolve bool
 	filter    opts.FilterOpt
 }
 
-func newTasksCommand(dockerCli *client.DockerCli) *cobra.Command {
-	opts := tasksOptions{filter: opts.NewFilterOpt()}
+func newPSCommand(dockerCli *client.DockerCli) *cobra.Command {
+	opts := psOptions{filter: opts.NewFilterOpt()}
 
 	cmd := &cobra.Command{
-		Use:   "tasks [OPTIONS] SERVICE",
+		Use:   "ps [OPTIONS] SERVICE",
 		Short: "List the tasks of a service",
 		Args:  cli.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			opts.serviceID = args[0]
-			return runTasks(dockerCli, opts)
+			return runPS(dockerCli, opts)
 		},
 	}
 	flags := cmd.Flags()
@@ -38,7 +38,7 @@ func newTasksCommand(dockerCli *client.DockerCli) *cobra.Command {
 	return cmd
 }
 
-func runTasks(dockerCli *client.DockerCli, opts tasksOptions) error {
+func runPS(dockerCli *client.DockerCli, opts psOptions) error {
 	client := dockerCli.Client()
 	ctx := context.Background()
 

api/client/stack/cmd.go

@@ -25,7 +25,7 @@ func NewStackCommand(dockerCli *client.DockerCli) *cobra.Command {
 		newDeployCommand(dockerCli),
 		newRemoveCommand(dockerCli),
 		newServicesCommand(dockerCli),
-		newTasksCommand(dockerCli),
+		newPSCommand(dockerCli),
 	)
 	return cmd
 }

api/client/stack/tasks.go → api/client/stack/ps.go

@@ -17,23 +17,23 @@ import (
 	"github.com/spf13/cobra"
 )
 
-type tasksOptions struct {
+type psOptions struct {
 	all       bool
 	filter    opts.FilterOpt
 	namespace string
 	noResolve bool
 }
 
-func newTasksCommand(dockerCli *client.DockerCli) *cobra.Command {
-	opts := tasksOptions{filter: opts.NewFilterOpt()}
+func newPSCommand(dockerCli *client.DockerCli) *cobra.Command {
+	opts := psOptions{filter: opts.NewFilterOpt()}
 
 	cmd := &cobra.Command{
-		Use:   "tasks [OPTIONS] STACK",
+		Use:   "ps [OPTIONS] STACK",
 		Short: "List the tasks in the stack",
 		Args:  cli.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			opts.namespace = args[0]
-			return runTasks(dockerCli, opts)
+			return runPS(dockerCli, opts)
 		},
 	}
 	flags := cmd.Flags()
@@ -44,7 +44,7 @@ func newTasksCommand(dockerCli *client.DockerCli) *cobra.Command {
 	return cmd
 }
 
-func runTasks(dockerCli *client.DockerCli, opts tasksOptions) error {
+func runPS(dockerCli *client.DockerCli, opts psOptions) error {
 	namespace := opts.namespace
 	client := dockerCli.Client()
 	ctx := context.Background()

contrib/completion/bash/docker

@@ -1573,7 +1573,7 @@ _docker_service() {
 		ls list
 		rm remove
 		scale
-		tasks
+		ps
 		update
 	"
 	__docker_subcommands "$subcommands" && return
@@ -1667,7 +1667,7 @@ _docker_service_scale() {
 	esac
 }
 
-_docker_service_tasks() {
+_docker_service_ps() {
 	local key=$(__docker_map_key_of_current_option '--filter|-f')
 	case "$key" in
 		desired-state)
@@ -1929,7 +1929,7 @@ _docker_node() {
 		ls list
 		promote
 		rm remove
-		tasks
+		ps
 		update
 	"
 	__docker_subcommands "$subcommands" && return
@@ -2026,7 +2026,7 @@ _docker_node_rm() {
 	esac
 }
 
-_docker_node_tasks() {
+_docker_node_ps() {
 	local key=$(__docker_map_key_of_current_option '--filter|-f')
 	case "$key" in
 		desired-state)

contrib/completion/zsh/_docker

@@ -683,7 +683,7 @@ __docker_node_complete_ls_filters() {
     return ret
 }
 
-__docker_node_complete_tasks_filters() {
+__docker_node_complete_ps_filters() {
     [[ $PREFIX = -* ]] && return 1
     integer ret=1
 
@@ -787,7 +787,7 @@ __docker_node_commands() {
         "ls:List nodes in the swarm"
         "promote:Promote a node as manager in the swarm"
         "rm:Remove a node from the swarm"
-        "tasks:List tasks running on a node"
+        "ps:List tasks running on a node"
         "update:Update a node"
     )
     _describe -t docker-node-commands "docker node command" _docker_node_subcommands
@@ -834,7 +834,7 @@ __docker_node_subcommand() {
                 $opts_help \
                 "($help -)*:node:__docker_complete_worker_nodes" && ret=0
             ;;
-        (tasks)
+        (ps)
             _arguments $(__docker_arguments) \
                 $opts_help \
                 "($help -a --all)"{-a,--all}"[Display all instances]" \
@@ -843,7 +843,7 @@ __docker_node_subcommand() {
                 "($help -)1:node:__docker_complete_nodes" && ret=0
             case $state in
                 (filter-options)
-                    __docker_node_complete_tasks_filters && ret=0
+                    __docker_node_complete_ps_filters && ret=0
                     ;;
             esac
             ;;
@@ -970,7 +970,7 @@ __docker_service_complete_ls_filters() {
     return ret
 }
 
-__docker_service_complete_tasks_filters() {
+__docker_service_complete_ps_filters() {
     [[ $PREFIX = -* ]] && return 1
     integer ret=1
 
@@ -1060,7 +1060,7 @@ __docker_service_commands() {
         "ls:List services"
         "rm:Remove a service"
         "scale:Scale one or multiple services"
-        "tasks:List the tasks of a service"
+        "ps:List the tasks of a service"
         "update:Update a service"
     )
     _describe -t docker-service-commands "docker service command" _docker_service_subcommands
@@ -1148,7 +1148,7 @@ __docker_service_subcommand() {
                     ;;
             esac
             ;;
-        (tasks)
+        (ps)
             _arguments $(__docker_arguments) \
                 $opts_help \
                 "($help -a --all)"{-a,--all}"[Display all tasks]" \
@@ -1157,7 +1157,7 @@ __docker_service_subcommand() {
                 "($help -)1:service:__docker_complete_services" && ret=0
             case $state in
                 (filter-options)
-                    __docker_service_complete_tasks_filters && ret=0
+                    __docker_service_complete_ps_filters && ret=0
                     ;;
             esac
             ;;

docs/reference/commandline/index.md

@@ -115,7 +115,7 @@ read the [`dockerd`](dockerd.md) reference page.
 | [node demote](node_demote.md) | Demotes an existing manager so that it is no longer a manager |
 | [node inspect](node_inspect.md) | Inspect a node in the swarm                |
 | [node update](node_update.md) | Update attributes for a node                 |
-| [node tasks](node_tasks.md) | List tasks running on a node                   |
+| [node ps](node_ps.md) | List tasks running on a node                   |
 | [node ls](node_ls.md) | List nodes in the swarm                              |
 | [node rm](node_rm.md) | Remove a node from the swarm                         |
 
@@ -138,5 +138,5 @@ read the [`dockerd`](dockerd.md) reference page.
 | [service ls](service_ls.md) | List services in the swarm                     |
 | [service rm](service_rm.md) | Reemove a swervice from the swarm              |
 | [service scale](service_scale.md) | Set the number of replicas for the desired state of the service |
-| [service tasks](service_tasks.md) | List the tasks of a service              |
+| [service ps](service_ps.md) | List the tasks of a service              |
 | [service update](service_update.md)  | Update the attributes of a service    |

docs/reference/commandline/node_inspect.md

@@ -120,6 +120,6 @@ Example output:
 ## Related information
 
 * [node update](node_update.md)
-* [node tasks](node_tasks.md)
+* [node ps](node_ps.md)
 * [node ls](node_ls.md)
 * [node rm](node_rm.md)

docs/reference/commandline/node_ls.md

@@ -91,5 +91,5 @@ ID                         HOSTNAME       STATUS  AVAILABILITY  MANAGER STATUS
 
 * [node inspect](node_inspect.md)
 * [node update](node_update.md)
-* [node tasks](node_tasks.md)
+* [node ps](node_ps.md)
 * [node rm](node_rm.md)

docs/reference/commandline/node_tasks.md → docs/reference/commandline/node_ps.md

@@ -1,17 +1,18 @@
 <!--[metadata]>
 +++
-title = "node tasks"
-description = "The node tasks command description and usage"
-keywords = ["node, tasks"]
+title = "node ps"
+description = "The node ps command description and usage"
+keywords = ["node, tasks", "ps"]
+aliases = ["/engine/reference/commandline/node_tasks/"]
 [menu.main]
 parent = "smn_cli"
 +++
 <![end-metadata]-->
 
-# node tasks
+# node ps
 
 ```markdown
-Usage:  docker node tasks [OPTIONS] self|NODE
+Usage:  docker node ps [OPTIONS] self|NODE
 
 List tasks running on a node
 
@@ -26,7 +27,7 @@ Lists all the tasks on a Node that Docker knows about. You can filter using the
 
 Example output:
 
-    $ docker node tasks swarm-manager1
+    $ docker node ps swarm-manager1
     ID                         NAME      SERVICE  IMAGE        LAST STATE          DESIRED STATE  NODE
     7q92v0nr1hcgts2amcjyqg3pq  redis.1   redis    redis:3.0.6  Running 5 hours     Running        swarm-manager1
     b465edgho06e318egmgjbqo4o  redis.6   redis    redis:3.0.6  Running 29 seconds  Running        swarm-manager1
@@ -53,7 +54,7 @@ The `name` filter matches on all or part of a task's name.
 
 The following filter matches all tasks with a name containing the `redis` string.
 
-    $ docker node tasks -f name=redis swarm-manager1
+    $ docker node ps -f name=redis swarm-manager1
     ID                         NAME      SERVICE  IMAGE        LAST STATE          DESIRED STATE  NODE
     7q92v0nr1hcgts2amcjyqg3pq  redis.1   redis    redis:3.0.6  Running 5 hours     Running        swarm-manager1
     b465edgho06e318egmgjbqo4o  redis.6   redis    redis:3.0.6  Running 29 seconds  Running        swarm-manager1
@@ -66,7 +67,7 @@ The following filter matches all tasks with a name containing the `redis` string
 
 The `id` filter matches a task's id.
 
-    $ docker node tasks -f id=bg8c07zzg87di2mufeq51a2qp swarm-manager1
+    $ docker node ps -f id=bg8c07zzg87di2mufeq51a2qp swarm-manager1
     ID                         NAME      SERVICE  IMAGE        LAST STATE             DESIRED STATE  NODE
     bg8c07zzg87di2mufeq51a2qp  redis.7   redis    redis:3.0.6  Running 5 seconds      Running        swarm-manager1
 
@@ -79,7 +80,7 @@ value.
 The following filter matches tasks with the `usage` label regardless of its value.
 
 ```bash
-$ docker node tasks -f "label=usage"
+$ docker node ps -f "label=usage"
 ID                         NAME     SERVICE  IMAGE        LAST STATE          DESIRED STATE  NODE
 b465edgho06e318egmgjbqo4o  redis.6  redis    redis:3.0.6  Running 10 minutes  Running        swarm-manager1
 bg8c07zzg87di2mufeq51a2qp  redis.7  redis    redis:3.0.6  Running 9 minutes   Running        swarm-manager1

docs/reference/commandline/node_rm.md

@@ -35,5 +35,5 @@ Example output:
 
 * [node inspect](node_inspect.md)
 * [node update](node_update.md)
-* [node tasks](node_tasks.md)
+* [node ps](node_ps.md)
 * [node ls](node_ls.md)

docs/reference/commandline/node_update.md

@@ -59,6 +59,6 @@ metadata](../../userguide/labels-custom-metadata.md).
 ## Related information
 
 * [node inspect](node_inspect.md)
-* [node tasks](node_tasks.md)
+* [node ps](node_ps.md)
 * [node ls](node_ls.md)
 * [node rm](node_rm.md)

docs/reference/commandline/service_create.md

@@ -183,5 +183,5 @@ $ docker service create \
 * [service ls](service_ls.md)
 * [service rm](service_rm.md)
 * [service scale](service_scale.md)
-* [service tasks](service_tasks.md)
+* [service ps](service_ps.md)
 * [service update](service_update.md)

docs/reference/commandline/service_inspect.md

@@ -149,5 +149,5 @@ $ docker service inspect --format='{{.Spec.Mode.Replicated.Replicas}}' redis
 * [service ls](service_ls.md)
 * [service rm](service_rm.md)
 * [service scale](service_scale.md)
-* [service tasks](service_tasks.md)
+* [service ps](service_ps.md)
 * [service update](service_update.md)

docs/reference/commandline/service_ls.md

@@ -104,5 +104,5 @@ ID            NAME   REPLICAS  IMAGE        COMMAND
 * [service inspect](service_inspect.md)
 * [service rm](service_rm.md)
 * [service scale](service_scale.md)
-* [service tasks](service_tasks.md)
+* [service ps](service_ps.md)
 * [service update](service_update.md)