From 35cac3c4e7d095d3da52d4e49da161350bcc76a9 Mon Sep 17 00:00:00 2001 From: hurf Date: Wed, 29 Jul 2015 17:19:18 +0800 Subject: [PATCH] Deprecate kubectl stop command Added deprecation warning for stop. --- docs/man/man1/kubectl-stop.1 | 8 ++++++-- docs/user-guide/kubectl/kubectl.md | 4 ++-- docs/user-guide/kubectl/kubectl_stop.md | 9 ++++++--- pkg/kubectl/cmd/stop.go | 7 +++++-- 4 files changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/man/man1/kubectl-stop.1 b/docs/man/man1/kubectl-stop.1 index dfdf732b334..51fc22d3a26 100644 --- a/docs/man/man1/kubectl-stop.1 +++ b/docs/man/man1/kubectl-stop.1 @@ -3,7 +3,7 @@ .SH NAME .PP -kubectl stop \- Gracefully shut down a resource by name or filename. +kubectl stop \- Deprecated: Gracefully shut down a resource by name or filename. .SH SYNOPSIS @@ -13,7 +13,11 @@ kubectl stop \- Gracefully shut down a resource by name or filename. .SH DESCRIPTION .PP -Gracefully shut down a resource by name or filename. +Deprecated: Gracefully shut down a resource by name or filename. + +.PP +stop command is deprecated, all its functionalities are covered by delete command. +See 'kubectl delete \-\-help' for more details. .PP Attempts to shut down and delete a resource that supports graceful termination. diff --git a/docs/user-guide/kubectl/kubectl.md b/docs/user-guide/kubectl/kubectl.md index 6ee5877fdb0..5cf0e4d5c4b 100644 --- a/docs/user-guide/kubectl/kubectl.md +++ b/docs/user-guide/kubectl/kubectl.md @@ -97,10 +97,10 @@ kubectl * [kubectl rolling-update](kubectl_rolling-update.md) - Perform a rolling update of the given ReplicationController. * [kubectl run](kubectl_run.md) - Run a particular image on the cluster. * [kubectl scale](kubectl_scale.md) - Set a new size for a Replication Controller. -* [kubectl stop](kubectl_stop.md) - Gracefully shut down a resource by name or filename. +* [kubectl stop](kubectl_stop.md) - Deprecated: Gracefully shut down a resource by name or filename. * [kubectl version](kubectl_version.md) - Print the client and server version information. -###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.96000791 +0000 UTC +###### Auto generated by spf13/cobra at 2015-07-29 09:18:59.541696918 +0000 UTC diff --git a/docs/user-guide/kubectl/kubectl_stop.md b/docs/user-guide/kubectl/kubectl_stop.md index ed65ad3fe4d..804ff034899 100644 --- a/docs/user-guide/kubectl/kubectl_stop.md +++ b/docs/user-guide/kubectl/kubectl_stop.md @@ -33,12 +33,15 @@ Documentation for other releases can be found at ## kubectl stop -Gracefully shut down a resource by name or filename. +Deprecated: Gracefully shut down a resource by name or filename. ### Synopsis -Gracefully shut down a resource by name or filename. +Deprecated: Gracefully shut down a resource by name or filename. + +stop command is deprecated, all its functionalities are covered by delete command. +See 'kubectl delete --help' for more details. Attempts to shut down and delete a resource that supports graceful termination. If the resource is scalable it will be scaled to 0 before deletion. @@ -108,7 +111,7 @@ $ kubectl stop -f path/to/resources * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.957441942 +0000 UTC +###### Auto generated by spf13/cobra at 2015-07-29 09:18:59.539597953 +0000 UTC diff --git a/pkg/kubectl/cmd/stop.go b/pkg/kubectl/cmd/stop.go index b8b214419bb..2304876eb1a 100644 --- a/pkg/kubectl/cmd/stop.go +++ b/pkg/kubectl/cmd/stop.go @@ -27,7 +27,10 @@ import ( ) const ( - stop_long = `Gracefully shut down a resource by name or filename. + stop_long = `Deprecated: Gracefully shut down a resource by name or filename. + +stop command is deprecated, all its functionalities are covered by delete command. +See 'kubectl delete --help' for more details. Attempts to shut down and delete a resource that supports graceful termination. If the resource is scalable it will be scaled to 0 before deletion.` @@ -50,7 +53,7 @@ func NewCmdStop(f *cmdutil.Factory, out io.Writer) *cobra.Command { }{} cmd := &cobra.Command{ Use: "stop (-f FILENAME | RESOURCE (NAME | -l label | --all))", - Short: "Gracefully shut down a resource by name or filename.", + Short: "Deprecated: Gracefully shut down a resource by name or filename.", Long: stop_long, Example: stop_example, Run: func(cmd *cobra.Command, args []string) {