From 2f736927a0faae8405c96fcc2b6d6f60e2464e94 Mon Sep 17 00:00:00 2001 From: Stephen J Day Date: Tue, 19 Jul 2016 14:01:31 -0700 Subject: [PATCH] cli: `docker service|node|stack ps` instead of tasks Rather than conflict with the unexposed task model, change the names of the object-oriented task display to `docker ps`. The command works identically to `docker service tasks`. This change is superficial. This provides a more sensical docker experience while not trampling on the task model that may be introduced as a top-level command at a later date. The following is an example of the display using `docker service ps` with a service named `condescending_cori`: ``` $ docker service ps condescending_cori ID NAME SERVICE IMAGE LAST STATE DESIRED STATE NODE e2cd9vqb62qjk38lw65uoffd2 condescending_cori.1 condescending_cori alpine Running 13 minutes ago Running 6c6d232a5d0e ``` The following shows the output for the node on which the command is running: ```console $ docker node ps self ID NAME SERVICE IMAGE LAST STATE DESIRED STATE NODE b1tpbi43k1ibevg2e94bmqo0s mad_kalam.1 mad_kalam apline Accepted 2 seconds ago Accepted 6c6d232a5d0e e2cd9vqb62qjk38lw65uoffd2 condescending_cori.1 condescending_cori alpine Running 12 minutes ago Running 6c6d232a5d0e 4x609m5o0qyn0kgpzvf0ad8x5 furious_davinci.1 furious_davinci redis Running 32 minutes ago Running 6c6d232a5d0e ``` Signed-off-by: Stephen J Day (cherry picked from commit 0aa4e1e68973ede0c73f8a4356e2a17fc903f549) --- api/client/node/cmd.go | 2 +- api/client/node/{tasks.go => ps.go} | 12 ++++---- api/client/service/cmd.go | 2 +- api/client/service/{tasks.go => ps.go} | 12 ++++---- api/client/stack/cmd.go | 2 +- api/client/stack/{tasks.go => ps.go} | 12 ++++---- contrib/completion/bash/docker | 8 +++--- contrib/completion/zsh/_docker | 16 +++++------ docs/reference/commandline/index.md | 4 +-- docs/reference/commandline/node_inspect.md | 2 +- docs/reference/commandline/node_ls.md | 2 +- .../commandline/{node_tasks.md => node_ps.md} | 19 +++++++------ docs/reference/commandline/node_rm.md | 2 +- docs/reference/commandline/node_update.md | 2 +- docs/reference/commandline/service_create.md | 2 +- docs/reference/commandline/service_inspect.md | 2 +- docs/reference/commandline/service_ls.md | 2 +- .../{service_tasks.md => service_ps.md} | 17 +++++------ docs/reference/commandline/service_rm.md | 2 +- docs/reference/commandline/service_scale.md | 2 +- docs/reference/commandline/service_update.md | 2 +- docs/swarm/index.md | 2 +- docs/swarm/swarm-tutorial/drain-node.md | 8 +++--- docs/swarm/swarm-tutorial/inspect-service.md | 4 +-- docs/swarm/swarm-tutorial/rolling-update.md | 28 +++++++++++++++++-- docs/swarm/swarm-tutorial/scale-service.md | 6 ++-- integration-cli/docker_cli_stack_test.go | 2 +- integration-cli/docker_cli_swarm_test.go | 4 +-- 28 files changed, 103 insertions(+), 77 deletions(-) rename api/client/node/{tasks.go => ps.go} (81%) rename api/client/service/{tasks.go => ps.go} (84%) rename api/client/stack/{tasks.go => ps.go} (84%) rename docs/reference/commandline/{node_tasks.md => node_ps.md} (89%) rename docs/reference/commandline/{service_tasks.md => service_ps.md} (90%) diff --git a/api/client/node/cmd.go b/api/client/node/cmd.go index f79ea0231c..bf17819c58 100644 --- a/api/client/node/cmd.go +++ b/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 diff --git a/api/client/node/tasks.go b/api/client/node/ps.go similarity index 81% rename from api/client/node/tasks.go rename to api/client/node/ps.go index 27452972a0..12e8b8d9d0 100644 --- a/api/client/node/tasks.go +++ b/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() diff --git a/api/client/service/cmd.go b/api/client/service/cmd.go index 87c4a3e098..27ed30b946 100644 --- a/api/client/service/cmd.go +++ b/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), diff --git a/api/client/service/tasks.go b/api/client/service/ps.go similarity index 84% rename from api/client/service/tasks.go rename to api/client/service/ps.go index 565c3d4f7e..01df5a8139 100644 --- a/api/client/service/tasks.go +++ b/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() diff --git a/api/client/stack/cmd.go b/api/client/stack/cmd.go index 82a7a1ffa6..cf247b474f 100644 --- a/api/client/stack/cmd.go +++ b/api/client/stack/cmd.go @@ -24,7 +24,7 @@ func NewStackCommand(dockerCli *client.DockerCli) *cobra.Command { newConfigCommand(dockerCli), newDeployCommand(dockerCli), newRemoveCommand(dockerCli), - newTasksCommand(dockerCli), + newPSCommand(dockerCli), ) return cmd } diff --git a/api/client/stack/tasks.go b/api/client/stack/ps.go similarity index 84% rename from api/client/stack/tasks.go rename to api/client/stack/ps.go index e4d0d8bd41..2571529b46 100644 --- a/api/client/stack/tasks.go +++ b/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() diff --git a/contrib/completion/bash/docker b/contrib/completion/bash/docker index afa11ccfc2..764c10ba4b 100644 --- a/contrib/completion/bash/docker +++ b/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) @@ -1941,7 +1941,7 @@ _docker_node() { ls list promote rm remove - tasks + ps update " __docker_subcommands "$subcommands" && return @@ -2038,7 +2038,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) diff --git a/contrib/completion/zsh/_docker b/contrib/completion/zsh/_docker index 455059169c..408a8f3a34 100644 --- a/contrib/completion/zsh/_docker +++ b/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 @@ -788,7 +788,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 @@ -835,7 +835,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]" \ @@ -844,7 +844,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 ;; @@ -971,7 +971,7 @@ __docker_service_complete_ls_filters() { return ret } -__docker_service_complete_tasks_filters() { +__docker_service_complete_ps_filters() { [[ $PREFIX = -* ]] && return 1 integer ret=1 @@ -1061,7 +1061,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 @@ -1149,7 +1149,7 @@ __docker_service_subcommand() { ;; esac ;; - (tasks) + (ps) _arguments $(__docker_arguments) \ $opts_help \ "($help -a --all)"{-a,--all}"[Display all tasks]" \ @@ -1158,7 +1158,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 ;; diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 583ddf9f95..e83c756136 100644 --- a/docs/reference/commandline/index.md +++ b/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 | diff --git a/docs/reference/commandline/node_inspect.md b/docs/reference/commandline/node_inspect.md index a17b868467..65429bd3e4 100644 --- a/docs/reference/commandline/node_inspect.md +++ b/docs/reference/commandline/node_inspect.md @@ -122,6 +122,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) diff --git a/docs/reference/commandline/node_ls.md b/docs/reference/commandline/node_ls.md index 4def1a1dbb..eb36f61ff3 100644 --- a/docs/reference/commandline/node_ls.md +++ b/docs/reference/commandline/node_ls.md @@ -93,5 +93,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) diff --git a/docs/reference/commandline/node_tasks.md b/docs/reference/commandline/node_ps.md similarity index 89% rename from docs/reference/commandline/node_tasks.md rename to docs/reference/commandline/node_ps.md index 3367d64bff..d22498077e 100644 --- a/docs/reference/commandline/node_tasks.md +++ b/docs/reference/commandline/node_ps.md @@ -1,8 +1,9 @@