docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update reference docs for UCP 2.0

This commit is contained in:
Joao Fernandes 2016-11-08 16:16:56 -08:00
parent e06fed5f1e
commit c48c0f3661
19 changed files with 387 additions and 573 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
datacenter/ucp/2.0/reference/backup.md
View File

@ -1,53 +1,50 @@
+++
title = "backup"
description = "Stream a tar file to stdout containing all UCP data volumes."
keywords= ["docker, ucp, backup, restore"]
[menu.main]
identifier = "ucp_ref_backup"
parent = "ucp_ref"
+++
---
title: backup
description: Create a backup of a UCP manager node
keywords:
- docker, dtr, cli, backup
---
# docker/ucp id
Stream a tar file to stdout containing all UCP data volumes.
Create a backup of a UCP manager node
## Usage
```bash
docker run --rm -i \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
backup [command options] > backup.tar
docker run -i --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
backup [command options] > backup.tar
```
## Description
This utility will dump out a tar file containing all the contents of the
volumes used by UCP on this controller. This can be used to make periodic
backups suitable for use in the 'restore' command. Only UCP infrastructure
containers are backed up by this tool.
This command creates a tar file with the contents of the volumes used by
this UCP manager node, and prints it. You can then use the 'restore' command to
restore the data from an existing backup.
When backing up an HA cluster, take backups of all controllers, one at a
time, in quick succession, and keep track of the exact time and sequence
when you performed each backup. You will need this timestamp/sequence
information if you restore more than one controller together.
To create backups of a multi-node swarm, you should create backups for all manager
nodes, one at a time in a quick succession, and keep track of the exact time and
sequence when you performed each backup. You will need this sequence information
if you restore more than one manager node at a time.
>**WARNING**: During the backup, all UCP infrastructure containers will be
temporarily stopped on this controller to prevent data corruption. No user
containers will be stopped during the backup.
Note:
* During the backup, UCP is temporarily stopped. This does not affect your
applications.
* The backup contains private keys and other sensitive information. Use the
'--passphrase' flag to encrypt the backup with PGP-compatible encryption.
>**WARNING**: This backup will contain private keys and other sensitive information
and should be stored securely. You may use the `--passphrase` flag to enable
built-in PGP compatible encryption.
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
--interactive, -i Enable interactive mode. You will be prompted to enter all required information
--id value The ID of the UCP instance to backup
--root-ca-only Backup only the root CA certificates and keys from this controller node
--passphrase value Encrypt the tar file with the provided passphrase [$UCP_PASSPHRASE]
```
| Option | Description |
|:--------------------------|:---------------------------|
|`--debug, D`|Enable debug mode|
|`--jsonlog`|Produce json formatted output for easier parsing|
|`--interactive, i`|Run in interactive mode and prompt for configuration values|
|`--id`|The ID of the UCP instance to backup|
|`--passphrase`|Encrypt the tar file with a passphrase|

50
datacenter/ucp/2.0/reference/dump-certs.md
View File

@ -1,40 +1,38 @@
+++
title = "dump-certs"
keywords= ["dump-certs, ucp"]
description = "Dump out public certificates"
[menu.main]
parent ="ucp_ref"
identifier="ucp_ref_dump_certs"
+++
---
title: dump-certs
description: Print the public certificates used by this UCP web server
keywords:
- docker, dtr, cli, dump-certs
---
# docker/ucp dump-certs
Dump out the public certs for this UCP controller.
Print the public certificates used by this UCP web server
## Usage
```bash
docker run --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
dump-certs [command options]
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
uninstall-ucp [command options]
```
## Description
This utility will dump out the public certificates for the UCP controller
running on the local engine. This can then be used to populate local
certificate trust stores as desired.
This command outputs the public certificates for the UCP web server running on
this node. By default it prints the contents of the ca.pem and cert.pem files.
When integrating UCP and DTR, use this command with the '--cluster --ca' flags
to configure DTR.
When connecting UCP to DTR, use the output of `--cluster --ca` to
configure DTR.
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
--ca Dump only the contents of the ca.pem file (default is to dump both ca and cert)
--cluster Dump the internal UCP Cluster Root CA and cert instead of the public server cert
```
| Option | Description |
|:--------------------------|:---------------------------|
|`--debug, D`|Enable debug mode|
|`--jsonlog`|Produce json formatted output for easier parsing|
|`--ca`|Only print the contents of the ca.pem file|
|`--cluster`|Print the internal UCP swarm root CA and cert instead of the public server cert|

