github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

updated kubernetes daemon docs 

These docs are not autogenerated. They are generated from specially formated
markdown files that need to be updated when flags are changed but nobody knows
about this so it is not enforced. Thus the man page generation is not useful.
For the sake of having up to date docs up to date for v1, I am manually udating
the markdown files and removing the md2man generation. After v1 we need to gen
this man pages with the rest of our generated docs in a pre commit hook so that
they are not able to become out of date. We can do this by converting our daemons
to use cobra cmd like kubectl.
pull/6/head
Mike Danese 2015-06-26 11:39:14 -07:00
parent 91589143a3
commit ff6d67e18c
18 changed files with 318 additions and 1788 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/man/Dockerfile
View File

@ -1,7 +0,0 @@
FROM golang:1.3
RUN mkdir -p /go/src/github.com/cpuguy83
RUN mkdir -p /go/src/github.com/cpuguy83 \
&& git clone -b v1 https://github.com/cpuguy83/go-md2man.git /go/src/github.com/cpuguy83/go-md2man \
&& cd /go/src/github.com/cpuguy83/go-md2man \
&& go get -v ./...
CMD ["/go/bin/go-md2man", "--help"]

46
docs/man/README.md
View File

@ -1,46 +0,0 @@
Kubernetes Documentation
====================
This directory contains the Kubernetes user manual in the Markdown format.
Do *not* edit the man pages in the man1 directory. Instead, amend the
Markdown (*.md) files.
# File List
kube-apiserver.1.md
kube-controller-manager.1.md
kubelet.1.md
kube-proxy.1.md
kube-scheduler.1.md
Dockerfile
md2man-all.sh
# Generating man pages from the Markdown files
The recommended approach for generating the man pages is via a Docker
container using the supplied `Dockerfile` to create an image with the correct
environment. This uses `go-md2man`, a pure Go Markdown to man page generator.
## Building the md2man image
There is a `Dockerfile` provided in the `kubernetes/docs/man` directory.
Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
docker build -t docker/md2man .
## Utilizing the image
Once the image is built, run a container using the image with *volumes*:
docker run -v /<path-to-git-dir>/kubernetes/docs/man:/docs:rw \
-w /docs -i docker/md2man /docs/md2man-all.sh
The `md2man` Docker container will process the Markdown files and generate
the man pages inside the `docker/docs/man/man1` directory using
Docker volumes. For more information on Docker volumes see the man page for
`docker run` and also look at the article [Sharing Directories via Volumes]
(http://docs.docker.com/use/working_with_volumes/).
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/README.md?pixel)]()

195
docs/man/kube-apiserver.1.md
View File

@ -1,195 +0,0 @@
% KUBERNETES(1) kubernetes User Manuals
% Scott Collier
% October 2014
# NAME
kube-apiserver \- Provides the API for kubernetes orchestration.
# SYNOPSIS
**kube-apiserver** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
The the kube-apiserver several options.
# OPTIONS
**--address**=127.0.0.1
DEPRECATED: see --insecure-bind-address instead
**--admission-control**="AlwaysAdmit"
Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysDeny, AlwaysAdmit, ServiceAccount, NamespaceExists, NamespaceLifecycle, NamespaceAutoProvision, LimitRanger, SecurityContextDeny, ResourceQuota
**--admission-control-config-file**=""
File with admission control configuration.
**--allow-privileged**=false
If true, allow privileged containers.
**--alsologtostderr**=false
log to standard error as well as files
**--api-burst**=200
API burst amount for the read only port
**--api-prefix**="/api"
The prefix for API requests on the server. Default '/api'.
**--api-rate**=10
API rate limit as QPS for the read only port
**--authorization-mode**="AlwaysAllow"
Selects how to do authorization on the secure port. One of: AlwaysAllow,AlwaysDeny,ABAC
**--authorization-policy-file**=""
File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port.
**--basic-auth-file**=""
If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.
**--bind-address**=0.0.0.0
The IP address on which to serve the --read-only-port and --secure-port ports. This address must be reachable by the rest of the cluster. If blank, all interfaces will be used.
**--cert-dir**="/var/run/kubernetes"
The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
**--client-ca-file**=""
If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
**--cloud-config**=""
The path to the cloud provider configuration file. Empty string for no configuration file.
**--cloud-provider**=""
The provider for cloud services. Empty string for no provider.
**--cluster-name**="kubernetes"
The instance prefix for the cluster
**--cors-allowed-origins**=[]
List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.
**--etcd-config**=""
The config file for the etcd client. Mutually exclusive with -etcd-servers.
**--etcd-prefix**="/registry"
The prefix for all resource paths in etcd.
**--etcd-servers**=[]
List of etcd servers to watch (http://ip:port), comma separated. Mutually exclusive with -etcd-config
**--event-ttl**=1h0m0s
Amount of time to retain events. Default 1 hour.
**--external-hostname**=""
The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs.)
**--insecure-bind-address**=127.0.0.1
The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost.
**--insecure-port**=8080
The port on which to serve unsecured, unauthenticated access. Default 8080. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster and that port 443 on the cluster's public address is proxied to this port. This is performed by nginx in the default setup.
**--kubelet_certificate_authority**=""
Path to a cert. file for the certificate authority.
**--kubelet_client_certificate**=""
Path to a client key file for TLS.
**--kubelet_client_key**=""
Path to a client key file for TLS.
**--kubelet_https**=true
Use https for kubelet connections
**--kubelet_port**=10250
Kubelet port
**--kubelet_timeout**=5s
Timeout for kubelet operations
**--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
**--long-running-request-regexp**="[.*\\/watch$][^\\/proxy.*]"
A regular expression matching long running requests which should be excluded from maximum inflight request handling.
**--master-service-namespace**="default"
The namespace from which the kubernetes master services should be injected into pods
**--max-requests-inflight**=400
The maximum number of requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.
**--old-etcd-prefix**="/registry"
The previous prefix for all resource paths in etcd, if any.
**--port**=8080
DEPRECATED: see --insecure-port instead
**--service-cluster-ip-range**=<nil>
A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.
**--profiling**=true
Enable profiling via web interface host:port/debug/pprof/
**--public-address-override**=0.0.0.0
DEPRECATED: see --bind-address instead
**--read-only-port**=7080
The port on which to serve read-only resources. If 0, don't serve read-only at all. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster.
**--runtime-config**=
A set of key=value pairs that describe runtime configuration that may be passed to the apiserver. api/<version> key can be used to turn on/off specific api versions. api/all and api/legacy are special keys to control all and legacy api versions respectively.
**--secure-port**=6443
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
**--service-account-key-file**=""
File containing PEM-encoded x509 RSA private or public key, used to verify ServiceAccount tokens. If unspecified, --tls-private-key-file is used.
**--service-account-lookup**=false
If true, validate ServiceAccount tokens exist in etcd as part of authentication.
**--stderrthreshold**=2
logs at or above this threshold go to stderr
**--storage-version**=""
The version to store resources with. Defaults to server preferred
**--tls-cert-file**=""
File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes.
**--tls-private-key-file**=""
File containing x509 private key matching --tls-cert-file.
**--token-auth-file**=""
If set, the file that will be used to secure the secure port of the API server via token authentication.
**--v**=0
log level for V logs
**--version**=false
Print version information and quit
**--vmodule**=
comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kube-apiserver --logtostderr=true --v=0 --etcd_servers=http://127.0.0.1:4001 --insecure_bind_address=127.0.0.1 --insecure_port=8080 --kubelet_port=10250 --service-cluster-ip-range=10.1.1.0/24 --allow_privileged=false
```
# HISTORY
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kube-apiserver.1.md?pixel)]()

82
docs/man/kube-apiserver.md Normal file
View File

@ -0,0 +1,82 @@
# NAME
kube-apiserver \- Provides the API for kubernetes orchestration.
# SYNOPSIS
**kube-apiserver** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
The the kube-apiserver several options.
# OPTIONS
* **--address=127.0.0.1**: DEPRECATED: see --insecure-bind-address instead
* **--admission-control="AlwaysAdmit"**: Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: NamespaceAutoProvision, DenyExecOnPrivileged, AlwaysAdmit, LimitRanger, AlwaysDeny, ServiceAccount, SecurityContextDeny, ResourceQuota, NamespaceLifecycle, NamespaceExists
* **--admission-control-config-file=""**: File with admission control configuration.
* **--advertise-address=<nil>**: The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.
* **--allow-privileged=false**: If true, allow privileged containers.
* **--alsologtostderr=false**: log to standard error as well as files
* **--api-burst=200**: API burst amount for the read only port
* **--api-prefix="/api"**: The prefix for API requests on the server. Default '/api'.
* **--api-rate=10**: API rate limit as QPS for the read only port
* **--authorization-mode="AlwaysAllow"**: Selects how to do authorization on the secure port. One of: AlwaysAllow,AlwaysDeny,ABAC
* **--authorization-policy-file=""**: File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port.
* **--basic-auth-file=""**: If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.
* **--bind-address=0.0.0.0**: The IP address on which to serve the --read-only-port and --secure-port ports. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0).
* **--cert-dir="/var/run/kubernetes"**: The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
* **--client-ca-file=""**: If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
* **--cloud-config=""**: The path to the cloud provider configuration file. Empty string for no configuration file.
* **--cloud-provider=""**: The provider for cloud services. Empty string for no provider.
* **--cluster-name="kubernetes"**: The instance prefix for the cluster
* **--cors-allowed-origins=[]**: List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.
* **--etcd-config=""**: The config file for the etcd client. Mutually exclusive with -etcd-servers.
* **--etcd-prefix="/registry"**: The prefix for all resource paths in etcd.
* **--etcd-servers=[]**: List of etcd servers to watch (http://ip:port), comma separated. Mutually exclusive with -etcd-config
* **--event-ttl=1h0m0s**: Amount of time to retain events. Default 1 hour.
* **--external-hostname=""**: The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs.)
* **--httptest.serve=**: if non-empty, httptest.NewServer serves on this address and blocks
* **--insecure-bind-address=127.0.0.1**: The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost.
* **--insecure-port=8080**: The port on which to serve unsecured, unauthenticated access. Default 8080. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster and that port 443 on the cluster's public address is proxied to this port. This is performed by nginx in the default setup.
* **--kubelet-certificate-authority=""**: Path to a cert. file for the certificate authority.
* **--kubelet-client-certificate=""**: Path to a client key file for TLS.
* **--kubelet-client-key=""**: Path to a client key file for TLS.
* **--kubelet-https=true**: Use https for kubelet connections
* **--kubelet-port=10250**: Kubelet port
* **--kubelet-timeout=5s**: Timeout for kubelet operations
* **--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
* **--long-running-request-regexp="(/|^)((watch|proxy)(/|$)|(logs|portforward|exec)/?$)"**: A regular expression matching long running requests which should be excluded from maximum inflight request handling.
* **--master-service-namespace="default"**: The namespace from which the kubernetes master services should be injected into pods
* **--max-requests-inflight=400**: The maximum number of requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.
* **--min-request-timeout=1800**: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.
* **--old-etcd-prefix="/registry"**: The previous prefix for all resource paths in etcd, if any.
* **--port=8080**: DEPRECATED: see --insecure-port instead
* **--profiling=true**: Enable profiling via web interface host:port/debug/pprof/
* **--public-address-override=0.0.0.0**: DEPRECATED: see --bind-address instead
* **--runtime-config=**: A set of key=value pairs that describe runtime configuration that may be passed to the apiserver. api/<version> key can be used to turn on/off specific api versions. api/all and api/legacy are special keys to control all and legacy api versions respectively.
* **--secure-port=6443**: The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
* **--service-account-key-file=""**: File containing PEM-encoded x509 RSA private or public key, used to verify ServiceAccount tokens. If unspecified, --tls-private-key-file is used.
* **--service-account-lookup=false**: If true, validate ServiceAccount tokens exist in etcd as part of authentication.
* **--service-cluster-ip-range=<nil>**: A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.
* **--service-node-port-range=**: A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range.
* **--ssh-keyfile=""**: If non-empty, use secure SSH proxy to the nodes, using this user keyfile
* **--ssh-user=""**: If non-empty, use secure SSH proxy to the nodes, using this user name
* **--stderrthreshold=2**: logs at or above this threshold go to stderr
* **--storage-version=""**: The version to store resources with. Defaults to server preferred
* **--tls-cert-file=""**: File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes.
* **--tls-private-key-file=""**: File containing x509 private key matching --tls-cert-file.
* **--token-auth-file=""**: If set, the file that will be used to secure the secure port of the API server via token authentication.
* **--v=0**: log level for V logs
* **--version=false**: Print version information and quit
* **--vmodule=**: comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kube-apiserver --logtostderr=true --v=0 --etcd_servers=http://127.0.0.1:4001 --insecure_bind_address=127.0.0.1 --insecure_port=8080 --kubelet_port=10250 --service-cluster-ip-range=10.1.1.0/24 --allow_privileged=false
```
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kube-apiserver.md?pixel)]()

