Skip to content

Commit

Permalink
Add missing flag description; regenerate man1
Browse files Browse the repository at this point in the history
  • Loading branch information
Deyuan Deng committed Feb 26, 2015
1 parent eedd9ec commit 660428b
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 45 deletions.
8 changes: 4 additions & 4 deletions docs/man/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Markdown (*.md) files.

# File List

kube-apiserver.1.md
kube-controller-manager.1.md
kubelet.1.md
kube-proxy.1.md
kube-apiserver.1.md
kube-controller-manager.1.md
kubelet.1.md
kube-proxy.1.md
kube-scheduler.1.md
Dockerfile
md2man-all.sh
Expand Down
10 changes: 8 additions & 2 deletions docs/man/kube-controller-manager.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,11 @@ The kube-controller-manager has several options.
**--machines**=[]
List of machines to schedule onto, comma separated.

**--pod_eviction_timeout**=5m
The grace peroid for deleting pods on failed nodes.

**--sync_nodes**=true
If true, and --cloud_provider is specified, sync nodes from the cloud provider. Default true.
If true, and --cloud_provider is specified, sync nodes from the cloud provider. Default true.

**--master**=""
The address of the Kubernetes API server.
Expand All @@ -66,7 +69,10 @@ The kube-controller-manager has several options.
The period for syncing nodes from cloudprovider.

**--port**=10252
The port that the controller-manager's http service runs on.
The port that the controller-manager's http service runs on.

**--resource_quota_sync_period**=10s
The period for syncing quota usage status in the system.

**--stderrthreshold**=0
logs at or above this threshold go to stderr.
Expand Down
7 changes: 0 additions & 7 deletions docs/man/man1/kube-apiserver.1
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Scott Collier" "October 2014" ""


.SH NAME
.PP
kube\-apiserver \- Provides the API for kubernetes orchestration.


.SH SYNOPSIS
.PP
\fBkube\-apiserver\fP [OPTIONS]


.SH DESCRIPTION
.PP
The \fBkubernetes\fP API server validates and configures data for 3 types of objects: pods, services, and replicationControllers. Beyond just servicing REST operations, the API Server does two other things as well: 1. Schedules pods to worker nodes. Right now the scheduler is very simple. 2. Synchronize pod information (where they are, what ports they are exposing) with the service configuration.

.PP
The the kube\-apiserver several options.


.SH OPTIONS
.PP
\fB\-\-address\fP=""
Expand Down Expand Up @@ -97,7 +93,6 @@ The the kube\-apiserver several options.
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging


.SH EXAMPLES
.PP
.RS
Expand All @@ -106,8 +101,6 @@ The the kube\-apiserver several options.
/usr/bin/kube\-apiserver \-\-logtostderr=true \-\-v=0 \-\-etcd\_servers=http://127.0.0.1:4001 \-\-address=0.0.0.0 \-\-port=8080 \-\-kubelet\_port=10250 \-\-allow\_privileged=false

.fi
.RE


.SH HISTORY
.PP
Expand Down
23 changes: 14 additions & 9 deletions docs/man/man1/kube-controller-manager.1
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Scott Collier" "October 2014" ""


.SH NAME
.PP
kube\-controller\-manager \- Enforces kubernetes services.


.SH SYNOPSIS
.PP
\fBkube\-controller\-manager\fP [OPTIONS]


.SH DESCRIPTION
.PP
The \fBkubernetes\fP controller manager is really a service that is layered on top of the simple pod API. To enforce this layering, the logic for the replicationController is actually broken out into another server. This server watches etcd for changes to replicationController objects and then uses the public Kubernetes API to implement the replication algorithm.

.PP
The kube\-controller\-manager has several options.


.SH OPTIONS
.PP
\fB\-\-address\fP=""
Expand Down Expand Up @@ -50,7 +46,7 @@ The kube\-controller\-manager has several options.

.PP
\fB\-\-minion\_regexp\fP=""
If non empty, and \-cloud\_provider is specified, a regular expression for matching minion VMs.
If non empty, and \-\-cloud\_provider is specified, a regular expression for matching minion VMs.

.PP
\fB\-\-insecure\_skip\_tls\_verify\fP=false
Expand All @@ -76,18 +72,30 @@ The kube\-controller\-manager has several options.
\fB\-\-machines\fP=[]
List of machines to schedule onto, comma separated.

.PP
\fB\-\-pod\_eviction\_timeout\fP=5m
The grace peroid for deleting pods on failed nodes.

.PP
\fB\-\-sync\_nodes\fP=true
If true, and \-\-cloud\_provider is specified, sync nodes from the cloud provider. Default true.

.PP
\fB\-\-master\fP=""
The address of the Kubernetes API server.

