oc-expose man page

oc expose — Expose a replicated application as a service or route


oc expose [Options]


Expose containers internally as services or externally via routes

There is also the ability to expose a deployment configuration, replication controller, service, or pod as a new service on a specified port. If no labels are specified, the new object will re-use the labels from the object it exposes.


Synonym for --target-port
If true, create an external load balancer for this service (trumped by --type). Implementation is cloud provider dependent. Default is 'false'.
If true, only print the object that would be sent, without sending it.
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.
-f, --filename=[]
Filename, directory, or URL to a file identifying the resource to expose a service
The name of the API generator to use.
Set a hostname for the new route
-l, --labels=""
Labels to apply to the service created by this call.
IP to assign to to the Load Balancer. If empty, an ephemeral IP will be created and used (cloud-provider specific).
The name for the newly created object.
When using the default output, don't print headers.
-o, --output=""
Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [ ⟨http://golang.org/pkg/text/template/#pk…⟩] and jsonpath template [ ⟨http://releases.k8s.io/release-1.3/docs…⟩].
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
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.
Set a path for the new route
The port that the resource should serve on.
The network protocol for the service to be created. Default is 'TCP'.
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.
If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
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.
If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP'
-a, --show-all=true
When printing, show all resources (false means hide terminated pods.)
When printing, show all labels as the last column (default hide labels column)
If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
Name or number for the port on the container that the service should direct traffic to. Optional.
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/#pk…⟩].
Type for this service: ClusterIP, NodePort, or LoadBalancer. Default is 'ClusterIP'.

Options Inherited from Parent Commands

DEPRECATED: The API version to use when talking to the server

Username to impersonate for the operation.

Path to a cert. file for the certificate authority.

Path to a client certificate file for TLS.

Path to a client key file for TLS.

The name of the kubeconfig cluster to use

Path to the config file to use for CLI requests.

The name of the kubeconfig context to use

The Google Cloud Platform Service Account JSON Key to use for authentication.

If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.

Maximum number of seconds between log flushes

Require server version to match client version

-n, --namespace=""
If present, the namespace scope for this CLI request.

The address and port of the Kubernetes API server

Bearer token for authentication to the API server.

The name of the kubeconfig user to use


# Create a route based on service nginx. The new route will re-use nginx's labels
oc expose service nginx

# Create a route and specify your own label and route name
oc expose service nginx -l name=myroute --name=fromdowntown

# Create a route and specify a hostname
oc expose service nginx --hostname=www.example.com

# Expose a deployment configuration as a service and use the specified port
oc expose dc ruby-hello-world --port=8080

# Expose a service as a route in the specified path
oc expose service nginx --path=/nginx

See Also



June 2016, Ported from the Kubernetes man-doc generator

Referenced By


Openshift CLI User Manuals Openshift June 2016