34
datacenter/ucp/2.0/reference/engine-discovery.md
View File

@ -1,34 +0,0 @@
+++
title = "engine-discovery"
description = "Manage the engine discovery configuration on a node."
keywords= ["docker, ucp, discovery"]
[menu.main]
parent = "ucp_ref"
identifier="ucp_ref_engine_discovery"
+++
# docker/ucp engine-discovery
The engine-discovery command is no longer used.
## Usage
```
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
engine-discovery [options]
```
## Description
The engine-discovery command is no longer used. Overlay networking is enabled
automatically via swarm-mode.
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
```

39
datacenter/ucp/2.0/reference/fingerprint.md
View File

@ -1,31 +1,26 @@
+++
title = "fingerprint"
description = "Dump out TLS certificates."
keywords= ["fingerprint, ucp"]
[menu.main]
keywords= ["tool, reference, ucp"]
---
title: fingerprint
description: Print the TLS fingerprint for this UCP web server
keywords:
- docker, dtr, cli, fingerprint
---
parent = "ucp_ref"
identifier="ucp_ref_fingerprint"
+++
# docker/ucp fingerprint
Dump out the TLS fingerprint for the UCP controller running on this
engine.
Print the TLS fingerprint for this UCP web server
## Usage
```
```bash
docker run --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
fingerprint
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
fingerprint [command options]
```
## Description
This utility will display the certificate fingerprint of the UCP controller
running on the local engine. This can be used when scripting 'join'
operations for the `--fingerprint` flag.
This command displays the fingerprint of the certificate used in the UCP web
server running on this node.

40
datacenter/ucp/2.0/reference/help.md
View File

@ -1,40 +0,0 @@
+++
title = "help"
description = "Show a list of available commands for Docker Universal Control Plane."
keywords= ["help, ucp"]
[menu.main]
parent = "ucp_ref"
identifier="ucp_ref_help"
+++
# docker/ucp help
Docker Universal Control Plane Tool
This tool has commands to 'install' and 'uninstall' UCP.
This tool must run as a container with a well-known name and with the
`docker.sock` volume mounted, which you can cut-and-paste from the usage
example below.
This tool will generate TLS certificates. The tool may not be able to
discover your externally visible fully qualified hostname. For proper
certificate verification, you should pass one or more Subject Alternative
Names with '--san' during 'install'. These names should match the fully qualified
hostname you intend to use to access the given system.
Many settings can be passed as flags or environment variables. When passing as
an environment variable, use the 'docker run -e VARIABLE_NAME ...' syntax to
pass the value from your shell, or 'docker run -e VARIABLE_NAME=value ...' to
specify the value explicitly on the command line.
Additional help is available for each command with the '--help' option.
## Usage
```bash
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
command [arguments...]
```

42
datacenter/ucp/2.0/reference/id.md
View File

