kubectl man page

kubectl — kubectl controls the Kubernetes cluster manager

Synopsis

kubectl [Options]

Description

kubectl controls the Kubernetes cluster manager.

Find more information at ⟨https://github.com/kubernetes/kubernetes⟩.

Options

--allow-verification-with-non-compliant-keys=false
Allow a SignatureVerifier to use keys which are technically non-compliant with RFC6962.
--alsologtostderr=false
log to standard error as well as files
--api-version=""
DEPRECATED: The API version to use when talking to the server
--application-metrics-count-limit=100
Max number of application metrics to store (per container)
--as=""
Username to impersonate for the operation
--azure-container-registry-config=""
Path to the file container Azure container registry configuration information.
--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.
--certificate-authority=""
Path to a cert. file for the certificate authority
--client-certificate=""
Path to a client certificate file for TLS
--client-key=""
Path to a client key file for TLS
--cluster=""
The name of the kubeconfig cluster to use
--container-hints="/etc/cadvisor/container_hints.json"
location of the container hints file
--context=""
The name of the kubeconfig context to use
--docker="unix:///var/run/docker.sock"
docker endpoint
--docker-env-metadata-whitelist=""
a comma-separated list of environment variable keys that needs to be collected for docker containers
--docker-only=false
Only report docker containers in addition to root stats
--docker-root="/var/lib/docker"
DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker)
--enable-load-reader=false
Whether to enable cpu load reader
--event-storage-age-limit="default=0"
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=0"
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
--global-housekeeping-interval=1m0s
Interval between global housekeepings
--google-json-key=""
The Google Cloud Platform Service Account JSON Key to use for authentication.
--housekeeping-interval=10s
Interval between container housekeepings
--insecure-skip-tls-verify=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--ir-data-source="influxdb"
Data source used by InitialResources. Supported options: influxdb, gcm.
--ir-dbname="k8s"
InfluxDB database name which contains metrics required by InitialResources
--ir-hawkular=""
Hawkular configuration URL
--ir-influxdb-host="localhost:8080/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb:api"
Address of InfluxDB which contains metrics required by InitialResources
--ir-namespace-only=false
Whether the estimation should be made only based on data from the same namespace.
--ir-password="root"
Password used for connecting to InfluxDB
--ir-percentile=90
Which percentile of samples should InitialResources use when estimating resources. For experiment purposes.
--ir-user="root"
User used for connecting to InfluxDB
--kubeconfig=""
Path to the kubeconfig file to use for CLI requests.
--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
--loglevel=1
Log level (0 = DEBUG, 5 = FATAL)
--logtostderr=false
log to standard error instead of files
--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.
--match-server-version=false
Require server version to match client version
-n, --namespace=""
If present, the namespace scope for this CLI request
--password=""
Password for basic authentication to the API server
--request-timeout="0"
The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.
-s, --server=""
The address and port of the Kubernetes API server
--stderrthreshold=2
logs at or above this threshold go to stderr
--storage-driver-buffer-duration=1m0s
Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction
--storage-driver-db="cadvisor"
database name
--storage-driver-host="localhost:8086"
database host:port
--storage-driver-password="root"
database password
--storage-driver-secure=false
use secure connection with database
--storage-driver-table="stats"
table name
--storage-driver-user="root"
database username
--token=""
Bearer token for authentication to the API server
--user=""
The name of the kubeconfig user to use
--username=""
Username for basic authentication to the API server
-v, --v=0
log level for V logs
--vmodule=
comma-separated list of pattern=N settings for file-filtered logging

See Also

kubectl-annotate(1), kubectl-api-versions(1), kubectl-apply(1), kubectl-attach(1), kubectl-autoscale(1), kubectl-certificate(1), kubectl-cluster-info(1), kubectl-completion(1), kubectl-config(1), kubectl-convert(1), kubectl-cordon(1), kubectl-cp(1), kubectl-create(1), kubectl-delete(1), kubectl-describe(1), kubectl-drain(1), kubectl-edit(1), kubectl-exec(1), kubectl-explain(1), kubectl-expose(1), kubectl-get(1), kubectl-label(1), kubectl-logs(1), kubectl-options(1), kubectl-patch(1), kubectl-port-forward(1), kubectl-proxy(1), kubectl-replace(1), kubectl-rolling-update(1), kubectl-rollout(1), kubectl-run(1), kubectl-scale(1), kubectl-set(1), kubectl-stop(1), kubectl-taint(1), kubectl-top(1), kubectl-uncordon(1), kubectl-version(1),

History

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!

Referenced By

kubectl-annotate(1), kubectl-api-versions(1), kubectl-apply(1), kubectl-attach(1), kubectl-autoscale(1), kubectl-certificate(1), kubectl-cluster-info(1), kubectl-completion(1), kubectl-config(1), kubectl-convert(1), kubectl-cordon(1), kubectl-cp(1), kubectl-create(1), kubectl-delete(1), kubectl-describe(1), kubectl-drain(1), kubectl-edit(1), kubectl-exec(1), kubectl-explain(1), kubectl-expose(1), kubectl-get(1), kubectl-label(1), kubectl-logs(1), kubectl-options(1), kubectl-patch(1), kubectl-port-forward(1), kubectl-proxy(1), kubectl-replace(1), kubectl-rolling-update(1), kubectl-rollout(1), kubectl-run(1), kubectl-scale(1), kubectl-set(1), kubectl-stop(1), kubectl-taint(1), kubectl-top(1), kubectl-uncordon(1), kubectl-version(1).

kubernetes User Manuals Eric Paris Jan 2015