docker/ucp overviewEstimated reading time: 2 minutes
This topic applies to Docker Enterprise.
The Docker Enterprise platform business, including products, customers, and employees, has been acquired by Mirantis, inc., effective 13-November-2019. For more information on the acquisition and how it may affect you and your business, refer to the Docker Enterprise Customer FAQ.
This image has commands to install and manage Docker Universal Control Plane (UCP) on a Docker Engine.
You can configure the commands using flags or environment variables. When using
environment variables, use the
docker container run -e VARIABLE_NAME syntax to pass the
value from your shell, or
docker container run -e VARIABLE_NAME=value to specify the
value explicitly on the command line.
The container running this image needs to be named
ucp and bind-mount the
Docker daemon socket. Below you can find an example of how to run this image.
Additional help is available for each command with the
docker container run -it --rm \ --name ucp \ -v /var/run/docker.sock:/var/run/docker.sock \ docker/ucp \ command [command arguments]
||Create a backup of a UCP manager node|
||Print the public certificates used by this UCP web server|
||Display an example configuration file for UCP|
||Shows a list of commands or help for one command|
||Print the ID of UCP running on this node|
||Verify the UCP images on this node|
||Install UCP on this node|
||Checks the ports on a node before a UCP installation|
||Start or restart UCP components running on this node|
||Restore a UCP cluster from a backup|
||Stop UCP components running on this node|
||Create a support dump for this UCP node|
||Uninstall UCP from this swarm|
||Upgrade the UCP cluster|