1OC CLUSTER(1) June 2016 OC CLUSTER(1)
2
6 oc cluster up - Start OpenShift on Docker with reasonable defaults
7
11 oc cluster up [OPTIONS]
12
16 Starts an OpenShift cluster using Docker containers, provisioning a
17 registry, router, initial templates, and a default project.
18 This command will attempt to use an existing connection to a Docker
21 daemon. Before running the command, ensure that you can execute docker
22 commands successfully (i.e. 'docker ps').
23 By default, the OpenShift cluster will be setup to use a routing suffix
26 that ends in nip.io. This is to allow dynamic host names to be created
27 for routes. An alternate routing suffix can be specified using the
28 --routing-suffix flag.
29 A public hostname can also be specified for the server with the --pub‐
32 lic-hostname flag.
33
37 --base-dir=""
38 Directory on Docker host for cluster up configuration
39 --enable=[]
42 A list of components to enable. '' enables all on-by-default com‐
43 ponents, 'foo' enables the component named 'foo', '-foo' disables the
44 component named 'foo'. All components: automation-service-broker, cen‐
45 tos-imagestreams, persistent-volumes, registry, rhel-imagestreams,
46 router, sample-templates, service-catalog, template-service-broker,
47 web-console Disabled-by-default components: automation-service-broker,
48 rhel-imagestreams, service-catalog, template-service-broker
49 --forward-ports=false
52 Use Docker port-forwarding to communicate with origin container.
53 Requires 'socat' locally.
54 --http-proxy=""
57 HTTP proxy to use for master and builds
58 --https-proxy=""
61 HTTPS proxy to use for master and builds
62 --image="openshift/origin-${component}:${version}"
65 Specify the images to use for OpenShift
66 --no-proxy=[]
69 List of hosts or subnets for which a proxy should not be used
70 --public-hostname=""
73 Public hostname for OpenShift cluster
74 --routing-suffix=""
77 Default suffix for server routes
78 --server-loglevel=0
81 Log level for OpenShift server
82 --skip-registry-check=false
85 Skip Docker daemon registry check
86 --write-config=false
89 Write the configuration files into host config dir
90
94 --allow_verification_with_non_compliant_keys=false
95 Allow a SignatureVerifier to use keys which are technically
96 non-compliant with RFC6962.
97 --alsologtostderr=false
100 log to standard error as well as files
101 --application_metrics_count_limit=100
104 Max number of application metrics to store (per container)
105 --as=""
108 Username to impersonate for the operation
109 --as-group=[]
112 Group to impersonate for the operation, this flag can be repeated
113 to specify multiple groups.
114 --azure-container-registry-config=""
117 Path to the file containing Azure container registry configuration
118 information.
119 --boot_id_file="/proc/sys/kernel/random/boot_id"
122 Comma-separated list of files to check for boot-id. Use the first
123 one that exists.
124 --cache-dir="/builddir/.kube/http-cache"
127 Default HTTP cache directory
128 --certificate-authority=""
131 Path to a cert file for the certificate authority
132 --client-certificate=""
135 Path to a client certificate file for TLS
136 --client-key=""
139 Path to a client key file for TLS
140 --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
143 CIDRs opened in GCE firewall for LB traffic proxy health checks
144 --cluster=""
147 The name of the kubeconfig cluster to use
148 --container_hints="/etc/cadvisor/container_hints.json"
151 location of the container hints file
152 --containerd="unix:///var/run/containerd.sock"
155 containerd endpoint
156 --context=""
159 The name of the kubeconfig context to use
160 --default-not-ready-toleration-seconds=300
163 Indicates the tolerationSeconds of the toleration for
164 notReady:NoExecute that is added by default to every pod that does not
165 already have such a toleration.
166 --default-unreachable-toleration-seconds=300
169 Indicates the tolerationSeconds of the toleration for unreach‐
170 able:NoExecute that is added by default to every pod that does not
171 already have such a toleration.
172 --docker="unix:///var/run/docker.sock"
175 docker endpoint
176 --docker-tls=false
179 use TLS to connect to docker
180 --docker-tls-ca="ca.pem"
183 path to trusted CA
184 --docker-tls-cert="cert.pem"
187 path to client certificate
188 --docker-tls-key="key.pem"
191 path to private key
192 --docker_env_metadata_whitelist=""
195 a comma-separated list of environment variable keys that needs to
196 be collected for docker containers
197 --docker_only=false
200 Only report docker containers in addition to root stats
201 --docker_root="/var/lib/docker"
204 DEPRECATED: docker root is read from docker info (this is a fall‐
205 back, default: /var/lib/docker)
206 --enable_load_reader=false
209 Whether to enable cpu load reader
210 --event_storage_age_limit="default=24h"
213 Max length of time for which to store events (per type). Value is a
214 comma separated list of key values, where the keys are event types
215 (e.g.: creation, oom) or "default" and the value is a duration. Default
216 is applied to all non-specified event types
217 --event_storage_event_limit="default=100000"
220 Max number of events to store (per type). Value is a comma sepa‐
221 rated list of key values, where the keys are event types (e.g.: cre‐
222 ation, oom) or "default" and the value is an integer. Default is
223 applied to all non-specified event types
224 --global_housekeeping_interval=0
227 Interval between global housekeepings
228 --housekeeping_interval=0
231 Interval between container housekeepings
232 --httptest.serve=""
235 if non-empty, httptest.NewServer serves on this address and blocks
236 --insecure-skip-tls-verify=false
239 If true, the server's certificate will not be checked for validity.
240 This will make your HTTPS connections insecure
241 --kubeconfig=""
244 Path to the kubeconfig file to use for CLI requests.
245 --log-flush-frequency=0
248 Maximum number of seconds between log flushes
249 --log_backtrace_at=:0
252 when logging hits line file:N, emit a stack trace
253 --log_cadvisor_usage=false
256 Whether to log the usage of the cAdvisor container
257 --log_dir=""
260 If non-empty, write log files in this directory
261 --logtostderr=true
264 log to standard error instead of files
265 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
268 Comma-separated list of files to check for machine-id. Use the
269 first one that exists.
270 --match-server-version=false
273 Require server version to match client version
274 -n, --namespace=""
277 If present, the namespace scope for this CLI request
278 --request-timeout="0"
281 The length of time to wait before giving up on a single server
282 request. Non-zero values should contain a corresponding time unit (e.g.
283 1s, 2m, 3h). A value of zero means don't timeout requests.
284 -s, --server=""
287 The address and port of the Kubernetes API server
288 --stderrthreshold=2
291 logs at or above this threshold go to stderr
292 --storage_driver_buffer_duration=0
295 Writes in the storage driver will be buffered for this duration,
296 and committed to the non memory backends as a single transaction
297 --storage_driver_db="cadvisor"
300 database name
301 --storage_driver_host="localhost:8086"
304 database host:port
305 --storage_driver_password="root"
308 database password
309 --storage_driver_secure=false
312 use secure connection with database
313 --storage_driver_table="stats"
316 table name
317 --storage_driver_user="root"
320 database username
321 --token=""
324 Bearer token for authentication to the API server
325 --user=""
328 The name of the kubeconfig user to use
329 -v, --v=0
332 log level for V logs
333 --version=false
336 Print version information and quit
337 --vmodule=
340 comma-separated list of pattern=N settings for file-filtered log‐
341 ging
342
346 # Start OpenShift using a specific public host name
347 oc cluster up --public-hostname=my.address.example.com
348
353 oc-cluster(1),
354
358 June 2016, Ported from the Kubernetes man-doc generator
359Openshift Openshift CLI User Manuals OC CLUSTER(1)