@ -1,29 +1,29 @@
+++
title = "id"
description = "Dump out the ID of the UCP components running on this engine."
keywords= ["docker, ucp, id"]
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_id"
+++
---
title: id
description: Print the ID of UCP running on this node
keywords:
- docker, dtr, cli, id
---
# docker/ucp id
Dump out the ID of the UCP components running on this engine.
Print the ID of UCP running on this node
## Usage
```
docker run --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
id
```bash
docker run -it --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
id [command options]
```
## Description
This utility will display the ID of the local UCP components running
on this node. This ID matches what you see when you run `docker info`
pointed to the UCP controller(s) and is required by various commands
in this tool as confirmation.
This command prints the ID of the UCP components running on this node. This ID
matches what you see when running the 'docker info' command while using
a client bundle.
This ID is used by other commands as confirmation.

54
datacenter/ucp/2.0/reference/images.md
View File

@ -1,39 +1,37 @@
+++
title = "images"
description = "Verify the UCP images on this Docker Engine."
keywords= ["images, ucp, images"]
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_images"
+++
---
title: images
description: Verify the UCP images on this node
keywords:
- docker, dtr, cli, images
---
# docker/ucp images
Verify the UCP images on this engine.
Verify the UCP images on this node
## Usage
```
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
images [command options]
```bash
docker run -it --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
images [command options]
```
## Description
This command will verify all the required images used by UCP on the current engine.
By default, this will pull any missing images. Use the `--pull` argument to change
behavior.
This command checks the UCP images that are available in this node, and pulls
the ones that are missing.
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
--pull value Specify image pull behavior ('always', when 'missing', or 'never') (default: "missing")
--registry-username value Specify the username to pull required images with [$REGISTRY_USERNAME]
--registry-password value Specify the password to pull required images with [$REGISTRY_PASSWORD]
--list Don't do anything, just list the images used by UCP
```
| Option | Description |
|:--------------------------|:---------------------------|
|`--debug, D`|Enable debug mode|
|`--jsonlog`|Produce json formatted output for easier parsing|
|`--pull`|Pull UCP images: 'always', when 'missing', or 'never'|
|`--registry-username`|Username to use when pulling images|
|`--registry-password`|Password to use when pulling images|
|`--list`|List all images used by UCP but don't pull them|

85
datacenter/ucp/2.0/reference/index.md
View File

@ -1,66 +1,45 @@
<!--[metadata]>
+++
title = "UCP tool reference"
description = "Installs Docker Universal Control Plane."
keywords= ["docker, ucp, install"]
[menu.main]
parent = "mn_ucp_installation"
identifier = "ucp_ref"
weight=100
+++
<![end-metadata]-->
---
title: docker/ucp overview
description: Learn about the commands available in the docker/ucp image.
keywords:
- docker, ucp, cli, ucp
---
# UCP tool reference
Installs Docker Universal Control Plane.
## Usage
```bash
$ docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
command [arguments...]
```
## Description
This image has commands to install and manage Docker Universal Control Plane
(UCP) on a Docker Engine.
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 run -e VARIABLE_NAME` syntax to pass the
value from your shell, or `docker run -e VARIABLE_NAME=value` to specify the
environment variables use the 'docker run -e VARIABLE_NAME' syntax to pass the
value from your shell, or 'docker 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 '--help' flag.
## Usage
## commands
```nohighlight
install Install UCP on this engine
restart Start or restart UCP components on this engine
stop Stop UCP components running on this engine
upgrade Upgrade the UCP components on this engine
images Verify the UCP images on this engine
uninstall-cluster Uninstall UCP from this swarm cluster
dump-certs Dump out the public certs for this UCP controller
fingerprint Dump out the TLS fingerprint for the UCP controller running on this engine
support Generate a support dump for this engine
id Dump out the ID of the UCP components running on this engine
backup Stream a tar file to stdout containing all UCP data volumes
restore Restore a UCP cluster from a backup tar file.
regen-certs
help Shows a list of commands or help for one command
```bash
docker run -it --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
command [command arguments]
```
## Global options
## Commands
```nohighlight
--help, -h show help
--version, -v print the version
```
| Option | Description |
|:-----------------------------|:---------------------------|
|`install`| Install UCP on this node|
|`restart`| Start or restart UCP components running on this node|
|`stop`| Stop UCP components running on this node|
|`upgrade`| Upgrade the UCP components on this node|
|`images`| Verify the UCP images on this node|
|`uninstall-ucp`| Uninstall UCP from this swarm|
|`dump-certs`| Print the public certificates used by this UCP web server|
|`fingerprint`| Print the TLS fingerprint for this UCP web server|
|`support`| Create a support dump for this UCP node|
|`id`| Print the ID of UCP running on this node|
|`backup`| Create a backup of a UCP manager node|
|`restore`| Restore a UCP manager node from a backup|

130
datacenter/ucp/2.0/reference/install.md
View File

@ -1,73 +1,85 @@
+++
title = "install"
description = "Install Docker Universal Control Plane."
keywords= ["install, ucp"]
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_install"
+++
---
title: install
description: Install UCP on this node
keywords:
- docker, dtr, cli, install
---
# docker/ucp install
Install UCP on this engine.
Install UCP on this node
## Usage
```
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
install [command options]
```bash
docker run -it --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
install [command options]
```
## Description
The `install` command will install the UCP controller on the
local engine. If you intend to install a multi-node cluster,
you must open firewall ports between the engines for the
following ports:
This command initializes a new swarm, turns this node into a manager, and installs
Docker Universal Control Plane (UCP).
- 443 or the `--controller-port`
- 2376 or the `--swarm-port`
- 12376, 4789, 12379, 12380, 12381, 12382, 12383, 12384, 12385, 12386
- 4789(udp) and 7946(tcp/udp) for overlay networking
When installing UCP you can customize:
You can optionally use an externally generated and signed certificate
for the UCP controller by specifying `--external-server-cert`. Create a storage
volume named `ucp-controller-server-certs` with ca.pem, cert.pem, and key.pem
in the root directory before running the install.
* The certificates used by the UCP web server. Create a volume
named 'ucp-controller-server-certs' and copy the ca.pem, cert.pem, and key.pem
files to the root directory. Then run the install command with the
'--external-server-cert' flag.
* The license used by UCP, by bind-mounting the file at
'/config/docker_subscription.lic' in the tool.
E.g. -v /path/to/my/config/docker_subscription.lic:/config/docker_subscription.lic
* The initial users, permissions and settings of the system, using a backup of
an existing UCP cluster. Bind-mount the backup file under
'/config/backup.tar' in the tool and use the '--from-backup' flag. When
using the '--from-backup' flag, all other configuration flags are
respected, except for the '--admin-username' and '--admin-password' flags.
If you're joining more nodes to this swarm, open the following ports in your
firewall:
* 443 or the '--controller-port'
* 2376 or the '--swarm-port'
* 12376, 4789, 12379, 12380, 12381, 12382, 12383, 12384, 12385, 12386
* 4789(udp) and 7946(tcp/udp) for overlay networking
A license file can optionally be injected during install by volume
mounting the file at '/docker_subscription.lic' in the tool. E.g.,
`-v /path/to/my/docker_subscription.lic:/docker_subscription.lic`
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
--interactive, -i Enable interactive mode. You will be prompted to enter all required information
--admin-username value Specify the UCP admin username [$UCP_ADMIN_USER]
--admin-password value Specify the UCP admin password [$UCP_ADMIN_PASSWORD]
--san value Additional Subject Alternative Names for certs (e.g. --san foo1.bar.com --san foo2.bar.com)
--host-address value Specify the primary IP address or network interface name for this node to advertise to other members in the cluster (required if multiple interfaces present) [$UCP_HOST_ADDRESS]
--swarm-port value Select what port to run the local Swarm manager on (default: 2376)
--controller-port value Select what port to run the local UCP Controller on (default: 443)
--swarm-grpc-port value Select what port to run Swarm GRPC on (default: 2377)
--dns value Set custom DNS servers for the UCP infrastructure containers [$DNS]
--dns-opt value Set DNS options for the UCP infrastructure containers [$DNS_OPT]
--dns-search value Set custom DNS search domains for the UCP infrastructure containers [$DNS_SEARCH]
--pull value Specify image pull behavior ('always', when 'missing', or 'never') (default: "missing")
--registry-username value Specify the username to pull required images with [$REGISTRY_USERNAME]
--registry-password value Specify the password to pull required images with [$REGISTRY_PASSWORD]
--kv-timeout value Timeout in milliseconds for the KV store (set higher for a multi-datacenter cluster, all controllers must use the same value) (default: 5000) [$KV_TIMEOUT]
--kv-snapshot-count value Number of changes between KV store snapshots (all controllers must use the same value) (default: 20000) [$KV_SNAPSHOT_COUNT]
--swarm-experimental Enable experimental swarm features
--disable-tracking Disable anonymous tracking and analytics
--disable-usage Disable anonymous usage reporting
--external-server-cert Set up UCP Controller with an externally signed server certificate
--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)
```
| Option | Description |
|:--------------------------|:---------------------------|
|`--debug, D`|Enable debug mode|
|`--jsonlog`|Produce json formatted output for easier parsing|
|`--interactive, i`|Run in interactive mode and prompt for configuration values|
|`--admin-username`|The UCP administrator username|
|`--admin-password`|The UCP administrator password|
|`--san`|Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com)|
|`--host-address`|The network address to advertise to other nodes. Format: IP address or network interface name|
|`--swarm-port`|Port for the Docker Swarm manager. Used for backwards compatibility|
|`--controller-port`|Port for the web UI and API|
|`--swarm-grpc-port`|Port for communication between nodes|
|`--dns`|Set custom DNS servers for the UCP containers|
|`--dns-opt`|Set DNS options for the UCP containers|
|`--dns-search`|Set custom DNS search domains for the UCP containers|
|`--pull`|Pull UCP images: 'always', when 'missing', or 'never'|
|`--registry-username`|Username to use when pulling images|
|`--registry-password`|Password to use when pulling images|
|`--kv-timeout`|Timeout in milliseconds for the key-value store|
|`--kv-snapshot-count`|Number of changes between key-value store snapshots|
|`--from-backup`|Initialize a system from a backup of a UCP cluster|
|`--passphrase`|The passphrase needed to decrypt the backup file. To be used together with --from-backup if the backup is encrypted.|
|`--swarm-experimental`|Enable Docker Swarm experimental features. Used for backwards compatibility|
|`--disable-tracking`|Disable anonymous tracking and analytics|
|`--disable-usage`|Disable anonymous usage reporting|
|`--external-server-cert`|Customize the certificates used by the UCP web server|
|`--preserve-certs`|Don't generate certificates if they already exist|
|`--binpack`|Set the Docker Swarm scheduler to binpack mode. Used for backwards compatibility|
|`--random`|Set the Docker Swarm scheduler to random mode. Used for backwards compatibility|
|`--external-service-lb`|Set the external service load balancer reported in the UI|
|`--enable-profiling`|Enable performance profiling|

26
datacenter/ucp/2.0/reference/join.md
View File

@ -1,26 +0,0 @@
+++
title = "join"
keywords= ["join, ucp"]
description = "Joins a node to an existing Docker Universal Control Plane cluster."
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_join"
+++
# docker/ucp 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
The join command is no longer used. To join a node to UCP, simply run `docker swarm join ...`

28
datacenter/ucp/2.0/reference/regen-certs.md
View File

@ -1,28 +0,0 @@
+++
title = "regen-certs.md"
description = "Regenerate certificates for Docker Universal Control Plane."
keywords= ["install, ucp"]
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_regen_certs"
+++
# docker/ucp regen-certs
The `regen-certs` command is no longer used.
## Usage
```bash
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
regen-certs [command options]
```
## Description
The `regen-certs` command is no longer used. Certificates are automatically renewed
before they expire and when SANs for a node are updated. To update SANs for a node,
edit the node in the Node Management Web UI.

38
datacenter/ucp/2.0/reference/restart.md
View File

@ -1,29 +1,27 @@
+++
title = "restart"
description = "Restart Docker Universal Control Plane containers."
keywords= ["install, ucp, restart"]
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_restart"
+++
---
title: restart
description: Start or restart UCP components running on this node
keywords:
- docker, dtr, cli, restart
---
# docker/ucp restart
Start or restart UCP components on this engine.
Start or restart UCP components running on this node
## Usage
```bash
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
restart [command options]
docker run -it --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
restart [command options]
```
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
```
| Option | Description |
|:--------------------------|:---------------------------|
|`--debug, D`|Enable debug mode|
|`--jsonlog`|Produce json formatted output for easier parsing|

