UCP System requirementsEstimated reading time: 7 minutes
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. Common requirements:
- Docker Engine - Enterprise version 19.03
- Linux kernel version 3.10 or higher. For debugging purposes, it is suggested to match the host OS kernel versions as close as possible.
- A static IP address for each node in the cluster
- User namespaces should not be configured on any node. This function is not currently supported by UCP. See Isolate containers with a user namespace for more information.
- 8GB of RAM for manager nodes
- 4GB of RAM for worker nodes
- 2 vCPUs for manager nodes
- 10GB of free disk space for the
/varpartition for manager nodes (A minimum of 6GB is recommended.)
500MB of free disk space for the
/varpartition for worker nodes
- Default install directories:
- /var/lib/docker (Docker Data Root Directory)
- /var/lib/kubelet (Kubelet Data Root Directory)
- /var/lib/containerd (Containerd Data Root Directory)
Increased storage is required for Kubernetes manager nodes in UCP 3.1. If you are upgrading to UCP 3.1, refer to Kubelet restarting after upgrade to Universal Control Plane 3.1 for information on how to increase the size of the
Recommended production requirements
- 16GB of RAM for manager nodes
- 4 vCPUs for manager nodes
- 25-100GB of free disk space
Note that Windows container images are typically larger than Linux container images. For this reason, you should provision more local storage for Windows nodes and for any DTR setups that store Windows container images.
Also, make sure the nodes are running an operating system supported by Docker Enterprise.
For highly-available installations, you also need a way to transfer files between hosts.
Workloads on manager nodes
Docker does not support workloads other than those required for UCP on UCP manager nodes.
When installing UCP on a host, a series of ports need to be opened to incoming traffic. Each of these ports will expect incoming traffic from a set of hosts, indicated as the “Scope” of that port. The three scopes are:
- External: Traffic arrives from outside the cluster through end-user interaction.
- Internal: Traffic arrives from other hosts in the same cluster.
- Self: Traffic arrives to that port only from processes on the same host.
When installing UCP on Microsoft Azure, an overlay network is not used for Kubernetes; therefore, any containerized service deployed onto Kubernetes and exposed as a Kubernetes Service may need its corresponding port to be opened on the underlying Azure Network Security Group. For more information see Installing on Azure.
Make sure the following ports are open for incoming traffic on the respective host types:
|managers, workers||TCP 179||Internal||Port for BGP peers, used for Kubernetes networking|
|managers||TCP 443 (configurable)||External, Internal||Port for the UCP web UI and API|
|managers||TCP 2376 (configurable)||Internal||Port for the Docker Swarm manager. Used for backwards compatibility|
|managers||TCP 2377 (configurable)||Internal||Port for control communication between swarm nodes|
|managers, workers||UDP 4789||Internal||Port for overlay networking|
|managers||TCP 6443 (configurable)||External, Internal||Port for Kubernetes API server endpoint|
|managers, workers||TCP 6444||Self||Port for Kubernetes API reverse proxy|
|managers, workers||TCP, UDP 7946||Internal||Port for gossip-based clustering|
|managers, workers||TCP 9099||Self||Port for calico health check|
|managers, workers||TCP 10250||Internal||Port for Kubelet|
|managers, workers||TCP 12376||Internal||Port for a TLS authentication proxy that provides access to the Docker Engine|
|managers, workers||TCP 12378||Self||Port for Etcd reverse proxy|
|managers||TCP 12379||Internal||Port for Etcd Control API|
|managers||TCP 12380||Internal||Port for Etcd Peer API|
|managers||TCP 12381||Internal||Port for the UCP cluster certificate authority|
|managers||TCP 12382||Internal||Port for the UCP client certificate authority|
|managers||TCP 12383||Internal||Port for the authentication storage backend|
|managers||TCP 12384||Internal||Port for the authentication storage backend for replication across managers|
|managers||TCP 12385||Internal||Port for the authentication service API|
|managers||TCP 12386||Internal||Port for the authentication worker|
|managers||TCP 12388||Internal||Internal Port for the Kubernetes API Server|
CLOUD_NETCONFIG_MANAGE for SLES 15
For SUSE Linux Enterprise Server 15 (SLES 15) installations, you must disable
prior to installing UCP.
1. In the network interface configuration file, `/etc/sysconfig/network/ifcfg-eth0`, set ``` CLOUD_NETCONFIG_MANAGE="no" ``` 2. Run `service network restart`.
Enable ESP traffic
For overlay networks with encryption to work, you need to ensure that IP protocol 50 (Encapsulating Security Payload) traffic is allowed.
Enable IP-in-IP traffic
The default networking plugin for UCP is Calico, which uses IP Protocol Number 4 for IP-in-IP encapsulation.
If you’re deploying to AWS or another cloud provider, enable IP-in-IP traffic for your cloud provider’s security group.
Make sure the networks you’re using allow the UCP components enough time to communicate before they time out.
|Raft consensus between manager nodes||3000||no|
|Gossip protocol for overlay networking||5000||no|
In distributed systems like Docker UCP, time synchronization is critical to ensure proper operation. As a best practice to ensure consistency between the engines in a UCP cluster, all engines should regularly synchronize time with a Network Time Protocol (NTP) server. If a server’s clock is skewed, unexpected behavior may cause poor performance or even failures.
Compatibility and maintenance lifecycle
Docker Enterprise is a software subscription that includes three products:
- Docker Engine - Enterprise with enterprise-grade support
- Docker Trusted Registry
- Docker Universal Control Plane
Learn more about compatibility and the maintenance lifecycle for these products: