Eric Paris Jan 2015
kubectl expose [Options]
Expose a resource as a new Kubernetes service.
Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector for that resource as the selector for a new service on the specified port. A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports, i.e. when the selector contains only the matchLabels component. Note that if no port is specified via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no labels are specified, the new service will re-use the labels from the resource it exposes.
Possible resources include (case insensitive):
pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)
--allow-missing-template-keys=true If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.
--cluster-ip="" ClusterIP to be assigned to the service. Leave empty to auto-allocate, or set to 'None' to create a headless service.
--container-port="" Synonym for --target-port
--dry-run="none" Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.
--external-ip="" Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP.
--field-manager="kubectl-expose" Name of the manager used to track field ownership.
-f, --filename= Filename, directory, or URL to files identifying the resource to expose a service
--generator="service/v2" The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'.
-k, --kustomize="" Process the kustomization directory. This flag can't be used together with -f or -R.
-l, --labels="" Labels to apply to the service created by this call.
--load-balancer-ip="" IP to assign to the LoadBalancer. If empty, an ephemeral IP will be created and used (cloud-provider specific).
--name="" The name for the newly created object.
-o, --output="" Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file.
--overrides="" 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.
--port="" The port that the service should serve on. Copied from the resource being exposed, if unspecified
--protocol="" The network protocol for the service to be created. Default is 'TCP'.
--record=false Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
-R, --recursive=false Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--save-config=false If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future.
--selector="" A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set.)
--session-affinity="" If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP'
--show-managed-fields=false If true, keep the managedFields when printing objects in JSON or YAML format.
--target-port="" Name or number for the port on the container that the service should direct traffic to. Optional.
--template="" Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
--type="" Type for this service: ClusterIP, NodePort, LoadBalancer, or ExternalName. Default is 'ClusterIP'.
Options Inherited from Parent Commands
--add-dir-header=false If true, adds the file directory to the header of the log messages
--alsologtostderr=false log to standard error as well as files
--application-metrics-count-limit=100 Max number of application metrics to store (per container)
--as="" Username to impersonate for the operation
--as-group= Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--azure-container-registry-config="" Path to the file containing 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.
--cache-dir="/builddir/.kube/cache" Default cache directory
--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
--cloud-provider-gce-l7lb-src-cidrs=18.104.22.168/22,22.214.171.124/16 CIDRs opened in GCE firewall for L7 LB traffic proxy health checks
--cloud-provider-gce-lb-src-cidrs=126.96.36.199/22,188.8.131.52/22,184.108.40.206/22,220.127.116.11/16 CIDRs opened in GCE firewall for L4 LB traffic proxy health checks
--cluster="" The name of the kubeconfig cluster to use
--container-hints="/etc/cadvisor/container_hints.json" location of the container hints file
--containerd="/run/containerd/containerd.sock" containerd endpoint
--containerd-namespace="k8s.io" containerd namespace
--context="" The name of the kubeconfig context to use
--default-not-ready-toleration-seconds=300 Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration.
--default-unreachable-toleration-seconds=300 Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration.
--disable-root-cgroup-stats=false Disable collecting root Cgroup stats
--docker="unix:///var/run/docker.sock" docker endpoint
--docker-env-metadata-whitelist="" a comma-separated list of environment variable keys matched with specified prefix 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)
--docker-tls=false use TLS to connect to docker
--docker-tls-ca="ca.pem" path to trusted CA
--docker-tls-cert="cert.pem" path to client certificate
--docker-tls-key="key.pem" path to private key
--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
--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
--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
--log-file="" If non-empty, use this log file
--log-file-max-size=1800 Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited.
--log-flush-frequency=5s Maximum number of seconds between log flushes
--logtostderr=true 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
--one-output=false If true, only write logs to their native severity level (vs also writing to each lower severity level)
--password="" Password for basic authentication to the API server
--profile="none" Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)
--profile-output="profile.pprof" Name of the file to write the profile to
--referenced-reset-interval=0 Reset interval for referenced bytes (container_referenced_bytes metric), number of measurement cycles after which referenced bytes are cleared, if set to 0 referenced bytes are never cleared (default: 0)
--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
--skip-headers=false If true, avoid header prefixes in the log messages
--skip-log-headers=false If true, avoid headers when opening log files
--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
--tls-server-name="" Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
--token="" Bearer token for authentication to the API server
--update-machine-info-interval=5m0s Interval between machine info updates.
--user="" The name of the kubeconfig user to use
--username="" Username for basic authentication to the API server
-v, --v=0 number for the log level verbosity
--version=false Print version information and quit
--vmodule= comma-separated list of pattern=N settings for file-filtered logging
--warnings-as-errors=false Treat warnings received from the server as errors and exit with a non-zero exit code
# Create 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 # Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000. kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000 # Create a service for a pod valid-pod, which serves on port 444 with the name "frontend" kubectl expose pod valid-pod --port=444 --name=frontend # Create 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 # Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000. kubectl expose rs nginx --port=80 --target-port=8000 # Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000. kubectl expose deployment nginx --port=80 --target-port=8000
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!