oc-cluster-up man page

oc cluster up — Start OpenShift on Docker with reasonable defaults


oc cluster up [Options]


Starts an OpenShift cluster using Docker containers, provisioning a registry, router, initial templates, and a default project.

This command will attempt to use an existing connection to a Docker daemon. Before running the command, ensure that you can execure docker commands successfully (ie. 'docker ps').

Optionally, the command can create a new Docker machine for OpenShift using the VirtualBox driver when the --create-machine argument is specified. The machine will be named 'openshift' by default. To name the machine differently, use the --docker-machine=NAME argument. If the --docker-machine=NAME argument is specified, but --create-machine is not, the command will attempt to find an existing docker machine with that name and start it if it's not running.

By default, the OpenShift cluster will be setup to use a routing suffix that ends in xip.io. This is to allow dynamic host names to be created for routes. An alternate routing suffix can be specified using the --routing-suffix flag.

A public hostname can also be specified for the server with the --public-hostname flag.


Create a Docker machine if one doesn't exist
Specify the Docker machine to use
-e, --env=[]
Specify key value pairs of environment variables to set on OpenShift container
Use Docker port-forwarding to communicate with origin container. Requires 'socat' locally.
Directory on Docker host for OpenShift configuration
Directory on Docker host for OpenShift data. If not specified, etcd data will not be persisted on the host.
Directory on Docker host for OpenShift volumes
Specify the images to use for OpenShift
Install metrics (experimental)
Public hostname for OpenShift cluster
Default suffix for server routes
Log level for OpenShift server
Skip Docker daemon registry check
Use existing configuration if present
Specify the tag for OpenShift images

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


# Start OpenShift on a new docker machine named 'openshift'
oc cluster up --create-machine

# Start OpenShift using a specific public host name
oc cluster up --public-hostname=my.address.example.com

# Start OpenShift and preserve data and config between restarts
oc cluster up --host-data-dir=/mydata --use-existing-config

# Use a different set of images
oc cluster up --image="registry.example.com/origin" --version="v1.1"

See Also



June 2016, Ported from the Kubernetes man-doc generator

Referenced By


Explore man page connections for oc-cluster-up(1).

Openshift Openshift CLI User Manuals June 2016