2014-10-09 22:42:04 +00:00
% 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.
2014-11-02 04:27:24 +00:00
The the kube-apiserver several options.
2014-10-09 22:42:04 +00:00
# OPTIONS
2015-01-13 20:02:24 +00:00
**--address**=""
2014-10-09 22:42:04 +00:00
The address on the local server to listen to. Default 127.0.0.1
2015-01-13 20:02:24 +00:00
**--allow_privileged**=""
2014-10-09 22:42:04 +00:00
If true, allow privileged containers.
2015-01-13 20:02:24 +00:00
**--alsologtostderr**=
2014-10-09 22:42:04 +00:00
log to standard error as well as files. Default is false.
2015-01-13 20:02:24 +00:00
**--api_prefix**="/api"
2014-10-09 22:42:04 +00:00
The prefix for API requests on the server. Default '/api'
2015-01-13 20:02:24 +00:00
**--cloud_config**=""
2014-10-09 22:42:04 +00:00
The path to the cloud provider configuration file. Empty string for no configuration file.
2015-01-13 20:02:24 +00:00
**--cloud_provider**=""
2014-10-09 22:42:04 +00:00
The provider for cloud services. Empty string for no provider.
2015-01-13 20:02:24 +00:00
**--cors_allowed_origins**=[]
2014-10-09 22:42:04 +00:00
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.
2015-01-13 20:02:24 +00:00
**--etcd_servers**=[]
2014-10-09 22:42:04 +00:00
List of etcd servers to watch (http://ip:port), comma separated
2015-01-13 20:02:24 +00:00
**--log_backtrace_at=**:0
2014-10-09 22:42:04 +00:00
when logging hits line file:N, emit a stack trace
2015-01-13 20:02:24 +00:00
**--log_dir**=""
2014-10-09 22:42:04 +00:00
If non-empty, write log files in this directory
2015-01-13 20:02:24 +00:00
**--log_flush_frequency**=5s
2014-10-09 22:42:04 +00:00
Maximum number of seconds between log flushes. Default is 5 seconds.
2015-01-13 20:02:24 +00:00
**--logtostderr**=
2014-10-09 22:42:04 +00:00
log to standard error instead of files. Default is false.
2015-01-13 20:02:24 +00:00
**--kubelet_port**=10250
2014-10-09 22:42:04 +00:00
The port at which kubelet will be listening on the minions. Default is 10250.
2015-01-13 20:02:24 +00:00
**--port**=8080
2014-10-09 22:42:04 +00:00
The port to listen on. Default is 8080.
2015-01-13 20:02:24 +00:00
**--stderrthreshold**=0
2014-10-09 22:42:04 +00:00
logs at or above this threshold go to stderr. Default is 0.
2015-01-13 20:02:24 +00:00
**--storage_version**=""
2014-10-09 22:42:04 +00:00
The version to store resources with. Defaults to server preferred.
2015-01-13 20:02:24 +00:00
**--v**=0
2014-10-09 22:42:04 +00:00
Log level for V logs.
2015-01-13 20:02:24 +00:00
**--version**=false
2014-10-09 22:42:04 +00:00
Print version information and quit. Default is false.
2015-01-13 20:02:24 +00:00
**--vmodule**=
2014-10-09 22:42:04 +00:00
comma-separated list of pattern=N settings for file-filtered logging
# EXAMPLES
2014-10-29 17:06:56 +00:00
```
2014-11-02 04:27:24 +00:00
/usr/bin/kube-apiserver --logtostderr=true --v=0 --etcd_servers=http://127.0.0.1:4001 --address=0.0.0.0 --port=8080 --kubelet_port=10250 --allow_privileged=false
2014-10-29 17:06:56 +00:00
```
2014-10-09 22:42:04 +00:00
# HISTORY
October 2014, Originally compiled by Scott Collier (scollier at redhat dot com) based
on the kubernetes source material and internal work.