Get Started
Quickstart containers Understand the architecture
Migrate to Engine 1.10 Breaking changes Deprecated Engine Features FAQ
Release Notes
Learn about Dockerfiles and Docker Cloud Back up data volumes Create a proxy or load balancer Install the Deploy to Docker Cloud button Integrate with Slack Push images to Docker Cloud SSHing into a Docker Cloud-managed node Upgrade Docker Engine on a node Use the Docker Cloud Agent Using the Docker Cloud CLI
API reference
Quickstart contribution FAQ for contributors Where to chat or get help Style guide for Docker documentation

install

Install UCP on this engine.

docker run --rm -it \
    --name ucp \
    -v /var/run/docker.sock:/var/run/docker.sock \
    docker/ucp \
    install [OPTIONS]

Description

Install the UCP controller on a machine. You can only install on machines where Docker Engine is already installed. If you intend to install a multi-node cluster, you must open firewall ports between the Engines for the following ports:

  • 443 (customizable using the --controller-port option)
  • 12376
  • 12379 through 12382
  • 2376 (customizable using the --swarm-port option)

You can optionally use an externally generated and signed certificate for the UCP controller by using the --external-ucp-ca. Create a storage volume named ucp-server-certs with ca.pem, cert.pem, and key.pem in the root directory before running the install.

A license file can optionally be added during install by volume mounting the file at /docker_subscription.lic in the tool.

-v /path/to/my/docker_subscription.lic:/docker_subscription.lic

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.
--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.
--external-ucp-ca Set up UCP with an external CA.
--preserve-certs Don’t (re)generate certs on the host if existing ones are found.
--binpack Set Swarm scheduler to binpack mode (default spread).
--random Set Swarm scheduler to random mode (default spread).
--pull "missing" Specify image pull behavior (always, when missing, or never).
On this page:
Mar 5, 2016 at 2:08am (PST) { "docker/apidocs": { "ref": "master", "repos": [ "git@github.com:docker/dhe-deploy.git" ], "sha": "70ac255c88cde0ea6ecf3fcb812783dea7e09da6" }, "docker/cloud-api-docs": { "ref": "master", "repos": [ "git@github.com:docker/cloud-docs.git" ], "sha": "c0539949c40be9abb193271e46d2ea88196f122d" }, "docker/cloud-api-docs-layout": { "ref": "master", "repos": [ "git@github.com:docker/cloud-docs.git" ], "sha": "c0539949c40be9abb193271e46d2ea88196f122d" }, "docker/compose": { "ref": "docs", "repos": [ "git@github.com:docker/compose.git" ], "sha": "9da9555f10abe628e7742476af3f10bd89f68b75" }, "docker/docker": { "ref": "docs", "repos": [ "git@github.com:docker/docker.git" ], "sha": "0e63b073ac8f33335a4d4df3f2aa22120e0b7f43" }, "docker/docker-cloud": { "ref": "master", "repos": [ "git@github.com:docker/cloud-docs.git" ], "sha": "c0539949c40be9abb193271e46d2ea88196f122d" }, "docker/docker-hub": { "ref": "master", "repos": [ "git@github.com:docker/hub2-demo.git" ], "sha": "73ccb2d678ab0cd83067f0c7ef6f3923d750c7bd" }, "docker/docker-trusted-registry": { "ref": "master", "repos": [ "git@github.com:docker/dhe-deploy.git" ], "sha": "70ac255c88cde0ea6ecf3fcb812783dea7e09da6" }, "docker/docs-base": { "ref": "master", "repos": [ "git@github.com:docker/docs-base.git" ], "sha": "5a4cfac3c4d156eda45080c7dcdd2a4c41e08067" }, "docker/kitematic": { "ref": "docs", "repos": [ "git@github.com:docker/kitematic.git" ], "sha": "856a989d834f7fcbcb9bba687539fb159228f6b8" }, "docker/machine": { "ref": "docs", "repos": [ "git@github.com:docker/machine.git" ], "sha": "21edf30337dc5996b5d785ce54d68b4020242f57" }, "docker/notary": { "ref": "docs", "repos": [ "git@github.com:docker/notary.git" ], "sha": "dfeb51f54f2b0cdf20cb55427b7cc8ea2d1cdd0a" }, "docker/opensource": { "ref": "master", "repos": [ "git@github.com:docker/opensource.git" ], "sha": "b994cdd1f74b0aeb0b51fda1249a0c4c8efbf0d0" }, "docker/registry": { "ref": "master", "repos": [ "git@github.com:docker/distribution.git" ], "sha": "33c4a6522e9247913fa0a9a2d78ef9a7aa98465f" }, "docker/swarm": { "ref": "docs", "repos": [ "git@github.com:docker/swarm.git" ], "sha": "b43a2c21c4017726cd9cb17ef9b16f2eef6d1159" }, "docker/toolbox": { "ref": "master", "repos": [ "git@github.com:docker/toolbox.git" ], "sha": "de267d701f94035549ea03e68047d85534286f85" }, "docker/tutorials": { "ref": "master", "repos": [ "git@github.com:docker/tutorials.git" ], "sha": "7af2622fe68a30684d971e4bf3ca7988902e5e26" }, "docker/ucp": { "ref": "master", "repos": [ "git@github.com:docker/orca.git" ], "sha": "8cd10936a1e063b9be0d5c04de7311a1b2cb25cf" }, "docs.docker.com": { "ref": "refs/heads/v1.10-030316", "repos": [ "git@github.com:moxiegirl/docs.docker.com.git", "git@github.com:docker/docs.docker.com.git" ], "sha": "b43886e4078ce481b06b4cee5c922f5bcc5c629f" } }