Merge pull request #2058 from eparis/no-systemd-in-man

remove systemd example files from man pages
This commit is contained in:
Clayton Coleman 2014-10-29 14:12:31 -04:00
commit 935369bacb
10 changed files with 21 additions and 239 deletions

View File

@ -84,32 +84,9 @@ The the kube-apiserver several options.
comma-separated list of pattern=N settings for file-filtered logging comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES # EXAMPLES
```
The kube-apiserver can be called manually or from systemd. An example unit file looks as such: /usr/bin/kube-apiserver --logtostderr=true --v=0 --etcd_servers=http://127.0.0.1:4001 --address=0.0.0.0 --port=8080 --machines=127.0.0.1 --kubelet_port=10250 --allow_privileged=false
```
[Unit]
Description=Kubernetes API Server
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/apiserver
User=kube
ExecStart=/usr/bin/kube-apiserver \
--logtostderr=${KUBE_LOGTOSTDERR} \
--v=${KUBE_LOG_LEVEL} \
--etcd_servers=${KUBE_ETCD_SERVERS} \
--address=${KUBE_API_ADDRESS} \
--port=${KUBE_API_PORT} \
--machines=${MINION_ADDRESSES} \
--minion_port=${MINION_PORT} \
--allow_privileged=${KUBE_ALLOW_PRIV}
Restart=on-failure
[Install]
WantedBy=multi-user.target
Where the variables are stored in the /etc/kubernetes/ environment files.
# HISTORY # HISTORY
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work. on the kubernetes source material and internal work.

View File

@ -63,29 +63,9 @@ The kube-controller-manager has several options.
comma-separated list of pattern=N settings for file-filtered logging. comma-separated list of pattern=N settings for file-filtered logging.
# EXAMPLES # EXAMPLES
```
The kube-controller-manager can be called manually or from systemd. An example unit file looks as such: /usr/bin/kube-controller-manager --logtostderr=true --v=0 --master=127.0.0.1:8080
```
[Unit]
Description=Kubernetes Controller Manager
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/apiserver
EnvironmentFile=/etc/kubernetes/controller-manager
User=kube
ExecStart=/usr/bin/kube-controller-manager \
--logtostderr=${KUBE_LOGTOSTDERR} \
--v=${KUBE_LOG_LEVEL} \
--master=${KUBE_MASTER}
Restart=on-failure
[Install]
WantedBy=multi-user.target
Where the variables are stored in the /etc/kubernetes/ enfironment files.
# HISTORY # HISTORY
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work. on the kubernetes source material and internal work.

View File

@ -58,29 +58,9 @@ The kube-proxy takes several options.
# EXAMPLES # EXAMPLES
```
The kube-proxy can be called manually or from systemd. An example unit file looks as such: /usr/bin/kube-proxy --logtostderr=true --v=0 --etcd_servers=http://127.0.0.1:4001
```
[Unit]
Description=Kubernetes Proxy
# the proxy crashes if etcd isn't reachable.
# https://github.com/GoogleCloudPlatform/kubernetes/issues/1206
After=network.target
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/proxy
ExecStart=/usr/bin/kube-proxy \
--logtostderr=${KUBE_LOGTOSTDERR} \
--v=${KUBE_LOG_LEVEL} \
--etcd_servers=${KUBE_ETCD_SERVERS}
Restart=on-failure
[Install]
WantedBy=multi-user.target
Where the variables are stored in the /etc/kubernetes/ directory.
# HISTORY # HISTORY
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work. on the kubernetes source material and internal work.

View File

@ -57,28 +57,9 @@ The kube-scheduler can take several options.
comma-separated list of pattern=N settings for file-filtered logging. comma-separated list of pattern=N settings for file-filtered logging.
# EXAMPLES # EXAMPLES
```
The kube-scheduler can be called manually or from systemd. An example unit file looks as such: /usr/bin/kube-scheduler --logtostderr=true --v=0 --master=127.0.0.1:8080
```
[Unit]
Description=Kubernetes Scheduler
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/apiserver
EnvironmentFile=/etc/kubernetes/scheduler
ExecStart=/usr/bin/kube-scheduler \
--logtostderr=${KUBE_LOGTOSTDERR} \
--v=${KUBE_LOG_LEVEL} \
--master=${KUBE_MASTER}
Restart=on-failure
[Install]
WantedBy=multi-user.target
Where the variables are stored in the /etc/kubernetes/ environment files.
# HISTORY # HISTORY
October 2014, Originally compiled by Scott Collier (scollier@redhat.com) based October 2014, Originally compiled by Scott Collier (scollier@redhat.com) based
on the kubernetes source material and internal work. on the kubernetes source material and internal work.

