UCP System requirements

Estimated reading time: 3 minutes

These are the docs for UCP version 2.1

To select a different version, use the selector below.

Docker Universal Control Plane can be installed on-premises or on the cloud. Before installing, be sure your infrastructure has these requirements.

Hardware and software requirements

You can install UCP on-premises or on a cloud provider. To install UCP, all nodes must have:

  • Linux kernel version 3.10 or higher
  • CS Docker Engine 1.13, or EE Daemon 17.03 and higher
  • 8.00 GB of RAM for manager nodes or nodes running DTR
  • 4.00 GB of RAM for worker nodes
  • 3.00 GB of available disk space
  • A static IP address

For highly-available installations, you also need a way to transfer files between hosts.

Workloads on manager nodes

These requirements assume that manager nodes won’t run regular workloads. If you plan to run additional workloads on manager nodes, you may need to provision more powerful nodes. If manager nodes become overloaded, the swarm may experience issues.

Network requirements

When installing UCP on a host, make sure the following ports are open:

HostsDirectionPortPurpose
managers, workersinTCP 443 (configurable)Port for the UCP web UI and API
managersinTCP 2376 (configurable)Port for the Docker Swarm manager. Used for backwards compatibility
managers, workersinTCP 2377 (configurable)Port for communication between swarm nodes
managers, workersin, outTCP, UDP 4789Port for overlay networking
managers, workersin, outTCP, UDP 7946Port for gossip-based clustering
managers, workersinTCP 12376Port for a TLS proxy that provides access to UCP, Docker Engine, and Docker Swarm
managersinTCP 12379Port for internal node configuration, cluster configuration, and HA
managersinTCP 12380Port for internal node configuration, cluster configuration, and HA
managersinTCP 12381Port for the certificate authority
managersinTCP 12382Port for the UCP certificate authority
managersinTCP 12383Port for the authentication storage backend
managersinTCP 12384Port for the authentication storage backend for replication across managers
managersinTCP 12385Port for the authentication service API
managersinTCP 12386Port for the authentication worker
managersinTCP 12387Port for the metrics service

Also, make sure the networks you’re using allow the UCP components enough time to communicate before they time out.

ComponentTimeout (ms)Configurable
Raft consensus between manager nodes3000no
Gossip protocol for overlay networking5000no
etcd500yes
rethinkDB10000no
Stand-alone swarm90000no

Compatibility and maintenance lifecycle

Docker Datacenter is a software subscription that includes 3 products:

  • CS Docker Engine,
  • Docker Trusted Registry,
  • Docker Universal Control Plane.

Learn more about the maintenance lifecycle for these products.

Version compatibility

UCP 2.1 requires minimum versions of the following Docker components:

  • Docker Engine 1.13.0
  • Docker Remote API 1.25
  • Compose 1.9

Where to go next

docker, ucp, architecture, requirements