pull "kubectl edit" from openshift upstream

lavalamp · Sep 16, 2015 · 5a60844 · 5a60844
1 parent a92c8b6
commit 5a60844
Show file tree

Hide file tree

Showing 17 changed files with 1,409 additions and 4 deletions.
diff --git a/.generated_docs b/.generated_docs
@@ -15,6 +15,7 @@ docs/man/man1/kubectl-config.1
 docs/man/man1/kubectl-create.1
 docs/man/man1/kubectl-delete.1
 docs/man/man1/kubectl-describe.1
+docs/man/man1/kubectl-edit.1
 docs/man/man1/kubectl-exec.1
 docs/man/man1/kubectl-expose.1
 docs/man/man1/kubectl-get.1
@@ -47,6 +48,7 @@ docs/user-guide/kubectl/kubectl_config_view.md
 docs/user-guide/kubectl/kubectl_create.md
 docs/user-guide/kubectl/kubectl_delete.md
 docs/user-guide/kubectl/kubectl_describe.md
+docs/user-guide/kubectl/kubectl_edit.md
 docs/user-guide/kubectl/kubectl_exec.md
 docs/user-guide/kubectl/kubectl_expose.md
 docs/user-guide/kubectl/kubectl_get.md

diff --git a/contrib/completions/bash/kubectl b/contrib/completions/bash/kubectl
@@ -476,6 +476,30 @@ _kubectl_delete()
     must_have_one_noun+=("thirdpartyresource")
 }
 