.PP
\fB\-\-node\_sync\_peroid\fP=10s
\fB\-\-node\_sync\_period\fP=10s
The period for syncing nodes from cloudprovider.

.PP
\fB\-\-port\fP=10252
The port that the controller\-manager's http service runs on.

.PP
\fB\-\-resource\_quota\_sync\_period\fP=10s
The period for syncing quota usage status in the system.

.PP
\fB\-\-stderrthreshold\fP=0
logs at or above this threshold go to stderr.
Expand All @@ -104,7 +112,6 @@ The kube\-controller\-manager has several options.
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging.


.SH EXAMPLES
.PP
.RS
Expand All @@ -113,8 +120,6 @@ The kube\-controller\-manager has several options.
/usr/bin/kube\-controller\-manager \-\-logtostderr=true \-\-v=0 \-\-master=127.0.0.1:8080

.fi
.RE


.SH HISTORY
.PP
Expand Down
7 changes: 0 additions & 7 deletions docs/man/man1/kube-proxy.1
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Scott Collier" "October 2014" ""


.SH NAME
.PP
kube\-proxy \- Provides network proxy services.


.SH SYNOPSIS
.PP
\fBkube\-proxy\fP [OPTIONS]


.SH DESCRIPTION
.PP
The \fBkubernetes\fP network proxy runs on each node. This reflects services as defined in the Kubernetes API on each node and can do simple TCP stream forwarding or round robin TCP forwarding across a set of backends. Service endpoints are currently found through Docker\-links\-compatible environment variables specifying ports opened by the service proxy. Currently the user must select a port to expose the service on on the proxy, as well as the container's port to target.

.PP
The kube\-proxy takes several options.


.SH OPTIONS
.PP
\fB\-\-alsologtostderr\fP=false
Expand Down Expand Up @@ -77,7 +73,6 @@ The kube\-proxy takes several options.
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging


.SH EXAMPLES
.PP
.RS
Expand All @@ -86,8 +81,6 @@ The kube\-proxy takes several options.
/usr/bin/kube\-proxy \-\-logtostderr=true \-\-v=0 \-\-etcd\_servers=http://127.0.0.1:4001

.fi
.RE


.SH HISTORY
.PP
Expand Down
7 changes: 0 additions & 7 deletions docs/man/man1/kube-scheduler.1
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Scott Collier" "October 2014" ""


.SH NAME
.PP
kube\-scheduler \- Schedules containers on hosts.


.SH SYNOPSIS
.PP
\fBkube\-scheduler\fP [OPTIONS]


.SH DESCRIPTION
.PP
The \fBkubernetes\fP scheduler is a policy\-rich, topology\-aware, workload\-specific function that significantly impacts availability, performance, and capacity. The scheduler needs to take into account individual and collective resource requirements, quality of service requirements, hardware/software/policy constraints, affinity and anti\-affinity specifications, data locality, inter\-workload interference, deadlines, and so on. Workload\-specific requirements will be exposed through the API as necessary.

.PP
The kube\-scheduler can take several options.


.SH OPTIONS
.PP
\fB\-\-address=\fP"127.0.0.1"
Expand Down Expand Up @@ -76,7 +72,6 @@ The kube\-scheduler can take several options.
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging.


.SH EXAMPLES
.PP
.RS
Expand All @@ -85,8 +80,6 @@ The kube\-scheduler can take several options.
/usr/bin/kube\-scheduler \-\-logtostderr=true \-\-v=0 \-\-master=127.0.0.1:8080

.fi
.RE


.SH HISTORY
.PP
Expand Down
10 changes: 1 addition & 9 deletions docs/man/man1/kubelet.1
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Scott Collier" "October 2014" ""


.SH NAME
.PP
kubelet \- Processes a container manifest so the containers are launched according to how they are described.


.SH SYNOPSIS
.PP
\fBkubelet\fP [OPTIONS]


.SH DESCRIPTION
.PP
The \fBkubernetes\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.
Expand All @@ -24,12 +21,10 @@ There are 4 ways that a container manifest can be provided to the Kubelet:
.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).
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.
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.
HTTP server The kubelet can also listen for HTTP and respond to a simple API (underspec'd currently) to submit a new manifest.

.fi
.RE


.SH OPTIONS
.PP
Expand Down Expand Up @@ -133,7 +128,6 @@ HTTP server The kubelet can also listen for HTTP and respond to a simple API (un
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging.


.SH EXAMPLES
.PP
.RS
Expand All @@ -142,8 +136,6 @@ HTTP server The kubelet can also listen for HTTP and respond to a simple API (un
/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

.fi
.RE


.SH HISTORY
.PP
Expand Down

0 comments on commit 660428b

Please sign in to comment.