View File

@ -97,32 +97,9 @@ There are 4 ways that a container manifest can be provided to the Kubelet:
# EXAMPLES # EXAMPLES
```
The kubelet can be called manually or from systemd. An example unit file looks as such: /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
```
[Unit]
Description=Kubernetes Kubelet
After=docker.socket cadvisor.service
Requires=docker.socket
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/kubelet
ExecStart=/usr/bin/kubelet \
--logtostderr=${KUBE_LOGTOSTDERR} \
--v=${KUBE_LOG_LEVEL} \
--etcd_servers=${KUBE_ETCD_SERVERS} \
--address=${MINION_ADDRESS} \
--port=${MINION_PORT} \
--hostname_override=${MINION_HOSTNAME} \
--allow_privileged=${KUBE_ALLOW_PRIV}
Restart=on-failure
[Install]
WantedBy=multi-user.target
Where the variables are stored in the /etc/kubernetes/ environment files.
# HISTORY # HISTORY
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work. on the kubernetes source material and internal work.

View File

@ -78,7 +78,7 @@ The the kube\-apiserver several options.
Duration of time to cache minion information. Default 30 seconds. Duration of time to cache minion information. Default 30 seconds.
.PP .PP
\fB\-minion\_port\fP=10250 \fB\-kubelet\_port\fP=10250
The port at which kubelet will be listening on the minions. Default is 10250. The port at which kubelet will be listening on the minions. Default is 10250.
.PP .PP
@ -110,39 +110,14 @@ The the kube\-apiserver several options.
comma\-separated list of pattern=N settings for file\-filtered logging comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLES .SH EXAMPLES
.PP
The kube\-apiserver can be called manually or from systemd. An example unit file looks as such:
.PP .PP
.RS .RS
.nf .nf
[Unit] /usr/bin/kube\-apiserver \-\-logtostderr=true \-\-v=0 \-\-etcd\_servers=http://127.0.0.1:4001 \-\-address=0.0.0.0 \-\-port=8080 \-\-machines=127.0.0.1 \-\-kubelet\_port=10250 \-\-allow\_privileged=false
Description=Kubernetes API Server
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/apiserver
User=kube
ExecStart=/usr/bin/kube\-apiserver \\
\-\-logtostderr=\$\{KUBE\_LOGTOSTDERR\} \\
\-\-v=\$\{KUBE\_LOG\_LEVEL\} \\
\-\-etcd\_servers=\$\{KUBE\_ETCD\_SERVERS\} \\
\-\-address=\$\{KUBE\_API\_ADDRESS\} \\
\-\-port=\$\{KUBE\_API\_PORT\} \\
\-\-machines=\$\{MINION\_ADDRESSES\} \\
\-\-minion\_port=\$\{MINION\_PORT\} \\
\-\-allow\_privileged=\$\{KUBE\_ALLOW\_PRIV\}
Restart=on\-failure
[Install]
WantedBy=multi\-user.target
.fi .fi
.PP
Where the variables are stored in the /etc/kubernetes/ environment files.
.SH HISTORY .SH HISTORY
.PP .PP
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based

View File

@ -81,35 +81,14 @@ The kube\-controller\-manager has several options.
comma\-separated list of pattern=N settings for file\-filtered logging. comma\-separated list of pattern=N settings for file\-filtered logging.
.SH EXAMPLES .SH EXAMPLES
.PP
The kube\-controller\-manager can be called manually or from systemd. An example unit file looks as such:
.PP .PP
.RS .RS
.nf .nf
[Unit] /usr/bin/kube\-controller\-manager \-\-logtostderr=true \-\-v=0 \-\-master=127.0.0.1:8080
Description=Kubernetes Controller Manager
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/apiserver
EnvironmentFile=/etc/kubernetes/controller\-manager
User=kube
ExecStart=/usr/bin/kube\-controller\-manager \\
\-\-logtostderr=\$\{KUBE\_LOGTOSTDERR\} \\
\-\-v=\$\{KUBE\_LOG\_LEVEL\} \\
\-\-master=\$\{KUBE\_MASTER\}
Restart=on\-failure
[Install]
WantedBy=multi\-user.target
.fi .fi
.PP
Where the variables are stored in the /etc/kubernetes/ enfironment files.
.SH HISTORY .SH HISTORY
.PP .PP
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based

