2014-10-09 22:42:04 +00:00
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Scott Collier" "October 2014" ""
2015-01-31 19:08:59 +00:00
2014-10-09 22:42:04 +00:00
.SH NAME
.PP
kubelet \- Processes a container manifest so the containers are launched according to how they are described.
2015-01-31 19:08:59 +00:00
2014-10-09 22:42:04 +00:00
.SH SYNOPSIS
.PP
\fB kubelet\fP [OPTIONS]
2015-01-31 19:08:59 +00:00
2014-10-09 22:42:04 +00:00
.SH DESCRIPTION
.PP
The \fB kubernetes\fP kubelet runs on each node. The Kubelet works in terms of a container manifest. A container manifest is a YAML or JSON file that describes a pod. The Kubelet takes a set of manifests that are provided in various mechanisms and ensures that the containers described in those manifests are started and continue running.
.PP
There are 4 ways that a container manifest can be provided to the Kubelet:
.PP
.RS
.nf
File Path passed as a flag on the command line. This file is rechecked every 20 seconds (configurable with a flag).
HTTP endpoint HTTP endpoint passed as a parameter on the command line. This endpoint is checked every 20 seconds (also configurable with a flag).
2015-01-31 19:08:59 +00:00
etcd server The Kubelet will reach out and do a watch on an etcd server. The etcd path that is watched is /registry/hosts/$(hostname \- f). As this is a watch, changes are noticed and acted upon very quickly.
2014-10-09 22:42:04 +00:00
HTTP server The kubelet can also listen for HTTP and respond to a simple API (underspec'd currently) to submit a new manifest.
.fi
2015-01-31 19:08:59 +00:00
.RE
2014-10-09 22:42:04 +00:00
.SH OPTIONS
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- address\fP ="127.0.0.1"
2014-10-09 22:42:04 +00:00
The address for the info server to serve on (set to 0.0.0.0 or "" for all interfaces).
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- allow\_ privileged\fP =false
2014-10-09 22:42:04 +00:00
If true, allow containers to request privileged mode. [default=false].
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- alsologtostderr\fP =false
2014-10-09 22:42:04 +00:00
log to standard error as well as files.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- config\fP =""
2014-10-09 22:42:04 +00:00
Path to the config file or directory of files.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- docker\_ endpoint\fP =""
2014-10-09 22:42:04 +00:00
If non\- empty, use this for the docker endpoint to communicate with.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- enable\_ server\fP =true
2014-10-09 22:42:04 +00:00
Enable the info server.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- etcd\_ servers\fP =[]
2014-10-09 22:42:04 +00:00
List of etcd servers to watch (
\[ la]http://ip:port\[ ra]), comma separated.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- file\_ check\_ frequency\fP =20s
2014-10-09 22:42:04 +00:00
Duration between checking config files for new data.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- hostname\_ override\fP =""
2014-10-09 22:42:04 +00:00
If non\- empty, will use this string as identification instead of the actual hostname.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- http\_ check\_ frequency\fP =20s
2014-10-09 22:42:04 +00:00
Duration between checking http for new data.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- log\_ backtrace\_ at\fP =:0
2014-10-09 22:42:04 +00:00
when logging hits line file:N, emit a stack trace.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- log\_ dir\fP =""
2014-10-09 22:42:04 +00:00
If non\- empty, write log files in this directory.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- log\_ flush\_ frequency\fP =5s
2014-10-09 22:42:04 +00:00
Maximum number of seconds between log flushes.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- logtostderr\fP =false
2014-10-09 22:42:04 +00:00
log to standard error instead of files.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- manifest\_ url\fP =""
2014-10-09 22:42:04 +00:00
URL for accessing the container manifest.
.PP
2015-01-28 23:03:06 +00:00
\fB \- \- pod\_ infra\_ container\_ image\fP ="kubernetes/pause:latest"
The image that pod infra containers in each pod will use.
2014-10-09 22:42:04 +00:00
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- port\fP =10250
2014-10-09 22:42:04 +00:00
The port for the info server to serve on.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- registry\_ burst\fP =10
2014-10-09 22:42:04 +00:00
Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry\_ qps. Only used if \- \- registry\_ qps > 0.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- registry\_ qps\fP =0
2014-10-09 22:42:04 +00:00
If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=0.0].
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- root\_ dir\fP ="/var/lib/kubelet"
2014-10-09 22:42:04 +00:00
Directory path for managing kubelet files (volume mounts,etc).
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- stderrthreshold\fP =0
2014-10-09 22:42:04 +00:00
logs at or above this threshold go to stderr.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- sync\_ frequency\fP =10s
2014-10-09 22:42:04 +00:00
Max period between synchronizing running containers and config.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- v\fP =0
2014-10-09 22:42:04 +00:00
log level for V logs.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- version\fP =false
2014-10-09 22:42:04 +00:00
Print version information and quit.
.PP
2015-01-13 20:02:24 +00:00
\fB \- \- vmodule\fP =
2014-10-09 22:42:04 +00:00
comma\- separated list of pattern=N settings for file\- filtered logging.
2015-01-31 19:08:59 +00:00
2014-10-09 22:42:04 +00:00
.SH EXAMPLES
.PP
.RS
.nf
2014-10-29 17:06:56 +00:00
/usr/bin/kubelet \- \- logtostderr=true \- \- v=0 \- \- etcd\_ servers=http://127.0.0.1:4001 \- \- address=127.0.0.1 \- \- port=10250 \- \- hostname\_ override=127.0.0.1 \- \- allow\_ privileged=false
2014-10-09 22:42:04 +00:00
.fi
2015-01-31 19:08:59 +00:00
.RE
2014-10-09 22:42:04 +00:00
.SH HISTORY
.PP
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.