mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-23 19:56:01 +00:00
Merge pull request #20672 from brendandburns/dump
Automatic merge from submit-queue Add a 'kubectl clusterinfo dump' option Ref: #3500 @bgrant0607 @smarterclayton @jszczepkowski Usage: ``` # Dump current cluster state to stdout kubectl clusterinfo dump # Dump current cluster state to /tmp kubectl clusterinfo dump --output-directory=/tmp # Dump all namespaces to stdout kubectl clusterinfo dump --all-namespaces # Dump a set of namespaces to /tmp kubectl clusterinfo dump --namespaces default,kube-system --output-directory=/tmp ``` <!-- Reviewable:start --> --- This change is [<img src="http://reviewable.k8s.io/review_button.svg" height="35" align="absmiddle" alt="Reviewable"/>](http://reviewable.k8s.io/reviews/kubernetes/kubernetes/20672) <!-- Reviewable:end -->
This commit is contained in:
commit
50524c78a1
@ -10,6 +10,7 @@ docs/man/man1/kubectl-api-versions.1
|
|||||||
docs/man/man1/kubectl-apply.1
|
docs/man/man1/kubectl-apply.1
|
||||||
docs/man/man1/kubectl-attach.1
|
docs/man/man1/kubectl-attach.1
|
||||||
docs/man/man1/kubectl-autoscale.1
|
docs/man/man1/kubectl-autoscale.1
|
||||||
|
docs/man/man1/kubectl-cluster-info-dump.1
|
||||||
docs/man/man1/kubectl-cluster-info.1
|
docs/man/man1/kubectl-cluster-info.1
|
||||||
docs/man/man1/kubectl-config-current-context.1
|
docs/man/man1/kubectl-config-current-context.1
|
||||||
docs/man/man1/kubectl-config-set-cluster.1
|
docs/man/man1/kubectl-config-set-cluster.1
|
||||||
@ -68,6 +69,7 @@ docs/user-guide/kubectl/kubectl_apply.md
|
|||||||
docs/user-guide/kubectl/kubectl_attach.md
|
docs/user-guide/kubectl/kubectl_attach.md
|
||||||
docs/user-guide/kubectl/kubectl_autoscale.md
|
docs/user-guide/kubectl/kubectl_autoscale.md
|
||||||
docs/user-guide/kubectl/kubectl_cluster-info.md
|
docs/user-guide/kubectl/kubectl_cluster-info.md
|
||||||
|
docs/user-guide/kubectl/kubectl_cluster-info_dump.md
|
||||||
docs/user-guide/kubectl/kubectl_config.md
|
docs/user-guide/kubectl/kubectl_config.md
|
||||||
docs/user-guide/kubectl/kubectl_config_current-context.md
|
docs/user-guide/kubectl/kubectl_config_current-context.md
|
||||||
docs/user-guide/kubectl/kubectl_config_set-cluster.md
|
docs/user-guide/kubectl/kubectl_config_set-cluster.md
|
||||||
|
@ -3606,10 +3606,57 @@ _kubectl_config()
|
|||||||
noun_aliases=()
|
noun_aliases=()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
_kubectl_cluster-info_dump()
|
||||||
|
{
|
||||||
|
last_command="kubectl_cluster-info_dump"
|
||||||
|
commands=()
|
||||||
|
|
||||||
|
flags=()
|
||||||
|
two_word_flags=()
|
||||||
|
flags_with_completion=()
|
||||||
|
flags_completion=()
|
||||||
|
|
||||||
|
flags+=("--all-namespaces")
|
||||||
|
flags+=("--namespaces=")
|
||||||
|
flags+=("--output-directory=")
|
||||||
|
flags+=("--alsologtostderr")
|
||||||
|
flags+=("--api-version=")
|
||||||
|
flags+=("--as=")
|
||||||
|
flags+=("--certificate-authority=")
|
||||||
|
flags+=("--client-certificate=")
|
||||||
|
flags+=("--client-key=")
|
||||||
|
flags+=("--cluster=")
|
||||||
|
flags+=("--context=")
|
||||||
|
flags+=("--insecure-skip-tls-verify")
|
||||||
|
flags+=("--kubeconfig=")
|
||||||
|
flags+=("--log-backtrace-at=")
|
||||||
|
flags+=("--log-dir=")
|
||||||
|
flags+=("--log-flush-frequency=")
|
||||||
|
flags+=("--logtostderr")
|
||||||
|
flags+=("--match-server-version")
|
||||||
|
flags+=("--namespace=")
|
||||||
|
flags_with_completion+=("--namespace")
|
||||||
|
flags_completion+=("__kubectl_get_namespaces")
|
||||||
|
flags+=("--password=")
|
||||||
|
flags+=("--server=")
|
||||||
|
two_word_flags+=("-s")
|
||||||
|
flags+=("--stderrthreshold=")
|
||||||
|
flags+=("--token=")
|
||||||
|
flags+=("--user=")
|
||||||
|
flags+=("--username=")
|
||||||
|
flags+=("--v=")
|
||||||
|
flags+=("--vmodule=")
|
||||||
|
|
||||||
|
must_have_one_flag=()
|
||||||
|
must_have_one_noun=()
|
||||||
|
noun_aliases=()
|
||||||
|
}
|
||||||
|
|
||||||
_kubectl_cluster-info()
|
_kubectl_cluster-info()
|
||||||
{
|
{
|
||||||
last_command="kubectl_cluster-info"
|
last_command="kubectl_cluster-info"
|
||||||
commands=()
|
commands=()
|
||||||
|
commands+=("dump")
|
||||||
|
|
||||||
flags=()
|
flags=()
|
||||||
two_word_flags=()
|
two_word_flags=()
|
||||||
|
166
docs/man/man1/kubectl-cluster-info-dump.1
Normal file
166
docs/man/man1/kubectl-cluster-info-dump.1
Normal file
@ -0,0 +1,166 @@
|
|||||||
|
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
|
||||||
|
|
||||||
|
|
||||||
|
.SH NAME
|
||||||
|
.PP
|
||||||
|
kubectl cluster\-info dump \- Dump lots of relevant info for debugging and diagnosis.
|
||||||
|
|
||||||
|
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.PP
|
||||||
|
\fBkubectl cluster\-info dump\fP [OPTIONS]
|
||||||
|
|
||||||
|
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.PP
|
||||||
|
Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to
|
||||||
|
stdout. You can optionally specify a directory with \-\-output\-directory. If you specify a directory, kubernetes will
|
||||||
|
build a set of files in that directory. By default only dumps things in the 'kube\-system' namespace, but you can
|
||||||
|
switch to a different namespace with the \-\-namespaces flag, or specify \-\-all\-namespaces to dump all namespaces.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories
|
||||||
|
based on namespace and pod name.
|
||||||
|
|
||||||
|
|
||||||
|
.SH OPTIONS
|
||||||
|
.PP
|
||||||
|
\fB\-\-all\-namespaces\fP=false
|
||||||
|
If true, dump all namespaces. If true, \-\-namespaces is ignored.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\-\-namespaces\fP=[]
|
||||||
|
A comma separated list of namespaces to dump.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\-\-output\-directory\fP=""
|
||||||
|
Where to output the files. If empty or '\-' uses stdout, otherwise creates a directory hierarchy in that directory
|
||||||
|
|
||||||
|
|
||||||
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
||||||
|
.PP
|
||||||
|
\fB\-\-alsologtostderr\fP=false
|
||||||
|
log to standard error as well as files
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\-\-api\-version\fP=""
|
||||||
|
DEPRECATED: The API version to use when talking to the server
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\-\-as\fP=""
|
||||||
|
Username to impersonate for the operation.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\-\-certificate\-authority\fP=""
|
||||||
|
Path to a cert. file for the certificate authority.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\-\-client\-certificate\fP=""
|
||||||
|
Path to a client certificate 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
|
||||||
|
# Dump current cluster state to stdout
|
||||||
|
kubectl cluster\-info dump
|
||||||
|
|
||||||
|
# Dump current cluster state to /path/to/cluster\-state
|
||||||
|
kubectl cluster\-info dump \-\-output\-directory=/path/to/cluster\-state
|
||||||
|
|
||||||
|
# Dump all namespaces to stdout
|
||||||
|
kubectl cluster\-info dump \-\-all\-namespaces
|
||||||
|
|
||||||
|
# Dump a set of namespaces to /path/to/cluster\-state
|
||||||
|
kubectl cluster\-info dump \-\-namespaces default,kube\-system \-\-output\-directory=/path/to/cluster\-state
|
||||||
|
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
|
||||||
|
|
||||||
|
.SH SEE ALSO
|
||||||
|
.PP
|
||||||
|
\fBkubectl\-cluster\-info(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!
|
@ -14,6 +14,7 @@ kubectl cluster\-info \- Display cluster info
|
|||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.PP
|
.PP
|
||||||
Display addresses of the master and services with label kubernetes.io/cluster\-service=true
|
Display addresses of the master and services with label kubernetes.io/cluster\-service=true
|
||||||
|
To further debug and diagnose cluster problems, use 'kubectl cluster\-info dump'.
|
||||||
|
|
||||||
|
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
@ -122,7 +123,7 @@ Display addresses of the master and services with label kubernetes.io/cluster\-s
|
|||||||
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
.PP
|
.PP
|
||||||
\fBkubectl(1)\fP,
|
\fBkubectl(1)\fP, \fBkubectl\-cluster\-info\-dump(1)\fP,
|
||||||
|
|
||||||
|
|
||||||
.SH HISTORY
|
.SH HISTORY
|
||||||
|
@ -40,6 +40,7 @@ Display cluster info
|
|||||||
|
|
||||||
|
|
||||||
Display addresses of the master and services with label kubernetes.io/cluster-service=true
|
Display addresses of the master and services with label kubernetes.io/cluster-service=true
|
||||||
|
To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl cluster-info
|
kubectl cluster-info
|
||||||
@ -82,8 +83,9 @@ kubectl cluster-info
|
|||||||
### SEE ALSO
|
### SEE ALSO
|
||||||
|
|
||||||
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
|
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
|
||||||
|
* [kubectl cluster-info dump](kubectl_cluster-info_dump.md) - Dump lots of relevant info for debugging and diagnosis.
|
||||||
|
|
||||||
###### Auto generated by spf13/cobra on 5-Apr-2016
|
###### Auto generated by spf13/cobra on 16-May-2016
|
||||||
|
|
||||||
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||||
[]()
|
[]()
|
||||||
|
111
docs/user-guide/kubectl/kubectl_cluster-info_dump.md
Normal file
111
docs/user-guide/kubectl/kubectl_cluster-info_dump.md
Normal file
@ -0,0 +1,111 @@
|
|||||||
|
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
|
||||||
|
|
||||||
|
<!-- BEGIN STRIP_FOR_RELEASE -->
|
||||||
|
|
||||||
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||||
|
width="25" height="25">
|
||||||
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||||
|
width="25" height="25">
|
||||||
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||||
|
width="25" height="25">
|
||||||
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||||
|
width="25" height="25">
|
||||||
|
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
|
||||||
|
width="25" height="25">
|
||||||
|
|
||||||
|
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
|
||||||
|
|
||||||
|
If you are using a released version of Kubernetes, you should
|
||||||
|
refer to the docs that go with that version.
|
||||||
|
|
||||||
|
Documentation for other releases can be found at
|
||||||
|
[releases.k8s.io](http://releases.k8s.io).
|
||||||
|
</strong>
|
||||||
|
--
|
||||||
|
|
||||||
|
<!-- END STRIP_FOR_RELEASE -->
|
||||||
|
|
||||||
|
<!-- END MUNGE: UNVERSIONED_WARNING -->
|
||||||
|
|
||||||
|
## kubectl cluster-info dump
|
||||||
|
|
||||||
|
Dump lots of relevant info for debugging and diagnosis.
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to
|
||||||
|
stdout. You can optionally specify a directory with --output-directory. If you specify a directory, kubernetes will
|
||||||
|
build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can
|
||||||
|
switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces.
|
||||||
|
|
||||||
|
The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories
|
||||||
|
based on namespace and pod name.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
kubectl cluster-info dump
|
||||||
|
```
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
```
|
||||||
|
# Dump current cluster state to stdout
|
||||||
|
kubectl cluster-info dump
|
||||||
|
|
||||||
|
# Dump current cluster state to /path/to/cluster-state
|
||||||
|
kubectl cluster-info dump --output-directory=/path/to/cluster-state
|
||||||
|
|
||||||
|
# Dump all namespaces to stdout
|
||||||
|
kubectl cluster-info dump --all-namespaces
|
||||||
|
|
||||||
|
# Dump a set of namespaces to /path/to/cluster-state
|
||||||
|
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
--all-namespaces[=false]: If true, dump all namespaces. If true, --namespaces is ignored.
|
||||||
|
--namespaces=[]: A comma separated list of namespaces to dump.
|
||||||
|
--output-directory="": Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
--alsologtostderr[=false]: log to standard error as well as files
|
||||||
|
--as="": Username to impersonate for the operation.
|
||||||
|
--certificate-authority="": Path to a cert. file for the certificate authority.
|
||||||
|
--client-certificate="": Path to a client certificate file for TLS.
|
||||||
|
--client-key="": Path to a client key file for TLS.
|
||||||
|
--cluster="": The name of the kubeconfig cluster to use
|
||||||
|
--context="": The name of the kubeconfig context to use
|
||||||
|
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
|
||||||
|
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
|
||||||
|
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
|
||||||
|
--log-dir="": If non-empty, write log files in this directory
|
||||||
|
--log-flush-frequency=5s: Maximum number of seconds between log flushes
|
||||||
|
--logtostderr[=true]: log to standard error instead of files
|
||||||
|
--match-server-version[=false]: Require server version to match client version
|
||||||
|
--namespace="": If present, the namespace scope for this CLI request.
|
||||||
|
--password="": Password for basic authentication to the API server.
|
||||||
|
-s, --server="": The address and port of the Kubernetes API server
|
||||||
|
--stderrthreshold=2: logs at or above this threshold go to stderr
|
||||||
|
--token="": Bearer token for authentication to the API server.
|
||||||
|
--user="": The name of the kubeconfig user to use
|
||||||
|
--username="": Username for basic authentication to the API server.
|
||||||
|
--v=0: log level for V logs
|
||||||
|
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 16-May-2016
|
||||||
|
|
||||||
|
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
|
||||||
|
[]()
|
||||||
|
<!-- END MUNGE: GENERATED_ANALYTICS -->
|
@ -1,7 +1,8 @@
|
|||||||
name: cluster-info
|
name: cluster-info
|
||||||
synopsis: Display cluster info
|
synopsis: Display cluster info
|
||||||
description: |
|
description: |-
|
||||||
Display addresses of the master and services with label kubernetes.io/cluster-service=true
|
Display addresses of the master and services with label kubernetes.io/cluster-service=true
|
||||||
|
To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
|
||||||
options:
|
options:
|
||||||
- name: include-extended-apis
|
- name: include-extended-apis
|
||||||
default_value: "true"
|
default_value: "true"
|
||||||
@ -70,3 +71,4 @@ inherited_options:
|
|||||||
comma-separated list of pattern=N settings for file-filtered logging
|
comma-separated list of pattern=N settings for file-filtered logging
|
||||||
see_also:
|
see_also:
|
||||||
- kubectl
|
- kubectl
|
||||||
|
- dump
|
||||||
|
@ -314,6 +314,7 @@ os-distro
|
|||||||
out-version
|
out-version
|
||||||
outofdisk-transition-frequency
|
outofdisk-transition-frequency
|
||||||
output-base
|
output-base
|
||||||
|
output-directory
|
||||||
output-package
|
output-package
|
||||||
output-print-type
|
output-print-type
|
||||||
output-version
|
output-version
|
||||||
|
@ -30,19 +30,23 @@ import (
|
|||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var longDescr = `Display addresses of the master and services with label kubernetes.io/cluster-service=true
|
||||||
|
To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.`
|
||||||
|
|
||||||
func NewCmdClusterInfo(f *cmdutil.Factory, out io.Writer) *cobra.Command {
|
func NewCmdClusterInfo(f *cmdutil.Factory, out io.Writer) *cobra.Command {
|
||||||
cmd := &cobra.Command{
|
cmd := &cobra.Command{
|
||||||
Use: "cluster-info",
|
Use: "cluster-info",
|
||||||
// clusterinfo is deprecated.
|
// clusterinfo is deprecated.
|
||||||
Aliases: []string{"clusterinfo"},
|
Aliases: []string{"clusterinfo"},
|
||||||
Short: "Display cluster info",
|
Short: "Display cluster info",
|
||||||
Long: "Display addresses of the master and services with label kubernetes.io/cluster-service=true",
|
Long: longDescr,
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
Run: func(cmd *cobra.Command, args []string) {
|
||||||
err := RunClusterInfo(f, out, cmd)
|
err := RunClusterInfo(f, out, cmd)
|
||||||
cmdutil.CheckErr(err)
|
cmdutil.CheckErr(err)
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
cmdutil.AddInclude3rdPartyFlags(cmd)
|
cmdutil.AddInclude3rdPartyFlags(cmd)
|
||||||
|
cmd.AddCommand(NewCmdClusterInfoDump(f, out))
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -101,6 +105,7 @@ func RunClusterInfo(f *cmdutil.Factory, out io.Writer, cmd *cobra.Command) error
|
|||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
})
|
})
|
||||||
|
out.Write([]byte("\nTo further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.\n"))
|
||||||
return nil
|
return nil
|
||||||
|
|
||||||
// TODO consider printing more information about cluster
|
// TODO consider printing more information about cluster
|
||||||
|
215
pkg/kubectl/cmd/clusterinfo_dump.go
Normal file
215
pkg/kubectl/cmd/clusterinfo_dump.go
Normal file
@ -0,0 +1,215 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2016 The Kubernetes Authors All rights reserved.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"path"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"k8s.io/kubernetes/pkg/api"
|
||||||
|
"k8s.io/kubernetes/pkg/client/unversioned"
|
||||||
|
"k8s.io/kubernetes/pkg/kubectl"
|
||||||
|
cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
|
||||||
|
)
|
||||||
|
|
||||||
|
// NewCmdCreateSecret groups subcommands to create various types of secrets
|
||||||
|
func NewCmdClusterInfoDump(f *cmdutil.Factory, cmdOut io.Writer) *cobra.Command {
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "dump",
|
||||||
|
Short: "Dump lots of relevant info for debugging and diagnosis.",
|
||||||
|
Long: dumpLong,
|
||||||
|
Example: dumpExample,
|
||||||
|
Run: func(cmd *cobra.Command, args []string) {
|
||||||
|
cmdutil.CheckErr(dumpClusterInfo(f, cmd, args, cmdOut))
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().String("output-directory", "", "Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory")
|
||||||
|
cmd.Flags().StringSlice("namespaces", []string{}, "A comma separated list of namespaces to dump.")
|
||||||
|
cmd.Flags().Bool("all-namespaces", false, "If true, dump all namespaces. If true, --namespaces is ignored.")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
dumpLong = `
|
||||||
|
Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to
|
||||||
|
stdout. You can optionally specify a directory with --output-directory. If you specify a directory, kubernetes will
|
||||||
|
build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can
|
||||||
|
switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces.
|
||||||
|
|
||||||
|
The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories
|
||||||
|
based on namespace and pod name.
|
||||||
|
`
|
||||||
|
|
||||||
|
dumpExample = `# Dump current cluster state to stdout
|
||||||
|
kubectl cluster-info dump
|
||||||
|
|
||||||
|
# Dump current cluster state to /path/to/cluster-state
|
||||||
|
kubectl cluster-info dump --output-directory=/path/to/cluster-state
|
||||||
|
|
||||||
|
# Dump all namespaces to stdout
|
||||||
|
kubectl cluster-info dump --all-namespaces
|
||||||
|
|
||||||
|
# Dump a set of namespaces to /path/to/cluster-state
|
||||||
|
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state`
|
||||||
|
)
|
||||||
|
|
||||||
|
func setupOutputWriter(cmd *cobra.Command, defaultWriter io.Writer, filename string) io.Writer {
|
||||||
|
dir := cmdutil.GetFlagString(cmd, "output-directory")
|
||||||
|
if len(dir) == 0 || dir == "-" {
|
||||||
|
return defaultWriter
|
||||||
|
}
|
||||||
|
fullFile := path.Join(dir, filename)
|
||||||
|
parent := path.Dir(fullFile)
|
||||||
|
cmdutil.CheckErr(os.MkdirAll(parent, 0755))
|
||||||
|
|
||||||
|
file, err := os.Create(path.Join(dir, filename))
|
||||||
|
cmdutil.CheckErr(err)
|
||||||
|
return file
|
||||||
|
}
|
||||||
|
|
||||||
|
func dumpClusterInfo(f *cmdutil.Factory, cmd *cobra.Command, args []string, out io.Writer) error {
|
||||||
|
var c *unversioned.Client
|
||||||
|
var err error
|
||||||
|
if c, err = f.Client(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
printer, _, err := kubectl.GetPrinter("json", "")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
nodes, err := c.Nodes().List(api.ListOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := printer.PrintObj(nodes, setupOutputWriter(cmd, out, "nodes.json")); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
var namespaces []string
|
||||||
|
if cmdutil.GetFlagBool(cmd, "all-namespaces") {
|
||||||
|
namespaceList, err := c.Namespaces().List(api.ListOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for ix := range namespaceList.Items {
|
||||||
|
namespaces = append(namespaces, namespaceList.Items[ix].Name)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
namespaces = cmdutil.GetFlagStringSlice(cmd, "namespaces")
|
||||||
|
if len(namespaces) == 0 {
|
||||||
|
cmdNamespace, _, err := f.DefaultNamespace()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
namespaces = []string{
|
||||||
|
api.NamespaceSystem,
|
||||||
|
cmdNamespace,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, namespace := range namespaces {
|
||||||
|
// TODO: this is repetitive in the extreme. Use reflection or
|
||||||
|
// something to make this a for loop.
|
||||||
|
events, err := c.Events(namespace).List(api.ListOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := printer.PrintObj(events, setupOutputWriter(cmd, out, path.Join(namespace, "events.json"))); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
rcs, err := c.ReplicationControllers(namespace).List(api.ListOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := printer.PrintObj(rcs, setupOutputWriter(cmd, out, path.Join(namespace, "replication-controllers.json"))); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
svcs, err := c.Services(namespace).List(api.ListOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := printer.PrintObj(svcs, setupOutputWriter(cmd, out, path.Join(namespace, "services.json"))); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
sets, err := c.DaemonSets(namespace).List(api.ListOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := printer.PrintObj(sets, setupOutputWriter(cmd, out, path.Join(namespace, "daemonsets.json"))); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
deps, err := c.Deployments(namespace).List(api.ListOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := printer.PrintObj(deps, setupOutputWriter(cmd, out, path.Join(namespace, "deployments.json"))); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
rps, err := c.ReplicaSets(namespace).List(api.ListOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := printer.PrintObj(rps, setupOutputWriter(cmd, out, path.Join(namespace, "replicasets.json"))); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
pods, err := c.Pods(namespace).List(api.ListOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := printer.PrintObj(pods, setupOutputWriter(cmd, out, path.Join(namespace, "pods.json"))); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
for ix := range pods.Items {
|
||||||
|
pod := &pods.Items[ix]
|
||||||
|
writer := setupOutputWriter(cmd, out, path.Join(namespace, pod.Name, "logs.txt"))
|
||||||
|
writer.Write([]byte(fmt.Sprintf("==== START logs for %s/%s ====\n", pod.Namespace, pod.Name)))
|
||||||
|
request, err := f.LogsForObject(pod, &api.PodLogOptions{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
data, err := request.DoRaw()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
writer.Write(data)
|
||||||
|
writer.Write([]byte(fmt.Sprintf("==== END logs for %s/%s ====\n", pod.Namespace, pod.Name)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
dir := cmdutil.GetFlagString(cmd, "output-directory")
|
||||||
|
if len(dir) == 0 {
|
||||||
|
dir = "."
|
||||||
|
}
|
||||||
|
if dir != "-" {
|
||||||
|
fmt.Fprintf(out, "Cluster info dumped to %s", dir)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
68
pkg/kubectl/cmd/clusterinfo_dump_test.go
Normal file
68
pkg/kubectl/cmd/clusterinfo_dump_test.go
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2016 The Kubernetes Authors All rights reserved.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package cmd
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"io/ioutil"
|
||||||
|
"os"
|
||||||
|
"path"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestSetupOutputWriterNoOp(t *testing.T) {
|
||||||
|
tests := []string{"", "-"}
|
||||||
|
for _, test := range tests {
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
f, _, _ := NewAPIFactory()
|
||||||
|
cmd := NewCmdClusterInfoDump(f, os.Stdout)
|
||||||
|
cmd.Flag("output-directory").Value.Set(test)
|
||||||
|
writer := setupOutputWriter(cmd, out, "/some/file/that/should/be/ignored")
|
||||||
|
if writer != out {
|
||||||
|
t.Errorf("expected: %v, saw: %v", out, writer)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetupOutputWriterFile(t *testing.T) {
|
||||||
|
file := "output.json"
|
||||||
|
dir, err := ioutil.TempDir(os.TempDir(), "out")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
fullPath := path.Join(dir, file)
|
||||||
|
defer os.RemoveAll(dir)
|
||||||
|
|
||||||
|
out := &bytes.Buffer{}
|
||||||
|
f, _, _ := NewAPIFactory()
|
||||||
|
cmd := NewCmdClusterInfoDump(f, os.Stdout)
|
||||||
|
cmd.Flag("output-directory").Value.Set(dir)
|
||||||
|
writer := setupOutputWriter(cmd, out, file)
|
||||||
|
if writer == out {
|
||||||
|
t.Errorf("expected: %v, saw: %v", out, writer)
|
||||||
|
}
|
||||||
|
output := "some data here"
|
||||||
|
writer.Write([]byte(output))
|
||||||
|
|
||||||
|
data, err := ioutil.ReadFile(fullPath)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
if string(data) != output {
|
||||||
|
t.Errorf("expected: %v, saw: %v", output, data)
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user