77
datacenter/ucp/2.0/reference/restore.md
View File

@ -1,57 +1,52 @@
+++
title = "restore"
description = "Stream a tar file on stdin containing all local UCP data volumes."
keywords= ["docker, ucp, backup, restore"]
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_restore"
+++
---
title: restore
description: Restore a UCP manager node from a backup
keywords:
- docker, dtr, cli, restore
---
# docker/ucp id
Restore a UCP cluster from a backup tar file.
Restore a UCP manager node from a backup
## Usage
```bash
docker run --rm -i \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
restore [command options] < backup.tar
docker run -i --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
restore [command options] < restore.tar
```
## Description
This utility will restore the state of this controller based on a tar file
generated by the 'backup' command. Any UCP containers that are running on this
host will be stopped prior to restoring the data. After the data is replaced,
the containers will be restarted.
This command restores the state of this UCP manager node using a tar file
generated by the 'backup' command.
The full restore operation can be only performed on the same node where a backup
was taken. Other controllers of the cluster need to be stopped before attempting
a restore operation.
The restore command stops the UCP components running on this node and restores
the data from a backup, overwriting all existing data.
The restore operation can be also used to replicate Root CA material across
controllers in the same cluster, by using the `--root-ca-only` flag. In this case,
no controllers need to be stopped and the same backup file can be used to
replicate Root CA material across multiple controllers of the same cluster.
By default the backup tar file is read from stdin. You can also bind-mount the
backup file under /config/backup.tar, and run the restore command with the
'--interactive' flag.
>**WARNING**: Existing state on this node will be lost and replaced by the
contents of the backup.
Note:
* Before restoring a manager node, you need to stop all other managers.
* During the restore, UCP is temporarily stopped on this node. This does not
affect your applications.
* You need to restore using a backup you created for that specific node.
When the restore operation is run using `--interactive` mode, the backup file
needs to be mounted under `/backup.tar` within this container. If the
`--interactive` flag is not set, the backup file will be read from stdin.
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
--interactive, -i Enable interactive mode. You will be prompted to enter all required information
--id value The ID of the UCP instance to backup
--root-ca-only Restore only the Root CA certificates and keys on this controller node (leaving all other data intact)
--passphrase value Decrypt the tar file with the provided passphrase [$UCP_PASSPHRASE]
```
| Option | Description |
|:--------------------------|:---------------------------|
|`--debug, D`|Enable debug mode|
|`--jsonlog`|Produce json formatted output for easier parsing|
|`--interactive, i`|Run in interactive mode and prompt for configuration values|
|`--id`|The ID of the UCP instance to backup|
|`--passphrase`|Decrypt the tar file with the provided passphrase|

37
datacenter/ucp/2.0/reference/stop.md
View File

@ -1,29 +1,26 @@
+++
title = "stop"
description = "Stop Docker Universal Control Plane containers."
keywords= ["install, ucp, stop"]
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_stop"
+++
---
title: stop
description: Stop UCP components running on this node
keywords:
- docker, dtr, cli, stop
---
# docker/ucp stop
Stop UCP components running on this engine
Stop UCP components running on this node
## Usage
```bash
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
stop [command options]
docker run -it --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
stop [command options]
```
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
```
| Option | Description |
|:--------------------------|:---------------------------|
|`--debug, D`|Enable debug mode|
|`--jsonlog`|Produce json formatted output for easier parsing|