+_kubectl_edit()
+{
+    last_command="kubectl_edit"
+    commands=()
+
+    flags=()
+    two_word_flags=()
+    flags_with_completion=()
+    flags_completion=()
+
+    flags+=("--filename=")
+    flags_with_completion+=("--filename")
+    flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml")
+    two_word_flags+=("-f")
+    flags_with_completion+=("-f")
+    flags_completion+=("__handle_filename_extension_flag json|stdin|yaml|yml")
+    flags+=("--output=")
+    two_word_flags+=("-o")
+    flags+=("--output-version=")
+
+    must_have_one_flag=()
+    must_have_one_noun=()
+}
+
 _kubectl_namespace()
 {
     last_command="kubectl_namespace"
@@ -1083,6 +1107,7 @@ _kubectl()
     commands+=("replace")
     commands+=("patch")
     commands+=("delete")
+    commands+=("edit")
     commands+=("namespace")
     commands+=("logs")
     commands+=("rolling-update")

diff --git a/docs/man/man1/.files_generated b/docs/man/man1/.files_generated
@@ -0,0 +1,32 @@
+kubectl-annotate.1
+kubectl-api-versions.1
+kubectl-attach.1
+kubectl-cluster-info.1
+kubectl-config-set-cluster.1
+kubectl-config-set-context.1
+kubectl-config-set-credentials.1
+kubectl-config-set.1
+kubectl-config-unset.1
+kubectl-config-use-context.1
+kubectl-config-view.1
+kubectl-config.1
+kubectl-create.1
+kubectl-delete.1
+kubectl-describe.1
+kubectl-edit.1
+kubectl-exec.1
+kubectl-expose.1
+kubectl-get.1
+kubectl-label.1
+kubectl-logs.1
+kubectl-namespace.1
+kubectl-patch.1
+kubectl-port-forward.1
+kubectl-proxy.1
+kubectl-replace.1
+kubectl-rolling-update.1
+kubectl-run.1
+kubectl-scale.1
+kubectl-stop.1
+kubectl-version.1
+kubectl.1
diff --git a/docs/man/man1/kubectl-edit.1 b/docs/man/man1/kubectl-edit.1
@@ -0,0 +1,172 @@
+.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015"  ""
+
+
+.SH NAME
+.PP
+kubectl edit \- Edit a resource on the server
+
+
+.SH SYNOPSIS
+.PP
+\fBkubectl edit\fP [OPTIONS]
+
+
+.SH DESCRIPTION
+.PP
+Edit a resource from the default editor.
+
+.PP
+The edit command allows you to directly edit any API resource you can retrieve via the
+command line tools. It will open the editor defined by your KUBE\_EDITOR, GIT\_EDITOR,
+or EDITOR environment variables, or fall back to 'vi'. You can edit multiple objects,
+although changes are applied one at a time. The command accepts filenames as well as
+command line arguments, although the files you point to must be previously saved
+versions of resources.
+
+.PP
+The files to edit will be output in the default API version, or a version specified
+by \-\-output\-version. The default format is YAML \- if you would like to edit in JSON
+pass \-o json.
+
+.PP
+In the event an error occurs while updating, a temporary file will be created on disk
+that contains your unapplied changes. The most common error when updating a resource
+is another editor changing the resource on the server. When this occurs, you will have
+to apply your changes to the newer version of the resource, or update your temporary
+saved copy to include the latest resource version.
+
+
+.SH OPTIONS
+.PP
+\fB\-f\fP, \fB\-\-filename\fP=[]
+    Filename, directory, or URL to file to use to edit the resource
+
+.PP
+\fB\-o\fP, \fB\-\-output\fP="yaml"
+    Output format. One of: yaml|json.
+
+.PP
+\fB\-\-output\-version\fP=""
+    Output the formatted object with the given version (default api\-version).
+
+
+.SH OPTIONS INHERITED FROM PARENT COMMANDS
+.PP
+\fB\-\-alsologtostderr\fP=false
+    log to standard error as well as files
+
+.PP
+\fB\-\-api\-version\fP=""
+    The API version to use when talking to the server
+
+.PP
+\fB\-\-certificate\-authority\fP=""
+    Path to a cert. file for the certificate authority.
+
+.PP
+\fB\-\-client\-certificate\fP=""
+    Path to a client key file for TLS.
+
+.PP
+\fB\-\-client\-key\fP=""
+    Path to a client key file for TLS.
+
+.PP
+\fB\-\-cluster\fP=""
+    The name of the kubeconfig cluster to use
+
+.PP
+\fB\-\-context\fP=""
+    The name of the kubeconfig context to use
+
+.PP
+\fB\-\-insecure\-skip\-tls\-verify\fP=false
+    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
+
+.PP
+\fB\-\-kubeconfig\fP=""
+    Path to the kubeconfig file to use for CLI requests.
+
+.PP
+\fB\-\-log\-backtrace\-at\fP=:0
+    when logging hits line file:N, emit a stack trace
+
+.PP
+\fB\-\-log\-dir\fP=""
+    If non\-empty, write log files in this directory
+
+.PP
+\fB\-\-log\-flush\-frequency\fP=5s
+    Maximum number of seconds between log flushes
+
+.PP
+\fB\-\-logtostderr\fP=true
+    log to standard error instead of files
+
+.PP
+\fB\-\-match\-server\-version\fP=false
+    Require server version to match client version
+
+.PP
+\fB\-\-namespace\fP=""
+    If present, the namespace scope for this CLI request.
+
+.PP
+\fB\-\-password\fP=""
+    Password for basic authentication to the API server.
+
+.PP
+\fB\-s\fP, \fB\-\-server\fP=""
+    The address and port of the Kubernetes API server
+
+.PP
+\fB\-\-stderrthreshold\fP=2
+    logs at or above this threshold go to stderr
+
+.PP
+\fB\-\-token\fP=""
+    Bearer token for authentication to the API server.
+
+.PP
+\fB\-\-user\fP=""
+    The name of the kubeconfig user to use
+
+.PP
+\fB\-\-username\fP=""
+    Username for basic authentication to the API server.
+
+.PP
+\fB\-\-v\fP=0
+    log level for V logs
+
+.PP
+\fB\-\-vmodule\fP=
+    comma\-separated list of pattern=N settings for file\-filtered logging
+
+
+.SH EXAMPLE
+.PP
+.RS
+
+.nf
+  # Edit the service named 'docker\-registry':
+  $ kubectl edit svc/docker\-registry
+
+  # Use an alternative editor
+  $ KUBE\_EDITOR="nano" kubectl edit svc/docker\-registry
+
+  # Edit the service 'docker\-registry' in JSON using the v1 API format:
+  $ kubectl edit svc/docker\-registry \-\-output\-version=v1 \-o json
+
+.fi
+.RE
+
+
+.SH SEE ALSO
+.PP
+\fBkubectl(1)\fP,
+
+
+.SH HISTORY
+.PP
+January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!
diff --git a/docs/man/man1/kubectl.1 b/docs/man/man1/kubectl.1
@@ -116,7 +116,7 @@ Find more information at
 
 .SH SEE ALSO
 .PP
-\fBkubectl\-get(1)\fP, \fBkubectl\-describe(1)\fP, \fBkubectl\-create(1)\fP, \fBkubectl\-replace(1)\fP, \fBkubectl\-patch(1)\fP, \fBkubectl\-delete(1)\fP, \fBkubectl\-namespace(1)\fP, \fBkubectl\-logs(1)\fP, \fBkubectl\-rolling\-update(1)\fP, \fBkubectl\-scale(1)\fP, \fBkubectl\-attach(1)\fP, \fBkubectl\-exec(1)\fP, \fBkubectl\-port\-forward(1)\fP, \fBkubectl\-proxy(1)\fP, \fBkubectl\-run(1)\fP, \fBkubectl\-stop(1)\fP, \fBkubectl\-expose(1)\fP, \fBkubectl\-label(1)\fP, \fBkubectl\-annotate(1)\fP, \fBkubectl\-config(1)\fP, \fBkubectl\-cluster\-info(1)\fP, \fBkubectl\-api\-versions(1)\fP, \fBkubectl\-version(1)\fP,
+\fBkubectl\-get(1)\fP, \fBkubectl\-describe(1)\fP, \fBkubectl\-create(1)\fP, \fBkubectl\-replace(1)\fP, \fBkubectl\-patch(1)\fP, \fBkubectl\-delete(1)\fP, \fBkubectl\-edit(1)\fP, \fBkubectl\-namespace(1)\fP, \fBkubectl\-logs(1)\fP, \fBkubectl\-rolling\-update(1)\fP, \fBkubectl\-scale(1)\fP, \fBkubectl\-attach(1)\fP, \fBkubectl\-exec(1)\fP, \fBkubectl\-port\-forward(1)\fP, \fBkubectl\-proxy(1)\fP, \fBkubectl\-run(1)\fP, \fBkubectl\-stop(1)\fP, \fBkubectl\-expose(1)\fP, \fBkubectl\-label(1)\fP, \fBkubectl\-annotate(1)\fP, \fBkubectl\-config(1)\fP, \fBkubectl\-cluster\-info(1)\fP, \fBkubectl\-api\-versions(1)\fP, \fBkubectl\-version(1)\fP,
 
 
 .SH HISTORY

diff --git a/docs/user-guide/kubectl/.files_generated b/docs/user-guide/kubectl/.files_generated
@@ -0,0 +1,32 @@
+kubectl.md
+kubectl_annotate.md
+kubectl_api-versions.md
+kubectl_attach.md
+kubectl_cluster-info.md
+kubectl_config.md
+kubectl_config_set-cluster.md
+kubectl_config_set-context.md
+kubectl_config_set-credentials.md
+kubectl_config_set.md
+kubectl_config_unset.md
+kubectl_config_use-context.md
+kubectl_config_view.md
+kubectl_create.md
+kubectl_delete.md
+kubectl_describe.md
+kubectl_edit.md
+kubectl_exec.md
+kubectl_expose.md
+kubectl_get.md
+kubectl_label.md
+kubectl_logs.md
+kubectl_namespace.md
+kubectl_patch.md
+kubectl_port-forward.md
+kubectl_proxy.md
+kubectl_replace.md
+kubectl_rolling-update.md
+kubectl_run.md
+kubectl_scale.md
+kubectl_stop.md
+kubectl_version.md
diff --git a/docs/user-guide/kubectl/kubectl.md b/docs/user-guide/kubectl/kubectl.md
@@ -84,6 +84,7 @@ kubectl
 * [kubectl create](kubectl_create.md)	 - Create a resource by filename or stdin
 * [kubectl delete](kubectl_delete.md)	 - Delete resources by filenames, stdin, resources and names, or by resources and label selector.
 * [kubectl describe](kubectl_describe.md)	 - Show details of a specific resource or group of resources
+* [kubectl edit](kubectl_edit.md)	 - Edit a resource on the server
 * [kubectl exec](kubectl_exec.md)	 - Execute a command in a container.
 * [kubectl expose](kubectl_expose.md)	 - Take a replication controller, service or pod and expose it as a new Kubernetes Service
 * [kubectl get](kubectl_get.md)	 - Display one or many resources