kubectl-top-node(1)

1KUBERNETES(1)(kubernetes)                            KUBERNETES(1)(kubernetes)
2
3
4
5Eric Paris Jan 2015
6
7

NAME

9       kubectl top node - Display resource (CPU/memory) usage of nodes
10
11
12

SYNOPSIS

14       kubectl top node [OPTIONS]
15
16
17

DESCRIPTION

19       Display resource (CPU/memory) usage of nodes.
20
21
22       The  top-node  command  allows  you  to see the resource consumption of
23       nodes.
24
25
26

OPTIONS

28       --no-headers=false      If present, print output without headers
29
30
31       -l, --selector=""      Selector (label query) to  filter  on,  supports
32       '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects
33       must satisfy all of the specified label constraints.
34
35
36       --show-capacity=false      Print node resources based on  Capacity  in‐
37       stead of Allocatable(default) of the nodes.
38
39
40       --sort-by=""       If non-empty, sort nodes list using specified field.
41       The field can be either 'cpu' or 'memory'.
42
43
44       --use-protocol-buffers=true      Enables using protocol-buffers to  ac‐
45       cess Metrics API.
46
47
48

OPTIONS INHERITED FROM PARENT COMMANDS

50       --as=""      Username to impersonate for the operation. User could be a
51       regular user or a service account in a namespace.
52
53
54       --as-group=[]      Group to impersonate for the  operation,  this  flag
55       can be repeated to specify multiple groups.
56
57
58       --as-uid=""      UID to impersonate for the operation.
59
60
61       --azure-container-registry-config=""       Path  to the file containing
62       Azure container registry configuration information.
63
64
65       --cache-dir="/builddir/.kube/cache"      Default cache directory
66
67
68       --certificate-authority=""      Path to a cert file for the certificate
69       authority
70
71
72       --client-certificate=""      Path to a client certificate file for TLS
73
74
75       --client-key=""      Path to a client key file for TLS
76
77
78       --cluster=""      The name of the kubeconfig cluster to use
79
80
81       --context=""      The name of the kubeconfig context to use
82
83
84       --disable-compression=false       If true, opt-out of response compres‐
85       sion for all requests to the server
86
87
88       --insecure-skip-tls-verify=false      If true, the server's certificate
89       will not be checked for validity. This will make your HTTPS connections
90       insecure
91
92
93       --kubeconfig=""      Path to the kubeconfig file to  use  for  CLI  re‐
94       quests.
95
96
97       --match-server-version=false        Require  server  version  to  match
98       client version
99
100
101       -n, --namespace=""      If present, the namespace scope  for  this  CLI
102       request
103
104
105       --password=""      Password for basic authentication to the API server
106
107
108       --profile="none"         Name   of   profile   to   capture.   One   of
109       (none|cpu|heap|goroutine|threadcreate|block|mutex)
110
111
112       --profile-output="profile.pprof"      Name of the  file  to  write  the
113       profile to
114
115
116       --request-timeout="0"       The length of time to wait before giving up
117       on a single server request. Non-zero values  should  contain  a  corre‐
118       sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
119       out requests.
120
121
122       -s, --server=""      The address and port of the Kubernetes API server
123
124
125       --tls-server-name=""      Server name to  use  for  server  certificate
126       validation.  If  it  is  not provided, the hostname used to contact the
127       server is used
128
129
130       --token=""      Bearer token for authentication to the API server
131
132
133       --user=""      The name of the kubeconfig user to use
134
135
136       --username=""      Username for basic authentication to the API server
137
138
139       --version=false      Print version information and quit
140
141
142       --warnings-as-errors=false      Treat warnings received from the server
143       as errors and exit with a non-zero exit code
144
145
146

EXAMPLE

148                # Show metrics for all nodes
149                kubectl top node
150
151                # Show metrics for a given node
152                kubectl top node NODE_NAME
153
154
155
156

HISTORY

163       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
164       com) based on the kubernetes source material, but hopefully  they  have
165       been automatically generated since!
166
167
168
169Manuals                              User            KUBERNETES(1)(kubernetes)