33
datacenter/ucp/2.0/reference/support.md
View File

@ -1,26 +1,25 @@
+++
title = "support"
description = "Generate a support dump for this engine."
keywords= ["docker, ucp, support, logs"]
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_support"
+++
---
title: support
description: Create a support dump for this UCP node
keywords:
- docker, dtr, cli, support
---
# docker/ucp support
Generate a support dump for this engine.
Create a support dump for this UCP node
## Usage
```
```bash
docker run --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
support > docker-support.tgz
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
support [command options] > docker-support.tgz
```
## Description
This utility will produce a support dump file on stdout for this local node.
This command creates a support dump file for this node, and prints it to stdout.

37
datacenter/ucp/2.0/reference/uninstall-cluster.md
View File

@ -1,37 +0,0 @@
+++
title = "uninstall-cluster"
keywords= ["uninstall, ucp"]
description = "Uninstall UCP from this swarm clusters"
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_uninstall-cluster"
+++
# docker/ucp uninstall-cluster
Uninstall UCP from this swarm cluster.
## Usage
```
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
uninstall-cluster [command options]
```
## Description
Uninstall UCP from this swarm cluster, while preserving the cluster.
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
--interactive, -i Enable interactive mode. You will be prompted to enter all required information
--pull value Specify image pull behavior ('always', when 'missing', or 'never') (default: "missing")
--registry-username value Specify the username to pull required images with [$REGISTRY_USERNAME]
--registry-password value Specify the password to pull required images with [$REGISTRY_PASSWORD]
--id value The ID of the UCP instance to uninstall
```

43
datacenter/ucp/2.0/reference/uninstall-ucp.md Normal file
View File

@ -0,0 +1,43 @@
---
title: uninstall-ucp
description: Uninstall UCP from this swarm
keywords:
- docker, dtr, cli, uninstall-ucp
---
Uninstall UCP from this swarm
## Usage
```bash
docker run -it --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
uninstall-ucp [command options]
```
## Description
This command uninstalls UCP from the swarm, but preserves the swarm so that
your applications can continue running.
After UCP is uninstalled you can use the the 'docker swarm leave' and
'docker node rm' commands to remove nodes from the swarm.
Once UCP is uninstalled, you won't be able to join nodes to the swarm unless
UCP is installed again.
## Options
| Option | Description |
|:--------------------------|:---------------------------|
|`--debug, D`|Enable debug mode|
|`--jsonlog`|Produce json formatted output for easier parsing|
|`--interactive, i`|Run in interactive mode and prompt for configuration values|
|`--pull`|Pull UCP images: 'always', when 'missing', or 'never'|
|`--registry-username`|Username to use when pulling images|
|`--registry-password`|Password to use when pulling images|
|`--id`|The ID of the UCP instance to uninstall|

28
datacenter/ucp/2.0/reference/uninstall.md
View File

@ -1,28 +0,0 @@
+++
title = "uninstall"
keywords= ["uninstall, ucp"]
description = "Uninstall a UCP controller and nodes"
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_uninstall"
+++
# docker/ucp uninstall
The uninstall command is no longer used.
## Usage
```
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
uninstall [command options]
```
## Description
The uninstall command is no longer used. To remove a node from the UCP cluster,
run the 'docker swarm leave' and 'docker node rm' commands. To remove the UCP
components but preserve the swarm cluster, use the 'uninstall-cluster' command.