123
docs/man/kube-controller-manager.1.md
View File

@ -1,123 +0,0 @@
% KUBERNETES(1) kubernetes User Manuals
% Scott Collier
% October 2014
# NAME
kube-controller-manager \- Enforces kubernetes services.
# SYNOPSIS
**kube-controller-manager** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
The kube-controller-manager has several options.
# OPTIONS
**--address**=127.0.0.1
The IP address to serve on (set to 0.0.0.0 for all interfaces)
**--allocate-node-cidrs**=false
Should CIDRs for Pods be allocated and set on the cloud provider.
**--alsologtostderr**=false
log to standard error as well as files
**--cloud-config**=""
The path to the cloud provider configuration file. Empty string for no configuration file.
**--cloud-provider**=""
The provider for cloud services. Empty string for no provider.
**--cluster-cidr**=<nil>
CIDR Range for Pods in cluster.
**--concurrent-endpoint-syncs**=5
The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load
**--concurrent_rc_syncs**=5
The number of replication controllers that are allowed to sync concurrently. Larger number = more reponsive replica management, but more CPU (and network) load
**--deleting-pods-burst**=10
Number of nodes on which pods are bursty deleted in case of node failure. For more details look into RateLimiter.
**--deleting-pods-qps**=0.1
Number of nodes per second on which pods are deleted in case of node failure.
**--kubeconfig**=""
Path to kubeconfig file with authorization and master location information.
**--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
**--master**=""
The address of the Kubernetes API server (overrides any value in kubeconfig)
**--namespace-sync-period**=5m0s
The period for syncing namespace life-cycle updates
**--node-monitor-grace-period**=40s
Amount of time which we allow running Node to be unresponsive before marking it unhealty. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status.
**--node-monitor-period**=5s
The period for syncing NodeStatus in NodeController.
**--node-startup-grace-period**=1m0s
Amount of time which we allow starting Node to be unresponsive before marking it unhealty.
**--node-sync-period**=10s
The period for syncing nodes from cloudprovider. Longer periods will result in fewer calls to cloud provider, but may delay addition of new nodes to cluster.
**--pod-eviction-timeout**=5m0s
The grace period for deleting pods on failed nodes.
**--port**=10252
The port that the controller-manager's http service runs on
**--profiling**=true
Enable profiling via web interface host:port/debug/pprof/
**--pvclaimbinder-sync-period**=10s
The period for syncing persistent volumes and persistent volume claims
**--register-retry-count**=10
The number of retries for initial node registration. Retry interval equals node-sync-period.
**--resource-quota-sync-period**=10s
The period for syncing quota usage status in the system
**--service-account-private-key-file**=""
Filename containing a PEM-encoded private RSA key used to sign service account tokens.
**--stderrthreshold**=2
logs at or above this threshold go to stderr
**--v**=0
log level for V logs
**--version**=false
Print version information and quit
**--vmodule**=
comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kube-controller-manager --logtostderr=true --v=0 --master=127.0.0.1:8080
```
# HISTORY
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kube-controller-manager.1.md?pixel)]()

56
docs/man/kube-controller-manager.md Normal file
View File

@ -0,0 +1,56 @@
# NAME
kube-controller-manager \- Enforces kubernetes services.
# SYNOPSIS
**kube-controller-manager** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
The kube-controller-manager has several options.
# OPTIONS
* **--address=127.0.0.1**: The IP address to serve on (set to 0.0.0.0 for all interfaces)
* **--allocate-node-cidrs=false**: Should CIDRs for Pods be allocated and set on the cloud provider.
* **--alsologtostderr=false**: log to standard error as well as files
* **--cloud-config=""**: The path to the cloud provider configuration file. Empty string for no configuration file.
* **--cloud-provider=""**: The provider for cloud services. Empty string for no provider.
* **--cluster-cidr=<nil>**: CIDR Range for Pods in cluster.
* **--cluster-name="kubernetes"**: The instance prefix for the cluster
* **--concurrent-endpoint-syncs=5**: The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load
* **--concurrent-rc-syncs=5**: The number of replication controllers that are allowed to sync concurrently. Larger number = more reponsive replica management, but more CPU (and network) load
* **--deleting-pods-burst=10**: Number of nodes on which pods are bursty deleted in case of node failure. For more details look into RateLimiter.
* **--deleting-pods-qps=0.1**: Number of nodes per second on which pods are deleted in case of node failure.
* **--httptest.serve=**: if non-empty, httptest.NewServer serves on this address and blocks
* **--kubeconfig=""**: Path to kubeconfig file with authorization and master location information.
* **--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
* **--master=""**: The address of the Kubernetes API server (overrides any value in kubeconfig)
* **--namespace-sync-period=5m0s**: The period for syncing namespace life-cycle updates
* **--node-monitor-grace-period=40s**: Amount of time which we allow running Node to be unresponsive before marking it unhealty. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status.
* **--node-monitor-period=5s**: The period for syncing NodeStatus in NodeController.
* **--node-startup-grace-period=1m0s**: Amount of time which we allow starting Node to be unresponsive before marking it unhealty.
* **--node-sync-period=10s**: The period for syncing nodes from cloudprovider. Longer periods will result in fewer calls to cloud provider, but may delay addition of new nodes to cluster.
* **--pod-eviction-timeout=5m0s**: The grace peroid for deleting pods on failed nodes.
* **--port=10252**: The port that the controller-manager's http service runs on
* **--profiling=true**: Enable profiling via web interface host:port/debug/pprof/
* **--pvclaimbinder-sync-period=10s**: The period for syncing persistent volumes and persistent volume claims
* **--register-retry-count=10**: The number of retries for initial node registration. Retry interval equals node-sync-period.
* **--resource-quota-sync-period=10s**: The period for syncing quota usage status in the system
* **--root-ca-file=""**: If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle.
* **--service-account-private-key-file=""**: Filename containing a PEM-encoded private RSA key used to sign service account tokens.
* **--stderrthreshold=2**: logs at or above this threshold go to stderr
* **--v=0**: log level for V logs
* **--version=false**: Print version information and quit
* **--vmodule=**: comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kube-controller-manager --logtostderr=true --v=0 --master=127.0.0.1:8080
```
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kube-controller-manager.md?pixel)]()

