openshift-cli-cluster-join man page

openshift cli cluster join ā€” Join an existing OpenShift cluster

Synopsis

openshift cli cluster join [Options]

Description

Add a new node to an existing OpenShift cluster

Uses an existing connection to a Docker daemon to start an OpenShift node. You must provide a secret to connect to the master. Before running command, ensure that you can execute docker commands successfully (ie. 'docker ps').

Optionally, the command can create a new Docker machine for your OpenShift node using the VirtualBox driver when the --create-machine argument is specified. The machine will be named 'node' 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.

Options

--create-machine=false

Create a Docker machine if one doesn't exist

--docker-machine=""

Specify the Docker machine to use

-e, --env=[]

Specify a key-value pair for an environment variable 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-pv-dir="/var/lib/origin/openshift.local.pv"

Directory on host for OpenShift persistent volumes

--host-volumes-dir="/var/lib/origin/openshift.local.volumes"

Directory on Docker host for OpenShift volumes

--http-proxy=""

HTTP proxy to use for master and builds

--https-proxy=""

HTTPS proxy to use for master and builds

--image="openshift/origin"

Specify the images to use for OpenShift

--image-streams="centos7"

Specify which image streams to use, centos7|rhel7

--logging=false

Install logging (experimental)

--metrics=false

Install metrics (experimental)

--no-proxy=[]

List of hosts or subnets for which a proxy should not be used

--public-hostname=""

Public hostname for OpenShift cluster

--routing-suffix=""

Default suffix for server routes

--secret=""

Pass the secret to use to connect to the cluster

--server-loglevel=0

Log level for OpenShift server

--service-catalog=false

Install service catalog (experimental).

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

--azure-container-registry-config=""

Path to the file container Azure container registry configuration information.

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

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

--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 a new OpenShift node on a new docker machine named 'node'
  openshift cli cluster join --create-machine
  
  # Start OpenShift node and preserve data and config between restarts
  openshift cli cluster join --host-data-dir=/mydata --use-existing-config
  
  # Use a different set of images
  openshift cli cluster join --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 June 2016