github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-14 21:53:52 +00:00
Code Issues Projects Releases Wiki Activity

Cloning docs for 0.19.0

Browse Source
This commit is contained in:
Brendan Burns
2015-06-10 09:23:42 -07:00
parent 1dc723b4cb
commit f3208ad4c0
514 changed files with 43289 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
release-0.19.0/docs/man/Dockerfile Normal file
View File

@@ -0,0 +1,7 @@
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"]

49
release-0.19.0/docs/man/README.md Normal file
View File

@@ -0,0 +1,49 @@
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)]()
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/release-0.19.0/docs/man/README.md?pixel)]()

198
release-0.19.0/docs/man/kube-apiserver.1.md Normal file
View File

@@ -0,0 +1,198 @@
% 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)]()
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/release-0.19.0/docs/man/kube-apiserver.1.md?pixel)]()

141
release-0.19.0/docs/man/kube-controller-manager.1.md Normal file
View File

@@ -0,0 +1,141 @@
% 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
**--machines**=[]
List of machines to schedule onto, comma separated.
**--master**=""
The address of the Kubernetes API server (overrides any value in kubeconfig)
**--minion-regexp**=""
If non empty, and --cloud-provider is specified, a regular expression for matching minion VMs.
**--namespace-sync-period**=5m0s
The period for syncing namespace life-cycle updates
**--node-memory**=3Gi
The amount of memory (in bytes) provisioned on each node
**--node-milli-cpu**=1000
The amount of MilliCPU provisioned on each node
**--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
**--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
**--sync-nodes**=true
If true, and --cloud-provider is specified, sync nodes from the cloud provider. Default true.
**--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 --machines=127.0.0.1
```
# 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)]()
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/release-0.19.0/docs/man/kube-controller-manager.1.md?pixel)]()

78
release-0.19.0/docs/man/kube-proxy.1.md Normal file
View File

@@ -0,0 +1,78 @@
% 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)]()
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/release-0.19.0/docs/man/kube-proxy.1.md?pixel)]()

78
release-0.19.0/docs/man/kube-scheduler.1.md Normal file
View File

@@ -0,0 +1,78 @@
% 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)]()
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/release-0.19.0/docs/man/kube-scheduler.1.md?pixel)]()

253
release-0.19.0/docs/man/kubelet.1.md Normal file
View File

@@ -0,0 +1,253 @@
% 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)]()
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/release-0.19.0/docs/man/kubelet.1.md?pixel)]()

28
release-0.19.0/docs/man/man1/.files_generated Normal file
View File

@@ -0,0 +1,28 @@
kubectl-api-versions.1
kubectl-cluster-info.1
kubectl-config-set-cluster.1
kubectl-config-set-context.1
kubectl-config-set-credentials.1
kubectl-config-set.1
kubectl-config-unset.1
kubectl-config-use-context.1
kubectl-config-view.1
kubectl-config.1
kubectl-create.1
kubectl-delete.1
kubectl-describe.1
kubectl-exec.1
kubectl-expose.1
kubectl-get.1
kubectl-label.1
kubectl-logs.1
kubectl-namespace.1
kubectl-port-forward.1
kubectl-proxy.1
kubectl-rolling-update.1
kubectl-run.1
kubectl-scale.1
kubectl-stop.1
kubectl-update.1
kubectl-version.1
kubectl.1

259
release-0.19.0/docs/man/man1/kube-apiserver.1 Normal file
View File

@@ -0,0 +1,259 @@
.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
release-0.19.0/docs/man/man1/kube-controller-manager.1 Normal file
View File

@@ -0,0 +1,182 @@
.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 peroid 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
release-0.19.0/docs/man/man1/kube-proxy.1 Normal file
View File

@@ -0,0 +1,98 @@
.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
release-0.19.0/docs/man/man1/kube-scheduler.1 Normal file
View File

@@ -0,0 +1,98 @@
.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
[]()

130
release-0.19.0/docs/man/man1/kubectl-api-versions.1 Normal file
View File

@@ -0,0 +1,130 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl api\-versions \- Print available API versions.
.SH SYNOPSIS
.PP
\fBkubectl api\-versions\fP [OPTIONS]
.SH DESCRIPTION
.PP
Print available API versions.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for api\-versions
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

130
release-0.19.0/docs/man/man1/kubectl-cluster-info.1 Normal file
View File

@@ -0,0 +1,130 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl cluster\-info \- Display cluster info
.SH SYNOPSIS
.PP
\fBkubectl cluster\-info\fP [OPTIONS]
.SH DESCRIPTION
.PP
Display addresses of the master and services with label kubernetes.io/cluster\-service=true
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for cluster\-info
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

153
release-0.19.0/docs/man/man1/kubectl-config-set-cluster.1 Normal file
View File

@@ -0,0 +1,153 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config set\-cluster \- Sets a cluster entry in kubeconfig
.SH SYNOPSIS
.PP
\fBkubectl config set\-cluster\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets a cluster entry in kubeconfig.
Specifying a name that already exists will merge new fields on top of existing values for those fields.
.SH OPTIONS
.PP
\fB\-\-api\-version\fP=""
api\-version for the cluster entry in kubeconfig
.PP
\fB\-\-certificate\-authority\fP=""
path to certificate\-authority for the cluster entry in kubeconfig
.PP
\fB\-\-embed\-certs\fP=false
embed\-certs for the cluster entry in kubeconfig
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for set\-cluster
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
insecure\-skip\-tls\-verify for the cluster entry in kubeconfig
.PP
\fB\-\-server\fP=""
server for the cluster entry in kubeconfig
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-kubeconfig\fP=""
use a particular kubeconfig file
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Set only the server field on the e2e cluster entry without touching other values.
$ kubectl config set\-cluster e2e \-\-server=https://1.2.3.4
// Embed certificate authority data for the e2e cluster entry
$ kubectl config set\-cluster e2e \-\-certificate\-authority=\~/.kube/e2e/kubernetes.ca.crt
// Disable cert checking for the dev cluster entry
$ kubectl config set\-cluster e2e \-\-insecure\-skip\-tls\-verify=true
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

143
release-0.19.0/docs/man/man1/kubectl-config-set-context.1 Normal file
View File

@@ -0,0 +1,143 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config set\-context \- Sets a context entry in kubeconfig
.SH SYNOPSIS
.PP
\fBkubectl config set\-context\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets a context entry in kubeconfig
Specifying a name that already exists will merge new fields on top of existing values for those fields.
.SH OPTIONS
.PP
\fB\-\-cluster\fP=""
cluster for the context entry in kubeconfig
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for set\-context
.PP
\fB\-\-namespace\fP=""
namespace for the context entry in kubeconfig
.PP
\fB\-\-user\fP=""
user for the context entry in kubeconfig
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular kubeconfig file
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Set the user field on the gce context entry without touching other values
$ kubectl config set\-context gce \-\-user=cluster\-admin
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

169
release-0.19.0/docs/man/man1/kubectl-config-set-credentials.1 Normal file
View File

@@ -0,0 +1,169 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config set\-credentials \- Sets a user entry in kubeconfig
.SH SYNOPSIS
.PP
\fBkubectl config set\-credentials\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets a user entry in kubeconfig
Specifying a name that already exists will merge new fields on top of existing values.
.PP
Client\-certificate flags:
\-\-client\-certificate=certfile \-\-client\-key=keyfile
.PP
Bearer token flags:
\-\-token=bearer\_token
.PP
Basic auth flags:
\-\-username=basic\_user \-\-password=basic\_password
.PP
Bearer token and basic auth are mutually exclusive.
.SH OPTIONS
.PP
\fB\-\-client\-certificate\fP=""
path to client\-certificate for the user entry in kubeconfig
.PP
\fB\-\-client\-key\fP=""
path to client\-key for the user entry in kubeconfig
.PP
\fB\-\-embed\-certs\fP=false
embed client cert/key for the user entry in kubeconfig
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for set\-credentials
.PP
\fB\-\-password\fP=""
password for the user entry in kubeconfig
.PP
\fB\-\-token\fP=""
token for the user entry in kubeconfig
.PP
\fB\-\-username\fP=""
username for the user entry in kubeconfig
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular kubeconfig file
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Set only the "client\-key" field on the "cluster\-admin"
// entry, without touching other values:
$ kubectl set\-credentials cluster\-admin \-\-client\-key=\~/.kube/admin.key
// Set basic auth for the "cluster\-admin" entry
$ kubectl set\-credentials cluster\-admin \-\-username=admin \-\-password=uXFGweU9l35qcif
// Embed client certificate data in the "cluster\-admin" entry
$ kubectl set\-credentials cluster\-admin \-\-client\-certificate=\~/.kube/admin.crt \-\-embed\-certs=true
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

132
release-0.19.0/docs/man/man1/kubectl-config-set.1 Normal file
View File

@@ -0,0 +1,132 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config set \- Sets an individual value in a kubeconfig file
.SH SYNOPSIS
.PP
\fBkubectl config set\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets an individual value in a kubeconfig file
PROPERTY\_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots.
PROPERTY\_VALUE is the new value you wish to set.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for set
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular kubeconfig file
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

131
release-0.19.0/docs/man/man1/kubectl-config-unset.1 Normal file
View File

@@ -0,0 +1,131 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config unset \- Unsets an individual value in a kubeconfig file
.SH SYNOPSIS
.PP
\fBkubectl config unset\fP [OPTIONS]
.SH DESCRIPTION
.PP
Unsets an individual value in a kubeconfig file
PROPERTY\_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for unset
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular kubeconfig file
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

130
release-0.19.0/docs/man/man1/kubectl-config-use-context.1 Normal file
View File

@@ -0,0 +1,130 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config use\-context \- Sets the current\-context in a kubeconfig file
.SH SYNOPSIS
.PP
\fBkubectl config use\-context\fP [OPTIONS]
.SH DESCRIPTION
.PP
Sets the current\-context in a kubeconfig file
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for use\-context
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular kubeconfig file
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

181
release-0.19.0/docs/man/man1/kubectl-config-view.1 Normal file
View File

@@ -0,0 +1,181 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config view \- displays Merged kubeconfig settings or a specified kubeconfig file.
.SH SYNOPSIS
.PP
\fBkubectl config view\fP [OPTIONS]
.SH DESCRIPTION
.PP
displays Merged kubeconfig settings or a specified kubeconfig file.
.PP
You can use \-\-output=template \-\-template=TEMPLATE to extract specific values.
.SH OPTIONS
.PP
\fB\-\-flatten\fP=false
flatten the resulting kubeconfig file into self contained output (useful for creating portable kubeconfig files)
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for view
.PP
\fB\-\-merge\fP=true
merge together the full hierarchy of kubeconfig files
.PP
\fB\-\-minify\fP=false
remove all information not used by current\-context from the output
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-\-raw\fP=false
display raw byte data
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular kubeconfig file
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Show Merged kubeconfig settings.
$ kubectl config view
// Get the password for the e2e user
$ kubectl config view \-o template \-\-template='\{\{range .users\}\}\{\{ if eq .name "e2e" \}\}\{\{ index .user.password \}\}\{\{end\}\}\{\{end\}\}'
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

136
release-0.19.0/docs/man/man1/kubectl-config.1 Normal file
View File

@@ -0,0 +1,136 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl config \- config modifies kubeconfig files
.SH SYNOPSIS
.PP
\fBkubectl config\fP [OPTIONS]
.SH DESCRIPTION
.PP
config modifies kubeconfig files using subcommands like "kubectl config set current\-context my\-context"
.PP
The loading order follows these rules:
1. If the \-\-kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place.
2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged together. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list.
3. Otherwise, $\{HOME\}/.kube/config is used and no merging takes place.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for config
.PP
\fB\-\-kubeconfig\fP=""
use a particular kubeconfig file
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP, \fBkubectl\-config\-view(1)\fP, \fBkubectl\-config\-set\-cluster(1)\fP, \fBkubectl\-config\-set\-credentials(1)\fP, \fBkubectl\-config\-set\-context(1)\fP, \fBkubectl\-config\-set(1)\fP, \fBkubectl\-config\-unset(1)\fP, \fBkubectl\-config\-use\-context(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

152
release-0.19.0/docs/man/man1/kubectl-create.1 Normal file
View File

@@ -0,0 +1,152 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl create \- Create a resource by filename or stdin
.SH SYNOPSIS
.PP
\fBkubectl create\fP [OPTIONS]
.SH DESCRIPTION
.PP
Create a resource by filename or stdin.
.PP
JSON and YAML formats are accepted.
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file to use to create the resource
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for create
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Create a pod using the data in pod.json.
$ kubectl create \-f pod.json
// Create a pod based on the JSON passed into stdin.
$ cat pod.json | kubectl create \-f \-
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

194
release-0.19.0/docs/man/man1/kubectl-delete.1 Normal file
View File

@@ -0,0 +1,194 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl delete \- Delete a resource by filename, stdin, resource and ID, or by resources and label selector.
.SH SYNOPSIS
.PP
\fBkubectl delete\fP [OPTIONS]
.SH DESCRIPTION
.PP
Delete a resource by filename, stdin, resource and ID, or by resources and label selector.
.PP
JSON and YAML formats are accepted.
.PP
If both a filename and command line arguments are passed, the command line
arguments are used and the filename is ignored.
.PP
Note that the delete command does NOT do resource version checks, so if someone
submits an update to a resource right when you submit a delete, their update
will be lost along with the rest of the resource.
.SH OPTIONS
.PP
\fB\-\-all\fP=false
[\-all] to select all the specified resources.
.PP
\fB\-\-cascade\fP=true
If true, cascade the delete resources managed by this resource (e.g. Pods created by a ReplicationController). Default true.
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to a file containing the resource to delete.
.PP
\fB\-\-grace\-period\fP=\-1
Period of time in seconds given to the resource to terminate gracefully. Ignored if negative.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for delete
.PP
\fB\-\-ignore\-not\-found\fP=false
Treat "resource not found" as a successful delete.
.PP
\fB\-l\fP, \fB\-\-selector\fP=""
Selector (label query) to filter on.
.PP
\fB\-\-timeout\fP=0
The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Delete a pod using the type and ID specified in pod.json.
$ kubectl delete \-f pod.json
// Delete a pod based on the type and ID in the JSON passed into stdin.
$ cat pod.json | kubectl delete \-f \-
// Delete pods and services with label name=myLabel.
$ kubectl delete pods,services \-l name=myLabel
// Delete a pod with ID 1234\-56\-7890\-234234\-456456.
$ kubectl delete pod 1234\-56\-7890\-234234\-456456
// Delete all pods
$ kubectl delete pods \-\-all
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

149
release-0.19.0/docs/man/man1/kubectl-describe.1 Normal file
View File

@@ -0,0 +1,149 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl describe \- Show details of a specific resource
.SH SYNOPSIS
.PP
\fBkubectl describe\fP [OPTIONS]
.SH DESCRIPTION
.PP
Show details of a specific resource.
.PP
This command joins many API calls together to form a detailed description of a
given resource.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for describe
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Describe a node
$ kubectl describe nodes kubernetes\-minion\-emt8.c.myproject.internal
// Describe a pod
$ kubectl describe pods/nginx
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

164
release-0.19.0/docs/man/man1/kubectl-exec.1 Normal file
View File

@@ -0,0 +1,164 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl exec \- Execute a command in a container.
.SH SYNOPSIS
.PP
\fBkubectl exec\fP [OPTIONS]
.SH DESCRIPTION
.PP
Execute a command in a container.
.SH OPTIONS
.PP
\fB\-c\fP, \fB\-\-container\fP=""
Container name
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for exec
.PP
\fB\-p\fP, \fB\-\-pod\fP=""
Pod name
.PP
\fB\-i\fP, \fB\-\-stdin\fP=false
Pass stdin to the container
.PP
\fB\-t\fP, \fB\-\-tty\fP=false
Stdin is a TTY
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// get output from running 'date' from pod 123456\-7890, using the first container by default
$ kubectl exec 123456\-7890 date
// get output from running 'date' in ruby\-container from pod 123456\-7890
$ kubectl exec 123456\-7890 \-c ruby\-container date
//switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-780 and sends stdout/stderr from 'bash' back to the client
$ kubectl exec 123456\-7890 \-c ruby\-container \-i \-t \-\- bash \-il
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

222
release-0.19.0/docs/man/man1/kubectl-expose.1 Normal file
View File

@@ -0,0 +1,222 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl expose \- Take a replicated application and expose it as Kubernetes Service
.SH SYNOPSIS
.PP
\fBkubectl expose\fP [OPTIONS]
.SH DESCRIPTION
.PP
Take a replicated application and expose it as Kubernetes Service.
.PP
Looks up a replication controller or service by name and uses the selector for that resource as the
selector for a new Service on the specified port. If no labels are specified, the new service will
re\-use the labels from the resource it exposes.
.SH OPTIONS
.PP
\fB\-\-container\-port\fP=""
Synonym for \-\-target\-port
.PP
\fB\-\-create\-external\-load\-balancer\fP=false
If true, create an external load balancer for this service (trumped by \-\-type). Implementation is cloud provider dependent. Default is 'false'.
.PP
\fB\-\-dry\-run\fP=false
If true, only print the object that would be sent, without creating it.
.PP
\fB\-\-generator\fP="service/v1"
The name of the API generator to use. Default is 'service/v1'.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for expose
.PP
\fB\-l\fP, \fB\-\-labels\fP=""
Labels to apply to the service created by this call.
.PP
\fB\-\-name\fP=""
The name for the newly created object.
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-\-overrides\fP=""
An inline JSON override for the generated object. If this is non\-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
.PP
\fB\-\-port\fP=\-1
The port that the service should serve on. Required.
.PP
\fB\-\-protocol\fP="TCP"
The network protocol for the service to be created. Default is 'tcp'.
.PP
\fB\-\-public\-ip\fP=""
Name of a public IP address to set for the service. The service will be assigned this IP in addition to its generated service IP.
.PP
\fB\-\-selector\fP=""
A label selector to use for this service. If empty (the default) infer the selector from the replication controller.
.PP
\fB\-\-target\-port\fP=""
Name or number for the port on the container that the service should direct traffic to. Optional.
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.PP
\fB\-\-type\fP=""
Type for this service: ClusterIP, NodePort, or LoadBalancer. Default is 'ClusterIP' unless \-\-create\-external\-load\-balancer is specified.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Creates a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.
$ kubectl expose rc nginx \-\-port=80 \-\-target\-port=8000
// Creates a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx\-https"
$ kubectl expose service nginx \-\-port=443 \-\-target\-port=8443 \-\-name=nginx\-https
// Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video\-stream'.
$ kubectl expose rc streamer \-\-port=4100 \-\-protocol=udp \-\-name=video\-stream
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

200
release-0.19.0/docs/man/man1/kubectl-get.1 Normal file
View File

@@ -0,0 +1,200 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl get \- Display one or many resources
.SH SYNOPSIS
.PP
\fBkubectl get\fP [OPTIONS]
.SH DESCRIPTION
.PP
Display one or many resources.
.PP
Possible resources include pods (po), replication controllers (rc), services
(svc), nodes, events (ev), component statuses (cs), limit ranges (limits),
nodes (no), persistent volumes (pv), persistent volume claims (pvc)
or resource quotas (quota).
.PP
By specifying the output as 'template' and providing a Go template as the value
of the \-\-template flag, you can filter the attributes of the fetched resource(s).
.SH OPTIONS
.PP
\fB\-\-all\-namespaces\fP=false
If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with \-\-namespace.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for get
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-l\fP, \fB\-\-selector\fP=""
Selector (label query) to filter on
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.PP
\fB\-w\fP, \fB\-\-watch\fP=false
After listing/getting the requested object, watch for changes.
.PP
\fB\-\-watch\-only\fP=false
Watch for changes to the requested object(s), without listing/getting first.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// List all pods in ps output format.
$ kubectl get pods
// List a single replication controller with specified NAME in ps output format.
$ kubectl get replicationcontroller web
// List a single pod in JSON output format.
$ kubectl get \-o json pod web\-pod\-13je7
// Return only the phase value of the specified pod.
$ kubectl get \-o template web\-pod\-13je7 \-\-template=\{\{.status.phase\}\} \-\-api\-version=v1
// List all replication controllers and services together in ps output format.
$ kubectl get rc,services
// List one or more resources by their type and names
$ kubectl get rc/web service/frontend pods/web\-pod\-13je7
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

193
release-0.19.0/docs/man/man1/kubectl-label.1 Normal file
View File

@@ -0,0 +1,193 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl label \- Update the labels on a resource
.SH SYNOPSIS
.PP
\fBkubectl label\fP [OPTIONS]
.SH DESCRIPTION
.PP
Update the labels on a resource.
.PP
A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters.
If \-\-overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
If \-\-resource\-version is specified, then updates will use this resource version, otherwise the existing resource\-version will be used.
.SH OPTIONS
.PP
\fB\-\-all\fP=false
select all resources in the namespace of the specified resource types
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for label
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-\-overwrite\fP=false
If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels.
.PP
\fB\-\-resource\-version\fP=""
If non\-empty, the labels update will only succeed if this is the current resource\-version for the object. Only valid when specifying a single resource.
.PP
\fB\-l\fP, \fB\-\-selector\fP=""
Selector (label query) to filter on
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Update pod 'foo' with the label 'unhealthy' and the value 'true'.
$ kubectl label pods foo unhealthy=true
// Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.
$ kubectl label \-\-overwrite pods foo status=unhealthy
// Update all pods in the namespace
$ kubectl label pods \-\-all status=unhealthy
// Update pod 'foo' only if the resource is unchanged from version 1.
$ kubectl label pods foo status=unhealthy \-\-resource\-version=1
// Update pod 'foo' by removing a label named 'bar' if it exists.
// Does not require the \-\-overwrite flag.
$ kubectl label pods foo bar\-
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

160
release-0.19.0/docs/man/man1/kubectl-logs.1 Normal file
View File

@@ -0,0 +1,160 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl logs \- Print the logs for a container in a pod.
.SH SYNOPSIS
.PP
\fBkubectl logs\fP [OPTIONS]
.SH DESCRIPTION
.PP
Print the logs for a container in a pod. If the pod has only one container, the container name is optional.
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-follow\fP=false
Specify if the logs should be streamed.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for logs
.PP
\fB\-\-interactive\fP=true
If true, prompt the user for input when required. Default true.
.PP
\fB\-p\fP, \fB\-\-previous\fP=false
If true, print the logs for the previous instance of the container in a pod if it exists.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Returns snapshot of ruby\-container logs from pod 123456\-7890.
$ kubectl logs 123456\-7890 ruby\-container
// Returns snapshot of previous terminated ruby\-container logs from pod 123456\-7890.
$ kubectl logs \-p 123456\-7890 ruby\-container
// Starts streaming of ruby\-container logs from pod 123456\-7890.
$ kubectl logs \-f 123456\-7890 ruby\-container
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

133
release-0.19.0/docs/man/man1/kubectl-namespace.1 Normal file
View File

@@ -0,0 +1,133 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl namespace \- SUPERCEDED: Set and view the current Kubernetes namespace
.SH SYNOPSIS
.PP
\fBkubectl namespace\fP [OPTIONS]
.SH DESCRIPTION
.PP
SUPERCEDED: Set and view the current Kubernetes namespace scope for command line requests.
.PP
namespace has been superceded by the context.namespace field of .kubeconfig files. See 'kubectl config set\-context \-\-help' for more details.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for namespace
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

156
release-0.19.0/docs/man/man1/kubectl-port-forward.1 Normal file
View File

@@ -0,0 +1,156 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl port\-forward \- Forward one or more local ports to a pod.
.SH SYNOPSIS
.PP
\fBkubectl port\-forward\fP [OPTIONS]
.SH DESCRIPTION
.PP
Forward one or more local ports to a pod.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for port\-forward
.PP
\fB\-p\fP, \fB\-\-pod\fP=""
Pod name
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
$ kubectl port\-forward \-p mypod 5000 6000
// listens on port 8888 locally, forwarding to 5000 in the pod
$ kubectl port\-forward \-p mypod 8888:5000
// listens on a random port locally, forwarding to 5000 in the pod
$ kubectl port\-forward \-p mypod :5000
// listens on a random port locally, forwarding to 5000 in the pod
$ kubectl port\-forward \-p mypod 0:5000
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

183
release-0.19.0/docs/man/man1/kubectl-proxy.1 Normal file
View File

@@ -0,0 +1,183 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl proxy \- Run a proxy to the Kubernetes API server
.SH SYNOPSIS
.PP
\fBkubectl proxy\fP [OPTIONS]
.SH DESCRIPTION
.PP
To proxy all of the kubernetes api and nothing else, use:
.PP
kubectl proxy \-\-api\-prefix=/
.PP
To proxy only part of the kubernetes api and also some static files:
.PP
kubectl proxy \-\-www=/my/files \-\-www\-prefix=/static/ \-\-api\-prefix=/api/
.PP
The above lets you 'curl localhost:8001/api/v1/pods'.
.PP
To proxy the entire kubernetes api at a different root, use:
.PP
kubectl proxy \-\-api\-prefix=/custom/
.PP
The above lets you 'curl localhost:8001/custom/api/v1/pods'
.SH OPTIONS
.PP
\fB\-\-api\-prefix\fP="/api/"
Prefix to serve the proxied API under.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for proxy
.PP
\fB\-p\fP, \fB\-\-port\fP=8001
The port on which to run the proxy.
.PP
\fB\-w\fP, \fB\-\-www\fP=""
Also serve static files from the given directory under the specified prefix.
.PP
\fB\-P\fP, \fB\-\-www\-prefix\fP="/static/"
Prefix to serve static files under, if static file directory is specified.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/
$ kubectl proxy \-\-port=8011 \-\-www=./local/www/
// Run a proxy to kubernetes apiserver, changing the api prefix to k8s\-api
// This makes e.g. the pods api available at localhost:8011/k8s\-api/v1/pods/
$ kubectl proxy \-\-api\-prefix=/k8s\-api
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

207
release-0.19.0/docs/man/man1/kubectl-rolling-update.1 Normal file
View File

@@ -0,0 +1,207 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl rolling\-update \- Perform a rolling update of the given ReplicationController.
.SH SYNOPSIS
.PP
\fBkubectl rolling\-update\fP [OPTIONS]
.SH DESCRIPTION
.PP
Perform a rolling update of the given ReplicationController.
.PP
Replaces the specified controller with new controller, updating one pod at a time to use the
new PodTemplate. The new\-controller.json must specify the same namespace as the
existing controller and overwrite at least one (common) label in its replicaSelector.
.SH OPTIONS
.PP
\fB\-\-deployment\-label\-key\fP="deployment"
The key to use to differentiate between two different controllers, default 'deployment'. Only relevant when \-\-image is specified, ignored otherwise
.PP
\fB\-\-dry\-run\fP=false
If true, print out the changes that would be made, but don't actually make them.
.PP
\fB\-f\fP, \fB\-\-filename\fP=""
Filename or URL to file to use to create the new controller.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for rolling\-update
.PP
\fB\-\-image\fP=""
Image to upgrade the controller to. Can not be used with \-\-filename/\-f
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-\-poll\-interval\fP="3s"
Time delay between polling controller status after update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
.PP
\fB\-\-rollback\fP=false
If true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.PP
\fB\-\-timeout\fP="5m0s"
Max time to wait for a controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
.PP
\fB\-\-update\-period\fP="1m0s"
Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Update pods of frontend\-v1 using new controller data in frontend\-v2.json.
$ kubectl rolling\-update frontend\-v1 \-f frontend\-v2.json
// Update pods of frontend\-v1 using JSON data passed into stdin.
$ cat frontend\-v2.json | kubectl rolling\-update frontend\-v1 \-f \-
// Update the pods of frontend\-v1 to frontend\-v2 by just changing the image, and switching the
// name of the replication controller.
$ kubectl rolling\-update frontend\-v1 frontend\-v2 \-\-image=image:v2
// Update the pods of frontend by just changing the image, and keeping the old name
$ kubectl rolling\-update frontend \-\-image=image:v2
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

201
release-0.19.0/docs/man/man1/kubectl-run.1 Normal file
View File

@@ -0,0 +1,201 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl run \- Run a particular image on the cluster.
.SH SYNOPSIS
.PP
\fBkubectl run\fP [OPTIONS]
.SH DESCRIPTION
.PP
Create and run a particular image, possibly replicated.
Creates a replication controller to manage the created container(s).
.SH OPTIONS
.PP
\fB\-\-dry\-run\fP=false
If true, only print the object that would be sent, without sending it.
.PP
\fB\-\-generator\fP="run/v1"
The name of the API generator to use. Default is 'run\-controller/v1'.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for run
.PP
\fB\-\-hostport\fP=\-1
The host port mapping for the container port. To demonstrate a single\-machine container.
.PP
\fB\-\-image\fP=""
The image for the container to run.
.PP
\fB\-l\fP, \fB\-\-labels\fP=""
Labels to apply to the pod(s).
.PP
\fB\-\-no\-headers\fP=false
When using the default output, don't print headers.
.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: json|yaml|template|templatefile.
.PP
\fB\-\-output\-version\fP=""
Output the formatted object with the given version (default api\-version).
.PP
\fB\-\-overrides\fP=""
An inline JSON override for the generated object. If this is non\-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
.PP
\fB\-\-port\fP=\-1
The port that this container exposes.
.PP
\fB\-r\fP, \fB\-\-replicas\fP=1
Number of replicas to create for this container. Default is 1.
.PP
\fB\-t\fP, \fB\-\-template\fP=""
Template string or path to template file to use when \-o=template or \-o=templatefile. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Starts a single instance of nginx.
$ kubectl run nginx \-\-image=nginx
// Starts a replicated instance of nginx.
$ kubectl run nginx \-\-image=nginx \-\-replicas=5
// Dry run. Print the corresponding API objects without creating them.
$ kubectl run nginx \-\-image=nginx \-\-dry\-run
// Start a single instance of nginx, but overload the spec of the replication controller with a partial set of values parsed from JSON.
$ kubectl run nginx \-\-image=nginx \-\-overrides='\{ "apiVersion": "v1", "spec": \{ ... \} \}'
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

163
release-0.19.0/docs/man/man1/kubectl-scale.1 Normal file
View File

@@ -0,0 +1,163 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl scale \- Set a new size for a Replication Controller.
.SH SYNOPSIS
.PP
\fBkubectl scale\fP [OPTIONS]
.SH DESCRIPTION
.PP
Set a new size for a Replication Controller.
.PP
Scale also allows users to specify one or more preconditions for the scale action.
If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before the
scale is attempted, and it is guaranteed that the precondition holds true when the
scale is sent to the server.
.SH OPTIONS
.PP
\fB\-\-current\-replicas\fP=\-1
Precondition for current size. Requires that the current size of the replication controller match this value in order to scale.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for scale
.PP
\fB\-\-replicas\fP=\-1
The new desired number of replicas. Required.
.PP
\fB\-\-resource\-version\fP=""
Precondition for resource version. Requires that the current resource version match this value in order to scale.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Scale replication controller named 'foo' to 3.
$ kubectl scale \-\-replicas=3 replicationcontrollers foo
// If the replication controller named foo's current size is 2, scale foo to 3.
$ kubectl scale \-\-current\-replicas=2 \-\-replicas=3 replicationcontrollers foo
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

179
release-0.19.0/docs/man/man1/kubectl-stop.1 Normal file
View File

@@ -0,0 +1,179 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl stop \- Gracefully shut down a resource by id or filename.
.SH SYNOPSIS
.PP
\fBkubectl stop\fP [OPTIONS]
.SH DESCRIPTION
.PP
Gracefully shut down a resource by id or filename.
.PP
Attempts to shut down and delete a resource that supports graceful termination.
If the resource is scalable it will be scaled to 0 before deletion.
.SH OPTIONS
.PP
\fB\-\-all\fP=false
[\-all] to select all the specified resources.
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file of resource(s) to be stopped.
.PP
\fB\-\-grace\-period\fP=\-1
Period of time in seconds given to the resource to terminate gracefully. Ignored if negative.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for stop
.PP
\fB\-\-ignore\-not\-found\fP=false
Treat "resource not found" as a successful stop.
.PP
\fB\-l\fP, \fB\-\-selector\fP=""
Selector (label query) to filter on.
.PP
\fB\-\-timeout\fP=0
The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Shut down foo.
$ kubectl stop replicationcontroller foo
// Stop pods and services with label name=myLabel.
$ kubectl stop pods,services \-l name=myLabel
// Shut down the service defined in service.json
$ kubectl stop \-f service.json
// Shut down all resources in the path/to/resources directory
$ kubectl stop \-f path/to/resources
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

152
release-0.19.0/docs/man/man1/kubectl-update.1 Normal file
View File

@@ -0,0 +1,152 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl update \- Update a resource by filename or stdin.
.SH SYNOPSIS
.PP
\fBkubectl update\fP [OPTIONS]
.SH DESCRIPTION
.PP
Update a resource by filename or stdin.
.PP
JSON and YAML formats are accepted.
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file to use to update the resource.
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for update
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Update a pod using the data in pod.json.
$ kubectl update \-f pod.json
// Update a pod based on the JSON passed into stdin.
$ cat pod.json | kubectl update \-f \-
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

134
release-0.19.0/docs/man/man1/kubectl-version.1 Normal file
View File

@@ -0,0 +1,134 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl version \- Print the client and server version information.
.SH SYNOPSIS
.PP
\fBkubectl version\fP [OPTIONS]
.SH DESCRIPTION
.PP
Print the client and server version information.
.SH OPTIONS
.PP
\fB\-c\fP, \fB\-\-client\fP=false
Client version only (no server required).
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for version
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

132
release-0.19.0/docs/man/man1/kubectl.1 Normal file
View File

@@ -0,0 +1,132 @@
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl \- kubectl controls the Kubernetes cluster manager
.SH SYNOPSIS
.PP
\fBkubectl\fP [OPTIONS]
.SH DESCRIPTION
.PP
kubectl controls the Kubernetes cluster manager.
.PP
Find more information at
\[la]https://github.com/GoogleCloudPlatform/kubernetes\[ra].
.SH OPTIONS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.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\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl\-get(1)\fP, \fBkubectl\-describe(1)\fP, \fBkubectl\-create(1)\fP, \fBkubectl\-update(1)\fP, \fBkubectl\-delete(1)\fP, \fBkubectl\-namespace(1)\fP, \fBkubectl\-logs(1)\fP, \fBkubectl\-rolling\-update(1)\fP, \fBkubectl\-scale(1)\fP, \fBkubectl\-exec(1)\fP, \fBkubectl\-port\-forward(1)\fP, \fBkubectl\-proxy(1)\fP, \fBkubectl\-run(1)\fP, \fBkubectl\-stop(1)\fP, \fBkubectl\-expose(1)\fP, \fBkubectl\-label(1)\fP, \fBkubectl\-config(1)\fP, \fBkubectl\-cluster\-info(1)\fP, \fBkubectl\-api\-versions(1)\fP, \fBkubectl\-version(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

339
release-0.19.0/docs/man/man1/kubelet.1 Normal file
View File

@@ -0,0 +1,339 @@
.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
release-0.19.0/docs/man/md2man-all.sh Executable file
View File

@@ -0,0 +1,41 @@
#!/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