75
docs/man/kube-proxy.1.md
View File

@ -1,75 +0,0 @@
% KUBERNETES(1) kubernetes User Manuals
% Scott Collier
% October 2014
# NAME
kube-proxy \- Provides network proxy services.
# SYNOPSIS
**kube-proxy** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
The kube-proxy takes several options.
# OPTIONS
**--alsologtostderr**=false
log to standard error as well as files
**--bind-address**=0.0.0.0
The IP address for the proxy server to serve on (set to 0.0.0.0 for all interfaces)
**--healthz-bind-address**=127.0.0.1
The IP address for the health check server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces)
**--healthz-port**=10249
The port to bind the health check server. Use 0 to disable.
**--kubeconfig**=""
Path to kubeconfig file with authorization information (the master location is set by the master flag).
**--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
**--master**=""
The address of the Kubernetes API server (overrides any value in kubeconfig)
**--oom-score-adj**=-899
The oom_score_adj value for kube-proxy process. Values must be within the range [-1000, 1000]
**--resource-container**="/kube-proxy"
Absolute name of the resource-only container to create and run the Kube-proxy in (Default: /kube-proxy).
**--stderrthreshold**=2
logs at or above this threshold go to stderr
**--v**=0
log level for V logs
**--version**=false
Print version information and quit
**--vmodule**=
comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kube-proxy --logtostderr=true --v=0 --master=http://127.0.0.1:8080
```
# HISTORY
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kube-proxy.1.md?pixel)]()

38
docs/man/kube-proxy.md Normal file
View File

@ -0,0 +1,38 @@
#NAME
kube-proxy \- Provides network proxy services.
# SYNOPSIS
**kube-proxy** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
The kube-proxy takes several options.
# OPTIONS
* **--alsologtostderr=false**: log to standard error as well as files
* **--bind-address=0.0.0.0**: The IP address for the proxy server to serve on (set to 0.0.0.0 for all interfaces)
* **--healthz-bind-address=127.0.0.1**: The IP address for the health check server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces)
* **--healthz-port=10249**: The port to bind the health check server. Use 0 to disable.
* **--kubeconfig=""**: Path to kubeconfig file with authorization information (the master location is set by the master flag).
* **--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
* **--master=""**: The address of the Kubernetes API server (overrides any value in kubeconfig)
* **--oom-score-adj=-899**: The oom_score_adj value for kube-proxy process. Values must be within the range [-1000, 1000]
* **--proxy-port-range=**: Range of host ports (beginPort-endPort, inclusive) that may be consumed in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen.
* **--resource-container="/kube-proxy"**: Absolute name of the resource-only container to create and run the Kube-proxy in (Default: /kube-proxy).
* **--stderrthreshold=2**: logs at or above this threshold go to stderr
* **--v=0**: log level for V logs
* **--version=false**: Print version information and quit
* **--vmodule=**: comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kube-proxy --logtostderr=true --v=0 --master=http://127.0.0.1:8080
```
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kube-proxy.md?pixel)]()

75
docs/man/kube-scheduler.1.md
View File