View File

@ -74,36 +74,14 @@ The kube\-proxy takes several options.
comma\-separated list of pattern=N settings for file\-filtered logging comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLES .SH EXAMPLES
.PP
The kube\-proxy can be called manually or from systemd. An example unit file looks as such:
.PP .PP
.RS .RS
.nf .nf
[Unit] /usr/bin/kube\-proxy \-\-logtostderr=true \-\-v=0 \-\-etcd\_servers=http://127.0.0.1:4001
Description=Kubernetes Proxy
# the proxy crashes if etcd isn't reachable.
# https://github.com/GoogleCloudPlatform/kubernetes/issues/1206
After=network.target
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/proxy
ExecStart=/usr/bin/kube\-proxy \\
\-\-logtostderr=\$\{KUBE\_LOGTOSTDERR\} \\
\-\-v=\$\{KUBE\_LOG\_LEVEL\} \\
\-\-etcd\_servers=\$\{KUBE\_ETCD\_SERVERS\}
Restart=on\-failure
[Install]
WantedBy=multi\-user.target
.fi .fi
.PP
Where the variables are stored in the /etc/kubernetes/ directory.
.SH HISTORY .SH HISTORY
.PP .PP
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based

View File

@ -73,34 +73,14 @@ The kube\-scheduler can take several options.
comma\-separated list of pattern=N settings for file\-filtered logging. comma\-separated list of pattern=N settings for file\-filtered logging.
.SH EXAMPLES .SH EXAMPLES
.PP
The kube\-scheduler can be called manually or from systemd. An example unit file looks as such:
.PP .PP
.RS .RS
.nf .nf
[Unit] /usr/bin/kube\-scheduler \-\-logtostderr=true \-\-v=0 \-\-master=127.0.0.1:8080
Description=Kubernetes Scheduler
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/apiserver
EnvironmentFile=/etc/kubernetes/scheduler
ExecStart=/usr/bin/kube\-scheduler \\
\-\-logtostderr=\$\{KUBE\_LOGTOSTDERR\} \\
\-\-v=\$\{KUBE\_LOG\_LEVEL\} \\
\-\-master=\$\{KUBE\_MASTER\}
Restart=on\-failure
[Install]
WantedBy=multi\-user.target
.fi .fi
.PP
Where the variables are stored in the /etc/kubernetes/ environment files.
.SH HISTORY .SH HISTORY
.PP .PP
October 2014, Originally compiled by Scott Collier (scollier@redhat.com) based October 2014, Originally compiled by Scott Collier (scollier@redhat.com) based

View File

@ -129,39 +129,14 @@ HTTP server The kubelet can also listen for HTTP and respond to a simple API (un
comma\-separated list of pattern=N settings for file\-filtered logging. comma\-separated list of pattern=N settings for file\-filtered logging.
.SH EXAMPLES .SH EXAMPLES
.PP
The kubelet can be called manually or from systemd. An example unit file looks as such:
.PP .PP
.RS .RS
.nf .nf
[Unit] /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
Description=Kubernetes Kubelet
After=docker.socket cadvisor.service
Requires=docker.socket
[Service]
EnvironmentFile=/etc/kubernetes/config
EnvironmentFile=/etc/kubernetes/kubelet
ExecStart=/usr/bin/kubelet \\
\-\-logtostderr=\$\{KUBE\_LOGTOSTDERR\} \\
\-\-v=\$\{KUBE\_LOG\_LEVEL\} \\
\-\-etcd\_servers=\$\{KUBE\_ETCD\_SERVERS\} \\
\-\-address=\$\{MINION\_ADDRESS\} \\
\-\-port=\$\{MINION\_PORT\} \\
\-\-hostname\_override=\$\{MINION\_HOSTNAME\} \\
\-\-allow\_privileged=\$\{KUBE\_ALLOW\_PRIV\}
Restart=on\-failure
[Install]
WantedBy=multi\-user.target
.fi .fi
.PP
Where the variables are stored in the /etc/kubernetes/ environment files.
.SH HISTORY .SH HISTORY
.PP .PP
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based