openshift-cli-cluster-up man page

openshift cli cluster up — Start OpenShift on Docker with reasonable defaults

Synopsis

openshift cli cluster up [Options]

Description

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.

Options

--create-machine=false
Create a Docker machine if one doesn't exist
--docker-machine=""
Specify the Docker machine to use
-e, --env=[]
Specify key value pairs of environment variables to set on OpenShift container
--forward-ports=false
Use Docker port-forwarding to communicate with origin container. Requires 'socat' locally.
--host-config-dir="/var/lib/origin/openshift.local.config"
Directory on Docker host for OpenShift configuration
--host-data-dir=""
Directory on Docker host for OpenShift data. If not specified, etcd data will not be persisted on the host.
--host-volumes-dir="/var/lib/origin/openshift.local.volumes"
Directory on Docker host for OpenShift volumes
--image="openshift/origin"
Specify the images to use for OpenShift
--metrics=false
Install metrics (experimental)
--public-hostname=""
Public hostname for OpenShift cluster
--routing-suffix=""
Default suffix for server routes
--server-loglevel=0
Log level for OpenShift server
--skip-registry-check=false
Skip Docker daemon registry check
--use-existing-config=false
Use existing configuration if present
--version=""
Specify the tag for OpenShift images

Options Inherited from Parent Commands

--api-version=""
DEPRECATED: The API version to use when talking to the server

--as=""
Username to impersonate for the operation.

--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

--config=""
Path to the config file to use for CLI requests.

--context=""
The name of the kubeconfig context to use

--google-json-key=""
The Google Cloud Platform Service Account JSON Key to use for authentication.

--insecure-skip-tls-verify=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.

--log-flush-frequency=0
Maximum number of seconds between log flushes

--match-server-version=false
Require server version to match client version

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

--server=""
The address and port of the Kubernetes API server

--token=""
Bearer token for authentication to the API server.

--user=""
The name of the kubeconfig user to use

Example

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

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

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

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

See Also

openshift-cli-cluster(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-cli-cluster(1).

Openshift CLI User Manuals Openshift June 2016