@ -1,75 +0,0 @@
% KUBERNETES(1) kubernetes User Manuals
% Scott Collier
% October 2014
# NAME
kube-scheduler \- Schedules containers on hosts.
# SYNOPSIS
**kube-scheduler** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
The kube-scheduler can take several options.
# OPTIONS
**--address**=127.0.0.1
The IP address to serve on (set to 0.0.0.0 for all interfaces)
**--algorithm-provider**="DefaultProvider"
The scheduling algorithm provider to use, one of: DefaultProvider
**--alsologtostderr**=false
log to standard error as well as files
**--kubeconfig**=""
Path to kubeconfig file with authorization and master location information.
**--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
**--master**=""
The address of the Kubernetes API server (overrides any value in kubeconfig)
**--policy-config-file**=""
File with scheduler policy configuration
**--port**=10251
The port that the scheduler's http service runs on
**--profiling**=true
Enable profiling via web interface host:port/debug/pprof/
**--stderrthreshold**=2
logs at or above this threshold go to stderr
**--v**=0
log level for V logs
**--version**=false
Print version information and quit
**--vmodule**=
comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kube-scheduler --logtostderr=true --v=0 --master=127.0.0.1:8080
```
# HISTORY
October 2014, Originally compiled by Scott Collier (scollier@redhat.com) based
on the kubernetes source material and internal work.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kube-scheduler.1.md?pixel)]()

37
docs/man/kube-scheduler.md Normal file
View File

@ -0,0 +1,37 @@
# NAME
kube-scheduler \- Schedules containers on hosts.
# SYNOPSIS
**kube-scheduler** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
The kube-scheduler can take several options.
# OPTIONS
* **--address=127.0.0.1**: The IP address to serve on (set to 0.0.0.0 for all interfaces)
* **--algorithm-provider="DefaultProvider"**: The scheduling algorithm provider to use, one of: DefaultProvider
* **--alsologtostderr=false**: log to standard error as well as files
* **--kubeconfig=""**: Path to kubeconfig file with authorization and master location information.
* **--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
* **--master=""**: The address of the Kubernetes API server (overrides any value in kubeconfig)
* **--policy-config-file=""**: File with scheduler policy configuration
* **--port=10251**: The port that the scheduler's http service runs on
* **--profiling=true**: Enable profiling via web interface host:port/debug/pprof/
* **--stderrthreshold=2**: logs at or above this threshold go to stderr
* **--v=0**: log level for V logs
* **--version=false**: Print version information and quit
* **--vmodule=**: comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kube-scheduler --logtostderr=true --v=0 --master=127.0.0.1:8080
```
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kube-scheduler.md?pixel)]()

250
docs/man/kubelet.1.md
View File

@ -1,250 +0,0 @@
% KUBERNETES(1) kubernetes User Manuals
% Scott Collier
% October 2014
# NAME
kubelet \- Processes a container manifest so the containers are launched according to how they are described.
# SYNOPSIS
**kubelet** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
There are 3 ways that a container manifest can be provided to the Kubelet:
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).
HTTP server: The kubelet can also listen for HTTP and respond to a simple API (underspec'd currently) to submit a new manifest.
# OPTIONS
**--address**=0.0.0.0
The IP address for the info server to serve on (set to 0.0.0.0 for all interfaces)
**--allow_dynamic_housekeeping**=true
Whether to allow the housekeeping interval to be dynamic
**--allow-privileged**=false
If true, allow containers to request privileged mode. [default=false]
**--alsologtostderr**=false
log to standard error as well as files
**--api-servers**=[]
List of Kubernetes API servers for publishing events, and reading pods and services. (ip:port), comma separated.
**--boot_id_file**=/proc/sys/kernel/random/boot_id
Comma-separated list of files to check for boot-id. Use the first one that exists.
**--cadvisor-port**=4194
The port of the localhost cAdvisor endpoint
**--cert-dir**="/var/run/kubernetes"
The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls_cert_file and --tls_private_key_file are provided, this flag will be ignored.
**--cgroup_root**=""
Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.
**--cloud-config**=""
The path to the cloud provider configuration file. Empty string for no configuration file.
**--cloud-provider**=""
The provider for cloud services. Empty string for no provider.
**--cluster-dns**=<nil>
IP address for a cluster DNS server. If set, kubelet will configure all containers to use this for DNS resolution in addition to the host's DNS servers
**--cluster-domain**=""
Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains
**--config**=""
Path to the config file or directory of files
**--configure-cbr0**=false
If true, kubelet will configure cbr0 based on Node.Spec.PodCIDR.
**--container_hints**=/etc/cadvisor/container_hints.json
location of the container hints file
**--container_runtime**="docker"
The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'.
**--docker**=unix:///var/run/docker.sock
docker endpoint
**--docker-daemon-container**="/docker-daemon"
Optional resource-only container in which to place the Docker Daemon. Empty for no container (Default: /docker-daemon).
**--docker-endpoint**=""
If non-empty, use this for the docker endpoint to communicate with
**--docker_only**=false
Only report docker containers in addition to root stats
**--docker_root**=/var/lib/docker
Absolute path to the Docker state root directory (default: /var/lib/docker)
**--docker_run**=/var/run/docker
Absolute path to the Docker run directory (default: /var/run/docker)
**--enable-debugging-handlers**=true
Enables server endpoints for log collection and local running of containers and commands
**--enable_load_reader**=false
Whether to enable cpu load reader
**--enable-server**=true
Enable the info server
**--event_storage_age_limit**=default=24h
Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types
**--event_storage_event_limit**=default=100000
Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types
**--file-check-frequency**=20s
Duration between checking config files for new data
**--global_housekeeping_interval**=1m0s
Interval between global housekeepings
**--google-json-key**=""
The Google Cloud Platform Service Account JSON Key to use for authentication.
**--healthz-bind-address**=127.0.0.1
The IP address for the healthz server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces)
**--healthz-port**=10248
The port of the localhost healthz endpoint
**--host-network-sources**="file"
Comma-separated list of sources from which the Kubelet allows pods to use of host network. For all sources use "*" [default="file"]
**--hostname-override**=""
If non-empty, will use this string as identification instead of the actual hostname.
**--housekeeping_interval**=1s
Interval between container housekeepings
**--http-check-frequency**=20s
Duration between checking http for new data
**--image-gc-high-threshold**=90
The percent of disk usage after which image garbage collection is always run. Default: 90%%
**--image-gc-low-threshold**=80
The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. Default: 80%%
**--kubeconfig**=/var/lib/kubelet/kubeconfig
Path to a kubeconfig file, specifying how to authenticate to API server (the master location is set by the api-servers flag).
**--log_backtrace_at**=:0
when logging hits line file:N, emit a stack trace
**--log_cadvisor_usage**=false
Whether to log the usage of the cAdvisor container
**--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
**--low-diskspace-threshold-mb**=256
The absolute free disk space, in MB, to maintain. When disk space falls below this threshold, new pods would be rejected. Default: 256
**--machine_id_file**=/etc/machine-id,/var/lib/dbus/machine-id
Comma-separated list of files to check for machine-id. Use the first one that exists.
**--manifest-url**=""
URL for accessing the container manifest
**--master-service-namespace**="default"
The namespace from which the kubernetes master services should be injected into pods
**--max_housekeeping_interval**=1m0s
Largest interval to allow between container housekeepings
**--max_pods**=100
Number of Pods that can run on this Kubelet.
**--maximum-dead-containers**=100
Maximum number of old instances of a containers to retain globally. Each container takes up some disk space. Default: 100.
**--maximum-dead-containers-per-container**=5
Maximum number of old instances of a container to retain per container. Each container takes up some disk space. Default: 5.
**--minimum-container-ttl-duration**=1m0s
Minimum age for a finished container before it is garbage collected. Examples: '300ms', '10s' or '2h45m'
**--network-plugin**=""
The name of the network plugin to be invoked for various events in kubelet/pod lifecycle
**--node-status-update-frequency**=10s
Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. Default: 10s
**--oom-score-adj**=-900
The oom_score_adj value for kubelet process. Values must be within the range [-1000, 1000]
**--pod-infra-container-image**="gcr.io/google_containers/pause:0.8.0"
The image whose network/ipc namespaces containers in each pod will use.
**--port**=10250
The port for the info server to serve on
**--read-only-port**=10255
The read-only port for the info server to serve on (set to 0 to disable)
**--registry-burst**=10
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
**--registry-qps**=0
If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=0.0]
**--resource-container**="/kubelet"
Absolute name of the resource-only container to create and run the Kubelet in (Default: /kubelet).
**--root-dir**="/var/lib/kubelet"
Directory path for managing kubelet files (volume mounts,etc).
**--runonce**=false
If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api_servers, and --enable-server
**--stderrthreshold**=2
logs at or above this threshold go to stderr
**--streaming-connection-idle-timeout**=0
Maximum time a streaming connection can be idle before the connection is automatically closed. Example: '5m'
**--sync-frequency**=10s
Max period between synchronizing running containers and config
**--tls-cert-file**=""
File /gmrvcontaining x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If --tls_cert_file and --tls_private_key_file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert_dir.
**--tls-private-key-file**=""
File containing x509 private key matching --tls_cert_file.
**--v**=0
log level for V logs
**--version**=false
Print version information and quit
**--vmodule**=
comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kubelet --logtostderr=true --v=0 --api_servers=http://127.0.0.1:8080 --address=127.0.0.1 --port=10250 --hostname_override=127.0.0.1 --allow-privileged=false
```
# HISTORY
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kubelet.1.md?pixel)]()

105
docs/man/kubelet.md Normal file
View File

@ -0,0 +1,105 @@
# NAME
kubelet \- Processes a container manifest so the containers are launched according to how they are described.
# SYNOPSIS
**kubelet** [OPTIONS]
# DESCRIPTION
The **kubernetes** 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.
There are 3 ways that a container manifest can be provided to the Kubelet:
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).
HTTP server: The kubelet can also listen for HTTP and respond to a simple API (underspec'd currently) to submit a new manifest.
# OPTIONS
* **--address=0.0.0.0**: The IP address for the Kubelet to serve on (set to 0.0.0.0 for all interfaces)
* **--allow-dynamic-housekeeping=true**: Whether to allow the housekeeping interval to be dynamic
* **--allow-privileged=false**: If true, allow containers to request privileged mode. [default=false]
* **--alsologtostderr=false**: log to standard error as well as files
* **--api-servers=[]**: List of Kubernetes API servers for publishing events, and reading pods and services. (ip:port), comma separated.
* **--boot-id-file=/proc/sys/kernel/random/boot_id**: Comma-separated list of files to check for boot-id. Use the first one that exists.
* **--cadvisor-port=4194**: The port of the localhost cAdvisor endpoint
* **--cert-dir="/var/run/kubernetes"**: The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls_cert_file and --tls_private_key_file are provided, this flag will be ignored.
* **--cgroup-root=""**: Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.
* **--chaos-chance=0**: If > 0.0, introduce random client errors and latency. Intended for testing. [default=0.0]
* **--cloud-config=""**: The path to the cloud provider configuration file. Empty string for no configuration file.
* **--cloud-provider=""**: The provider for cloud services. Empty string for no provider.
* **--cluster-dns=<nil>**: IP address for a cluster DNS server. If set, kubelet will configure all containers to use this for DNS resolution in addition to the host's DNS servers
* **--cluster-domain=""**: Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains
* **--config=""**: Path to the config file or directory of files
* **--configure-cbr0=false**: If true, kubelet will configure cbr0 based on Node.Spec.PodCIDR.
* **--container-hints=/etc/cadvisor/container_hints.json**: location of the container hints file
* **--container-runtime="docker"**: The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'.
* **--containerized=false**: Experimental support for running kubelet in a container. Intended for testing. [default=false]
* **--docker=unix**:///var/run/docker.sock: docker endpoint
* **--docker-endpoint=""**: If non-empty, use this for the docker endpoint to communicate with
* **--docker-exec-handler="native"**: Handler to use when executing a command in a container. Valid values are 'native' and 'nsenter'. Defaults to 'native'.
* **--docker-only=false**: Only report docker containers in addition to root stats
* **--docker-root=/var/lib/docker**: Absolute path to the Docker state root directory (default: /var/lib/docker)
* **--docker-run=/var/run/docker**: Absolute path to the Docker run directory (default: /var/run/docker)
* **--enable-debugging-handlers=true**: Enables server endpoints for log collection and local running of containers and commands
* **--enable-load-reader=false**: Whether to enable cpu load reader
* **--enable-server=true**: Enable the Kubelet's server
* **--event-storage-age-limit=default=24h**: Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types
* **--event-storage-event-limit=default=100000**: Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types
* **--file-check-frequency=20s**: Duration between checking config files for new data
* **--global-housekeeping-interval=1m0s**: Interval between global housekeepings
* **--google-json-key=""**: The Google Cloud Platform Service Account JSON Key to use for authentication.
* **--healthz-bind-address=127.0.0.1**: The IP address for the healthz server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces)
* **--healthz-port=10248**: The port of the localhost healthz endpoint
* **--host-network-sources="file"**: Comma-separated list of sources from which the Kubelet allows pods to use of host network. For all sources use "*" [default="file"]
* **--hostname-override=""**: If non-empty, will use this string as identification instead of the actual hostname.
* **--housekeeping-interval=1s**: Interval between container housekeepings
* **--http-check-frequency=20s**: Duration between checking http for new data
* **--httptest.serve=**: if non-empty, httptest.NewServer serves on this address and blocks
* **--image-gc-high-threshold=90**: The percent of disk usage after which image garbage collection is always run. Default: 90%%
* **--image-gc-low-threshold=80**: The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. Default: 80%%
* **--kubeconfig=/var/lib/kubelet/kubeconfig**: Path to a kubeconfig file, specifying how to authenticate to API server (the master location is set by the api-servers flag).
* **--log-backtrace-at=**:0: when logging hits line file:N, emit a stack trace
* **--log-cadvisor-usage=false**: Whether to log the usage of the cAdvisor container
* **--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
* **--low-diskspace-threshold-mb=256**: The absolute free disk space, in MB, to maintain. When disk space falls below this threshold, new pods would be rejected. Default: 256
* **--machine-id-file=/etc/machine-id,/var/lib/dbus/machine-id**: Comma-separated list of files to check for machine-id. Use the first one that exists.
* **--manifest-url=""**: URL for accessing the container manifest
* **--master-service-namespace="default"**: The namespace from which the kubernetes master services should be injected into pods
* **--max-housekeeping-interval=1m0s**: Largest interval to allow between container housekeepings
* **--max-pods=100**: Number of Pods that can run on this Kubelet.
* **--maximum-dead-containers=100**: Maximum number of old instances of a containers to retain globally. Each container takes up some disk space. Default: 100.
* **--maximum-dead-containers-per-container=2**: Maximum number of old instances of a container to retain per container. Each container takes up some disk space. Default: 2.
* **--minimum-container-ttl-duration=1m0s**: Minimum age for a finished container before it is garbage collected. Examples: '300ms', '10s' or '2h45m'
* **--network-plugin=""**: <Warning: Alpha feature> The name of the network plugin to be invoked for various events in kubelet/pod lifecycle
* **--node-status-update-frequency=10s**: Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. Default: 10s
* **--oom-score-adj=-900**: The oom_score_adj value for kubelet process. Values must be within the range [-1000, 1000]
* **--pod-cidr=""**: The CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master.
* **--pod-infra-container-image="gcr.io/google_containers/pause**:0.8.0": The image whose network/ipc namespaces containers in each pod will use.
* **--port=10250**: The port for the Kubelet to serve on. Note that "kubectl logs" will not work if you set this flag.
* **--read-only-port=10255**: The read-only port for the Kubelet to serve on (set to 0 to disable)
* **--really-crash-for-testing=false**: If true, when panics occur crash. Intended for testing.
* **--register-node=true**: Register the node with the apiserver (defaults to true if --api-server is set)
* **--registry-burst=10**: 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
* **--registry-qps=0**: If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=0.0]
* **--resource-container="/kubelet"**: Absolute name of the resource-only container to create and run the Kubelet in (Default: /kubelet).
* **--root-dir="/var/lib/kubelet"**: Directory path for managing kubelet files (volume mounts,etc).
* **--runonce=false**: If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api_servers, and --enable-server
* **--stderrthreshold=2**: logs at or above this threshold go to stderr
* **--streaming-connection-idle-timeout=0**: Maximum time a streaming connection can be idle before the connection is automatically closed. Example: '5m'
* **--sync-frequency=10s**: Max period between synchronizing running containers and config
* **--system-container=""**: Optional resource-only container in which to place all non-kernel processes that are not already in a container. Empty for no container. Rolling back the flag requires a reboot. (Default: "").
* **--tls-cert-file=""**: File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If --tls_cert_file and --tls_private_key_file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert_dir.
* **--tls-private-key-file=""**: File containing x509 private key matching --tls_cert_file.
* **--v=0**: log level for V logs
* **--version=false**: Print version information and quit
* **--vmodule=**: comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
```
/usr/bin/kubelet --logtostderr=true --v=0 --api_servers=http://127.0.0.1:8080 --address=127.0.0.1 --port=10250 --hostname_override=127.0.0.1 --allow-privileged=false
```
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/man/kubelet.md?pixel)]()

259
docs/man/man1/kube-apiserver.1
View File

@ -1,259 +0,0 @@
.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=127.0.0.1
DEPRECATED: see \-\-insecure\-bind\-address instead
.PP
\fB\-\-admission\-control\fP="AlwaysAdmit"
Ordered list of plug\-ins to do admission control of resources into cluster. Comma\-delimited list of: AlwaysDeny, AlwaysAdmit, ServiceAccount, NamespaceExists, NamespaceLifecycle, NamespaceAutoProvision, LimitRanger, SecurityContextDeny, ResourceQuota
.PP
\fB\-\-admission\-control\-config\-file\fP=""
File with admission control configuration.
.PP
\fB\-\-allow\-privileged\fP=false
If true, allow privileged containers.
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-burst\fP=200
API burst amount for the read only port
.PP
\fB\-\-api\-prefix\fP="/api"
The prefix for API requests on the server. Default '/api'.
.PP
\fB\-\-api\-rate\fP=10
API rate limit as QPS for the read only port
.PP
\fB\-\-authorization\-mode\fP="AlwaysAllow"
Selects how to do authorization on the secure port. One of: AlwaysAllow,AlwaysDeny,ABAC
.PP
\fB\-\-authorization\-policy\-file\fP=""
File with authorization policy in csv format, used with \-\-authorization\-mode=ABAC, on the secure port.
.PP
\fB\-\-basic\-auth\-file\fP=""
If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.
.PP
\fB\-\-bind\-address\fP=0.0.0.0
The IP address on which to serve the \-\-read\-only\-port and \-\-secure\-port ports. This address must be reachable by the rest of the cluster. If blank, all interfaces will be used.
.PP
\fB\-\-cert\-dir\fP="/var/run/kubernetes"
The directory where the TLS certs are located (by default /var/run/kubernetes). If \-\-tls\-cert\-file and \-\-tls\-private\-key\-file are provided, this flag will be ignored.
.PP
\fB\-\-client\-ca\-file\fP=""
If set, any request presenting a client certificate signed by one of the authorities in the client\-ca\-file is authenticated with an identity corresponding to the CommonName of the client certificate.
.PP
\fB\-\-cloud\-config\fP=""
The path to the cloud provider configuration file. Empty string for no configuration file.
.PP
\fB\-\-cloud\-provider\fP=""
The provider for cloud services. Empty string for no provider.
.PP
\fB\-\-cluster\-name\fP="kubernetes"
The instance prefix for the cluster
.PP
\fB\-\-cors\-allowed\-origins\fP=[]
List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.
.PP
\fB\-\-etcd\-config\fP=""
The config file for the etcd client. Mutually exclusive with \-etcd\-servers.
.PP
\fB\-\-etcd\-prefix\fP="/registry"
The prefix for all resource paths in etcd.
.PP
\fB\-\-etcd\-servers\fP=[]
List of etcd servers to watch (
\[la]http://ip:port\[ra]), comma separated. Mutually exclusive with \-etcd\-config
.PP
\fB\-\-event\-ttl\fP=1h0m0s
Amount of time to retain events. Default 1 hour.
.PP
\fB\-\-external\-hostname\fP=""
The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs.)
.PP
\fB\-\-insecure\-bind\-address\fP=127.0.0.1
The IP address on which to serve the \-\-insecure\-port (set to 0.0.0.0 for all interfaces). Defaults to localhost.
.PP
\fB\-\-insecure\-port\fP=8080
The port on which to serve unsecured, unauthenticated access. Default 8080. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster and that port 443 on the cluster's public address is proxied to this port. This is performed by nginx in the default setup.
.PP
\fB\-\-kubelet\_certificate\_authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-kubelet\_client\_certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-kubelet\_client\_key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-kubelet\_https\fP=true
Use https for kubelet connections
.PP
\fB\-\-kubelet\_port\fP=10250
Kubelet port
.PP
\fB\-\-kubelet\_timeout\fP=5s
Timeout for kubelet operations
.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\-\-long\-running\-request\-regexp\fP="[.\fI\\/watch\$][^\\/proxy.\fP]"
A regular expression matching long running requests which should be excluded from maximum inflight request handling.
.PP
\fB\-\-master\-service\-namespace\fP="default"
The namespace from which the kubernetes master services should be injected into pods
.PP
\fB\-\-max\-requests\-inflight\fP=400
The maximum number of requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.
.PP
\fB\-\-old\-etcd\-prefix\fP="/registry"
The previous prefix for all resource paths in etcd, if any.
.PP
\fB\-\-port\fP=8080
DEPRECATED: see \-\-insecure\-port instead
.PP
\fB\-\-service\-cluster\-ip\-range\fP=
A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.
.PP
\fB\-\-profiling\fP=true
Enable profiling via web interface host:port/debug/pprof/
.PP
\fB\-\-public\-address\-override\fP=0.0.0.0
DEPRECATED: see \-\-bind\-address instead
.PP
\fB\-\-read\-only\-port\fP=7080
The port on which to serve read\-only resources. If 0, don't serve read\-only at all. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster.
.PP
\fB\-\-runtime\-config\fP=
A set of key=value pairs that describe runtime configuration that may be passed to the apiserver. api/ key can be used to turn on/off specific api versions. api/all and api/legacy are special keys to control all and legacy api versions respectively.
.PP
\fB\-\-secure\-port\fP=6443
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
.PP
\fB\-\-service\-account\-key\-file\fP=""
File containing PEM\-encoded x509 RSA private or public key, used to verify ServiceAccount tokens. If unspecified, \-\-tls\-private\-key\-file is used.
.PP
\fB\-\-service\-account\-lookup\fP=false
If true, validate ServiceAccount tokens exist in etcd as part of authentication.
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-storage\-version\fP=""
The version to store resources with. Defaults to server preferred
.PP
\fB\-\-tls\-cert\-file\fP=""
File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and \-\-tls\-cert\-file and \-\-tls\-private\-key\-file are not provided, a self\-signed certificate and key are generated for the public address and saved to /var/run/kubernetes.
.PP
\fB\-\-tls\-private\-key\-file\fP=""
File containing x509 private key matching \-\-tls\-cert\-file.
.PP
\fB\-\-token\-auth\-file\fP=""
If set, the file that will be used to secure the secure port of the API server via token authentication.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-version\fP=false
Print version information and quit
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLES
.PP
.RS
.nf
/usr/bin/kube\-apiserver \-\-logtostderr=true \-\-v=0 \-\-etcd\_servers=http://127.0.0.1:4001 \-\-insecure\_bind\_address=127.0.0.1 \-\-insecure\_port=8080 \-\-kubelet\_port=10250 \-\-service\-cluster\-ip\-range=10.1.1.0/24 \-\-allow\_privileged=false
.fi
.SH HISTORY
.PP
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.
.PP
[]()

182
docs/man/man1/kube-controller-manager.1
View File

@ -1,182 +0,0 @@
.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=127.0.0.1
The IP address to serve on (set to 0.0.0.0 for all interfaces)
.PP
\fB\-\-allocate\-node\-cidrs\fP=false
Should CIDRs for Pods be allocated and set on the cloud provider.
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-cloud\-config\fP=""
The path to the cloud provider configuration file. Empty string for no configuration file.
.PP
\fB\-\-cloud\-provider\fP=""
The provider for cloud services. Empty string for no provider.
.PP
\fB\-\-cluster\-cidr\fP=
CIDR Range for Pods in cluster.
.PP
\fB\-\-concurrent\-endpoint\-syncs\fP=5
The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load
.PP
\fB\-\-concurrent\_rc\_syncs\fP=5
The number of replication controllers that are allowed to sync concurrently. Larger number = more reponsive replica management, but more CPU (and network) load
.PP
\fB\-\-deleting\-pods\-burst\fP=10
Number of nodes on which pods are bursty deleted in case of node failure. For more details look into RateLimiter.
.PP
\fB\-\-deleting\-pods\-qps\fP=0.1
Number of nodes per second on which pods are deleted in case of node failure.
.PP
\fB\-\-kubeconfig\fP=""
Path to kubeconfig file with authorization and master location information.
.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\-\-machines\fP=[]
List of machines to schedule onto, comma separated.
.PP
\fB\-\-master\fP=""
The address of the Kubernetes API server (overrides any value in kubeconfig)
.PP
\fB\-\-minion\-regexp\fP=""
If non empty, and \-\-cloud\-provider is specified, a regular expression for matching minion VMs.
.PP
\fB\-\-namespace\-sync\-period\fP=5m0s
The period for syncing namespace life\-cycle updates
.PP
\fB\-\-node\-memory\fP=3Gi
The amount of memory (in bytes) provisioned on each node
.PP
\fB\-\-node\-milli\-cpu\fP=1000
The amount of MilliCPU provisioned on each node
.PP
\fB\-\-node\-monitor\-grace\-period\fP=40s
Amount of time which we allow running Node to be unresponsive before marking it unhealty. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status.
.PP
\fB\-\-node\-monitor\-period\fP=5s
The period for syncing NodeStatus in NodeController.
.PP
\fB\-\-node\-startup\-grace\-period\fP=1m0s
Amount of time which we allow starting Node to be unresponsive before marking it unhealty.
.PP
\fB\-\-node\-sync\-period\fP=10s
The period for syncing nodes from cloudprovider. Longer periods will result in fewer calls to cloud provider, but may delay addition of new nodes to cluster.
.PP
\fB\-\-pod\-eviction\-timeout\fP=5m0s
The grace period for deleting pods on failed nodes.
.PP
\fB\-\-port\fP=10252
The port that the controller\-manager's http service runs on
.PP
\fB\-\-profiling\fP=true
Enable profiling via web interface host:port/debug/pprof/
.PP
\fB\-\-pvclaimbinder\-sync\-period\fP=10s
The period for syncing persistent volumes and persistent volume claims
.PP
\fB\-\-register\-retry\-count\fP=10
The number of retries for initial node registration. Retry interval equals node\-sync\-period.
.PP
\fB\-\-resource\-quota\-sync\-period\fP=10s
The period for syncing quota usage status in the system
.PP
\fB\-\-service\-account\-private\-key\-file\fP=""
Filename containing a PEM\-encoded private RSA key used to sign service account tokens.
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-sync\-nodes\fP=true
If true, and \-\-cloud\-provider is specified, sync nodes from the cloud provider. Default true.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-version\fP=false
Print version information and quit
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLES
.PP
.RS
.nf
/usr/bin/kube\-controller\-manager \-\-logtostderr=true \-\-v=0 \-\-master=127.0.0.1:8080 \-\-machines=127.0.0.1
.fi
.SH HISTORY
.PP
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.
.PP
[]()

98
docs/man/man1/kube-proxy.1
View File

@ -1,98 +0,0 @@
.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
log to standard error as well as files
.PP
\fB\-\-bind\-address\fP=0.0.0.0
The IP address for the proxy server to serve on (set to 0.0.0.0 for all interfaces)
.PP
\fB\-\-healthz\-bind\-address\fP=127.0.0.1
The IP address for the health check server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces)
.PP
\fB\-\-healthz\-port\fP=10249
The port to bind the health check server. Use 0 to disable.
.PP
\fB\-\-kubeconfig\fP=""
Path to kubeconfig file with authorization information (the master location is set by the master flag).
.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\-\-master\fP=""
The address of the Kubernetes API server (overrides any value in kubeconfig)
.PP
\fB\-\-oom\-score\-adj\fP=\-899
The oom\_score\_adj value for kube\-proxy process. Values must be within the range [\-1000, 1000]
.PP
\fB\-\-resource\-container\fP="/kube\-proxy"
Absolute name of the resource\-only container to create and run the Kube\-proxy in (Default: /kube\-proxy).
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-version\fP=false
Print version information and quit
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLES
.PP
.RS
.nf
/usr/bin/kube\-proxy \-\-logtostderr=true \-\-v=0 \-\-master=http://127.0.0.1:8080
.fi
.SH HISTORY
.PP
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.
.PP
[]()

98
docs/man/man1/kube-scheduler.1
View File

@ -1,98 +0,0 @@
.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
The IP address to serve on (set to 0.0.0.0 for all interfaces)
.PP
\fB\-\-algorithm\-provider\fP="DefaultProvider"
The scheduling algorithm provider to use, one of: DefaultProvider
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-kubeconfig\fP=""
Path to kubeconfig file with authorization and master location information.
.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\-\-master\fP=""
The address of the Kubernetes API server (overrides any value in kubeconfig)
.PP
\fB\-\-policy\-config\-file\fP=""
File with scheduler policy configuration
.PP
\fB\-\-port\fP=10251
The port that the scheduler's http service runs on
.PP
\fB\-\-profiling\fP=true
Enable profiling via web interface host:port/debug/pprof/
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-version\fP=false
Print version information and quit
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLES
.PP
.RS
.nf
/usr/bin/kube\-scheduler \-\-logtostderr=true \-\-v=0 \-\-master=127.0.0.1:8080
.fi
.SH HISTORY
.PP
October 2014, Originally compiled by Scott Collier (scollier@redhat.com) based
on the kubernetes source material and internal work.
.PP
[]()

339
docs/man/man1/kubelet.1
View File

@ -1,339 +0,0 @@
.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.
.PP
There are 3 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).
HTTP server: The kubelet can also listen for HTTP and respond to a simple API (underspec'd currently) to submit a new manifest.
.fi
.SH OPTIONS
.PP
\fB\-\-address\fP=0.0.0.0
The IP address for the info server to serve on (set to 0.0.0.0 for all interfaces)
.PP
\fB\-\-allow\_dynamic\_housekeeping\fP=true
Whether to allow the housekeeping interval to be dynamic
.PP
\fB\-\-allow\-privileged\fP=false
If true, allow containers to request privileged mode. [default=false]
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-servers\fP=[]
List of Kubernetes API servers for publishing events, and reading pods and services. (ip:port), comma separated.
.PP
\fB\-\-boot\_id\_file\fP=/proc/sys/kernel/random/boot\_id
Comma\-separated list of files to check for boot\-id. Use the first one that exists.
.PP
\fB\-\-cadvisor\-port\fP=4194
The port of the localhost cAdvisor endpoint
.PP
\fB\-\-cert\-dir\fP="/var/run/kubernetes"
The directory where the TLS certs are located (by default /var/run/kubernetes). If \-\-tls\_cert\_file and \-\-tls\_private\_key\_file are provided, this flag will be ignored.
.PP
\fB\-\-cgroup\_root\fP=""
Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.
.PP
\fB\-\-cloud\-config\fP=""
The path to the cloud provider configuration file. Empty string for no configuration file.
.PP
\fB\-\-cloud\-provider\fP=""
The provider for cloud services. Empty string for no provider.
.PP
\fB\-\-cluster\-dns\fP=
IP address for a cluster DNS server. If set, kubelet will configure all containers to use this for DNS resolution in addition to the host's DNS servers
.PP
\fB\-\-cluster\-domain\fP=""
Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains
.PP
\fB\-\-config\fP=""
Path to the config file or directory of files
.PP
\fB\-\-configure\-cbr0\fP=false
If true, kubelet will configure cbr0 based on Node.Spec.PodCIDR.
.PP
\fB\-\-container\_hints\fP=/etc/cadvisor/container\_hints.json
location of the container hints file
.PP
\fB\-\-container\_runtime\fP="docker"
The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'.
.PP
\fB\-\-docker\fP=unix:///var/run/docker.sock
docker endpoint
.PP
\fB\-\-docker\-daemon\-container\fP="/docker\-daemon"
Optional resource\-only container in which to place the Docker Daemon. Empty for no container (Default: /docker\-daemon).
.PP
\fB\-\-docker\-endpoint\fP=""
If non\-empty, use this for the docker endpoint to communicate with
.PP
\fB\-\-docker\_only\fP=false
Only report docker containers in addition to root stats
.PP
\fB\-\-docker\_root\fP=/var/lib/docker
Absolute path to the Docker state root directory (default: /var/lib/docker)
.PP
\fB\-\-docker\_run\fP=/var/run/docker
Absolute path to the Docker run directory (default: /var/run/docker)
.PP
\fB\-\-enable\-debugging\-handlers\fP=true
Enables server endpoints for log collection and local running of containers and commands
.PP
\fB\-\-enable\_load\_reader\fP=false
Whether to enable cpu load reader
.PP
\fB\-\-enable\-server\fP=true
Enable the info server
.PP
\fB\-\-event\_storage\_age\_limit\fP=default=24h
Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non\-specified event types
.PP
\fB\-\-event\_storage\_event\_limit\fP=default=100000
Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non\-specified event types
.PP
\fB\-\-file\-check\-frequency\fP=20s
Duration between checking config files for new data
.PP
\fB\-\-global\_housekeeping\_interval\fP=1m0s
Interval between global housekeepings
.PP
\fB\-\-google\-json\-key\fP=""
The Google Cloud Platform Service Account JSON Key to use for authentication.
.PP
\fB\-\-healthz\-bind\-address\fP=127.0.0.1
The IP address for the healthz server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces)
.PP
\fB\-\-healthz\-port\fP=10248
The port of the localhost healthz endpoint
.PP
\fB\-\-host\-network\-sources\fP="file"
Comma\-separated list of sources from which the Kubelet allows pods to use of host network. For all sources use "*" [default="file"]
.PP
\fB\-\-hostname\-override\fP=""
If non\-empty, will use this string as identification instead of the actual hostname.
.PP
\fB\-\-housekeeping\_interval\fP=1s
Interval between container housekeepings
.PP
\fB\-\-http\-check\-frequency\fP=20s
Duration between checking http for new data
.PP
\fB\-\-image\-gc\-high\-threshold\fP=90
The percent of disk usage after which image garbage collection is always run. Default: 90%%
.PP
\fB\-\-image\-gc\-low\-threshold\fP=80
The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. Default: 80%%
.PP
\fB\-\-kubeconfig\fP=/var/lib/kubelet/kubeconfig
Path to a kubeconfig file, specifying how to authenticate to API server (the master location is set by the api\-servers flag).
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_cadvisor\_usage\fP=false
Whether to log the usage of the cAdvisor container
.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\-\-low\-diskspace\-threshold\-mb\fP=256
The absolute free disk space, in MB, to maintain. When disk space falls below this threshold, new pods would be rejected. Default: 256
.PP
\fB\-\-machine\_id\_file\fP=/etc/machine\-id,/var/lib/dbus/machine\-id
Comma\-separated list of files to check for machine\-id. Use the first one that exists.
.PP
\fB\-\-manifest\-url\fP=""
URL for accessing the container manifest
.PP
\fB\-\-master\-service\-namespace\fP="default"
The namespace from which the kubernetes master services should be injected into pods
.PP
\fB\-\-max\_housekeeping\_interval\fP=1m0s
Largest interval to allow between container housekeepings
.PP
\fB\-\-max\_pods\fP=100
Number of Pods that can run on this Kubelet.
.PP
\fB\-\-maximum\-dead\-containers\fP=100
Maximum number of old instances of a containers to retain globally. Each container takes up some disk space. Default: 100.
.PP
\fB\-\-maximum\-dead\-containers\-per\-container\fP=5
Maximum number of old instances of a container to retain per container. Each container takes up some disk space. Default: 5.
.PP
\fB\-\-minimum\-container\-ttl\-duration\fP=1m0s
Minimum age for a finished container before it is garbage collected. Examples: '300ms', '10s' or '2h45m'
.PP
\fB\-\-network\-plugin\fP=""
The name of the network plugin to be invoked for various events in kubelet/pod lifecycle
.PP
\fB\-\-node\-status\-update\-frequency\fP=10s
Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. Default: 10s
.PP
\fB\-\-oom\-score\-adj\fP=\-900
The oom\_score\_adj value for kubelet process. Values must be within the range [\-1000, 1000]
.PP
\fB\-\-pod\-infra\-container\-image\fP="gcr.io/google\_containers/pause:0.8.0"
The image whose network/ipc namespaces containers in each pod will use.
.PP
\fB\-\-port\fP=10250
The port for the info server to serve on
.PP
\fB\-\-read\-only\-port\fP=10255
The read\-only port for the info server to serve on (set to 0 to disable)
.PP
\fB\-\-registry\-burst\fP=10
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
\fB\-\-registry\-qps\fP=0
If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=0.0]
.PP
\fB\-\-resource\-container\fP="/kubelet"
Absolute name of the resource\-only container to create and run the Kubelet in (Default: /kubelet).
.PP
\fB\-\-root\-dir\fP="/var/lib/kubelet"
Directory path for managing kubelet files (volume mounts,etc).
.PP
\fB\-\-runonce\fP=false
If true, exit after spawning pods from local manifests or remote urls. Exclusive with \-\-api\_servers, and \-\-enable\-server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-streaming\-connection\-idle\-timeout\fP=0
Maximum time a streaming connection can be idle before the connection is automatically closed. Example: '5m'
.PP
\fB\-\-sync\-frequency\fP=10s
Max period between synchronizing running containers and config
.PP
\fB\-\-tls\-cert\-file\fP=""
File /gmrvcontaining x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If \-\-tls\_cert\_file and \-\-tls\_private\_key\_file are not provided, a self\-signed certificate and key are generated for the public address and saved to the directory passed to \-\-cert\_dir.
.PP
\fB\-\-tls\-private\-key\-file\fP=""
File containing x509 private key matching \-\-tls\_cert\_file.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-version\fP=false
Print version information and quit
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLES
.PP
.RS
.nf
/usr/bin/kubelet \-\-logtostderr=true \-\-v=0 \-\-api\_servers=http://127.0.0.1:8080 \-\-address=127.0.0.1 \-\-port=10250 \-\-hostname\_override=127.0.0.1 \-\-allow\-privileged=false
.fi
.SH HISTORY
.PP
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.
.PP
May 2015, Revised by Victor HU(huruifeng at huawei dot com) by kubernetes version 0.17
.PP
[]()

41
docs/man/md2man-all.sh
View File

@ -1,41 +0,0 @@
#!/bin/bash
# Copyright 2014 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.
set -e
if [[ -z ${GO_MD2MAN} ]]; then
GO_MD2MAN="go-md2man"
fi
# get into this script's directory
cd "$(dirname "$(readlink -f "$BASH_SOURCE")")"
[ "$1" = '-q' ] || {
set -x
pwd
}
for FILE in *.md; do
base="$(basename "$FILE")"
name="${base%.md}"
num="${name##*.}"
if [ -z "$num" -o "$name" = "$num" ]; then
# skip files that aren't of the format xxxx.N.md (like README.md)
continue
fi
mkdir -p "./man${num}"
${GO_MD2MAN} -in "$FILE" -out "./man${num}/${name}"
done