66
datacenter/ucp/2.0/reference/upgrade.md
View File

@ -1,48 +1,44 @@
+++
title = "upgrade"
description = "Upgrade Docker Universal Control Plane."
keywords= ["docker, ucp, upgrade "]
[menu.main]
parent = "ucp_ref"
identifier = "ucp_ref_upgrade"
+++
---
title: upgrade
description: Upgrade the UCP components on this node
keywords:
- docker, dtr, cli, upgrade
---
# docker/ucp upgrade
Upgrade the UCP components on this engine.
Upgrade the UCP components on this node
## Usage
```
docker run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
upgrade [command options]
```bash
docker run -it --rm docker/ucp \
upgrade [command options]
```
## Description
When upgrading UCP, you must run the 'upgrade' command against every
engine in your cluster. You should upgrade your controller and replica
nodes first, followed by your compute nodes. If you plan to upgrade your
engine as well, upgrade the engine first, before upgrading UCP on the node.
This commands upgrades the UCP running on this node.
To upgrade UCP:
After upgrading each node, confirm the node is present in the UCP console
before proceeding to the next node.
* Upgrade the Docker Engine in all nodes (optional)
* Run the upgrade command in all manager nodes
* Run the upgrade command in all worker nodes
After upgrading UCP in a node, go to the UCP web UI and confirm the node is
healthy, before upgrading other nodes.
## Options
```nohighlight
--debug, -D Enable debug mode
--jsonlog Produce json formatted output for easier parsing
--interactive, -i Enable interactive mode. You will be prompted to enter all required information
--admin-username value Specify the UCP admin username [$UCP_ADMIN_USER]
--admin-password value Specify the UCP admin password [$UCP_ADMIN_PASSWORD]
--pull value Specify image pull behavior ('always', when 'missing', or 'never') (default: "missing")
--registry-username value Specify the username to pull required images with [$REGISTRY_USERNAME]
--registry-password value Specify the password to pull required images with [$REGISTRY_PASSWORD]
--id value The ID of the UCP instance to upgrade
--host-address value Override the previously configured host address with this IP or network interface [$UCP_HOST_ADDRESS]
```
| Option | Description |
|:--------------------------|:---------------------------|
|`--debug, D`|Enable debug mode|
|`--jsonlog`|Produce json formatted output for easier parsing|
|`--interactive, i`|Run in interactive mode and prompt for configuration values|
|`--admin-username`|The UCP administrator username|
|`--admin-password`|The UCP administrator password|
|`--pull`|Pull UCP images: 'always', when 'missing', or 'never'|
|`--registry-username`|Username to use when pulling images|
|`--registry-password`|Password to use when pulling images|
|`--id`|The ID of the UCP instance to upgrade|
|`--host-address`|Override the previously configured host address with this IP or network interface|