mirror of
https://github.com/docker/docs.git
synced 2026-04-05 02:38:52 +07:00
e44f5d8796
- Close #194 and fix - Fix and close #425 - Fix and close #417 - Fix and close #420 - Fix and close #422 - Adding in documentation build scripts - Fix and close #431 - Fix and close #438, and Fix and close #429 - Work on 441 - Adding in commands reference - Updating all the options to tables - Updating per Vivek #498 - Adding vivek's last suggestions Signed-off-by: Mary Anthony <mary@docker.com>
61 lines
2.8 KiB
Markdown
61 lines
2.8 KiB
Markdown
+++
|
|
title = "join"
|
|
description = "Join this Engine to an existing UCP"
|
|
[menu.main]
|
|
identifier = "ucp_join"
|
|
parent = "ucp_ref"
|
|
+++
|
|
|
|
# join
|
|
|
|
Join this Engine to an existing UCP
|
|
|
|
## Usage
|
|
|
|
```
|
|
docker run --rm -it \
|
|
--name ucp \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
docker/ucp \
|
|
join [command options]
|
|
```
|
|
|
|
## Description
|
|
|
|
When running the `join` command, you must run this tool
|
|
on the engine you wish to join to an existing UCP. The UCP controller
|
|
must be running on a different engine. Both engines must have network
|
|
visibility to eachother and have the required ports open on their firewall
|
|
settings. If your system has multiple IP addresses, you may need to
|
|
specify the `--host-address` option to ensure the correct address is used.
|
|
|
|
Ports: 443 (`--controller-port` from `install`), 12376, 12379, 12380, 12381, 12382 and 2376 (`--swarm-port` from `install`)
|
|
|
|
To enable high-availability, you must join at least one node with the
|
|
`replica` flag.
|
|
|
|
|
|
## Options
|
|
|
|
| Option | Description |
|
|
|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
|
|
| `--debug`, `-D` | Enable debug. |
|
|
| `--jsonlog` | Produce json formatted output for easier parsing. |
|
|
| `--interactive`, `-i` | Enable interactive mode. You will be prompted to enter all required information. |
|
|
| `--fresh-install` | Destroy any existing state and start fresh. |
|
|
| `--san` [`--san option` `--san option`] | Additional Subject Alternative Names for certs (e.g. `--san foo1.bar.com --san foo2.bar.com`). |
|
|
| `--host-address` | Specify the visible IP/hostname for this node. (override automatic detection) [`$UCP_HOST_ADDRESS`] |
|
|
| `--swarm-port "2376"` | Select what port to run the local Swarm manager on. |
|
|
| `--controller-port "443"` | Select what port to run the local Controller on. |
|
|
| `--dns` [`--dns option --dns option`] | Set custom DNS servers for the UCP infrastructure containers. |
|
|
| `--dns-opt `[`--dns-opt option --dns-opt option`] | Set DNS options for the UCP infrastructure containers. |
|
|
| `--dns-search` [`--dns-search option --dns-search option`] | Set custom DNS search domains for the UCP infrastructure containers. |
|
|
| `--disable-tracking` | Disable anonymous tracking and analytics. |
|
|
| `--disable-usage` | Disable anonymous usage reporting. |
|
|
| `--image-version "0.7.0"` | Select a specific UCP version. |
|
|
| `--url` | The connection URL for the remote UCP controller [`$UCP_URL`] |
|
|
| `--fingerprint ` | The fingerprint of the UCP controller you trust [`$UCP_FINGERPRINT`] |
|
|
| `--replica` | Configure this node as a full Orca controller replica. |
|
|
| `--external-ucp-ca` | (Replica only) Use externally signed certificates for the controller. |
|
|
| `--pull "missing"` | Specify image pull behavior (`always`, when `missing`, or `never`). |
|