diff --git a/reference/ucp/3.2/cli/backup.md b/reference/ucp/3.2/cli/backup.md index 97250d35a8..25fd460b58 100644 --- a/reference/ucp/3.2/cli/backup.md +++ b/reference/ucp/3.2/cli/backup.md @@ -4,7 +4,7 @@ description: Create a backup of a UCP manager node keywords: ucp, cli, backup --- -Create a backup of a UCP manager node +Create a backup of a UCP manager node. ## Usage @@ -28,19 +28,27 @@ from the backup of any previous manager. 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. - + `--passphrase` flag to encrypt the backup with PGP-compatible encryption + or `--no-passphrase` to opt out (not recommended). + * If using the `--file` option, the path to the file must be bind mounted onto the container that is performing the backup, and the filepath must be relative to the container's file tree. For example: + ``` + docker run --mount type=bind,src=/home/user/backup:/backup docker/ucp --file /backup/backup.tar + ``` + +> **Note**: A bind mount with a `/backup/` target path must be added to the container performing the backup. In this case, the backup file is placed in the source directory of the bind mount. For example: +> ``` +> docker run -v /nfs/ucp-backups:/backup docker/ucp-backup --file backup1.tar +> ``` +> This command places the backup under the `/nfs/ucp-backups/backup1.tar` path on the host. ## Options | Option | Description | |:--------------------------|:---------------------------| |`--debug, D`|Enable debug mode| -|`--jsonlog`|Produce json formatted output for easier parsing| +|`--file`|Name of the file for backup contents. This is ignored when `--interactive` is specified. If not provided, backup contents are sent to stdout.| +|`--include-logs`|Only applicable is `--file` is specified. If `true`, includes logs from the backup execution in a file adjacent to the backup file, specified with the same name but with a `.log` extension. **Note**: Log files are not encrypted.| |`--interactive, i`|Run in interactive mode and prompt for configuration values| -|`--id`|The ID of the UCP instance to back up| +|`--jsonlog`|Produce json formatted output for easier parsing| |`--passphrase`|Encrypt the tar file with a passphrase| diff --git a/reference/ucp/3.2/cli/dump-certs.md b/reference/ucp/3.2/cli/dump-certs.md index 928bbbba1c..d4a7cc8903 100644 --- a/reference/ucp/3.2/cli/dump-certs.md +++ b/reference/ucp/3.2/cli/dump-certs.md @@ -4,7 +4,7 @@ description: Print the public certificates used by this UCP web server keywords: ucp, cli, dump-certs --- -Print the public certificates used by this UCP web server +Print the public certificates used by this UCP web server. ## Usage @@ -19,7 +19,7 @@ docker container run --rm \ ## Description 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. +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. @@ -29,7 +29,7 @@ to configure DTR. | 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| +|`--debug, D`|Enable debug mode| +|`--jsonlog`|Produce json formatted output for easier parsing| diff --git a/reference/ucp/3.2/cli/example-config.md b/reference/ucp/3.2/cli/example-config.md index 4756d724ad..161a4a02f4 100644 --- a/reference/ucp/3.2/cli/example-config.md +++ b/reference/ucp/3.2/cli/example-config.md @@ -4,7 +4,7 @@ description: Display an example configuration file for UCP keywords: ucp, cli, config, configuration --- -Display an example configuration file for UCP +Display an example configuration file for UCP. ## Usage diff --git a/reference/ucp/3.2/cli/id.md b/reference/ucp/3.2/cli/id.md index 0721e0e1c6..58db683232 100644 --- a/reference/ucp/3.2/cli/id.md +++ b/reference/ucp/3.2/cli/id.md @@ -4,7 +4,7 @@ description: Print the ID of UCP running on this node keywords: ucp, cli, id --- -Print the ID of UCP running on this node +Print the ID of UCP running on this node. ## Usage ``` diff --git a/reference/ucp/3.2/cli/images.md b/reference/ucp/3.2/cli/images.md index 2980128ae0..2d79dbef7e 100644 --- a/reference/ucp/3.2/cli/images.md +++ b/reference/ucp/3.2/cli/images.md @@ -4,7 +4,7 @@ description: Verify the UCP images on this node keywords: ucp, cli, images --- -Verify the UCP images on this node +Verify the UCP images on this node. ## Usage @@ -28,7 +28,7 @@ the ones that are missing. |:--------------------------|:---------------------------| |`--debug, D`|Enable debug mode| |`--jsonlog`|Produce json formatted output for easier parsing| +|`--list`|List all images used by UCP but don't pull them| |`--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| diff --git a/reference/ucp/3.2/cli/index.md b/reference/ucp/3.2/cli/index.md index 12e71bdcc2..01d31986ea 100644 --- a/reference/ucp/3.2/cli/index.md +++ b/reference/ucp/3.2/cli/index.md @@ -31,15 +31,15 @@ docker container run -it --rm \ | Option | Description | |:-----------------|:----------------------------------------------------------| +| `backup` | Create a backup of a UCP manager node | +| `dump-certs` | Print the public certificates used by this UCP web server | +| `example-config` | Display an example configuration file for UCP | +| `id` | Print the ID of UCP running on this node | +| `images` | Verify the UCP images on this node | | `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 cluster | -| `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 | -| `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 cluster from a backup | -| `example-config` | Display an example configuration file for UCP | +| `stop` | Stop UCP components running on this node | +| `support` | Create a support dump for this UCP node | +| `uninstall-ucp` | Uninstall UCP from this swarm | +| `upgrade` | Upgrade the UCP cluster | diff --git a/reference/ucp/3.2/cli/install.md b/reference/ucp/3.2/cli/install.md index 96979016cc..69ed6757d2 100644 --- a/reference/ucp/3.2/cli/install.md +++ b/reference/ucp/3.2/cli/install.md @@ -4,7 +4,7 @@ description: Install UCP on a node keywords: ucp, cli, install --- -Install UCP on a node +Install UCP on a node. ## Usage @@ -18,7 +18,7 @@ docker container run --rm -it \ ## Description -This command initializes a new swarm, turns anode into a manager, and installs +This command initializes a new swarm, turns a node into a manager, and installs Docker Universal Control Plane (UCP). When installing UCP you can customize: @@ -63,8 +63,11 @@ If you are installing on Azure, see [Install UCP on Azure](/ee/ucp/admin/install | `--external-service-lb` | Set the external service load balancer reported in the UI | | `--force-insecure-tcp` | Force install to continue even with unauthenticated Docker Engine ports | | `--force-minimums` | Force the install/upgrade even if the system doesn't meet the minimum requirements. | +| `--fresh-install` | Destroy any existing state and start fresh. | | `--host-address` | The network address to advertise to other nodes. Format: IP address or network interface name | | `--interactive, i` | Run in interactive mode and prompt for configuration values | +| `--iscsiadm-path` | Path to the host iscsiadm binary. This option is only applicable if `--storage-iscsi` is specified. | +| `--iscsidb-path` | Path to the host iscsi database. This option is only applicable if `--storage-iscsi` is specified. | | `--jsonlog` | Produce json formatted output for easier parsing | | `--kube-apiserver-port` | Port for the Kubernetes API server (default: 6443) | | `--kv-snapshot-count` | Number of changes between key-value store snapshots | @@ -79,6 +82,8 @@ If you are installing on Azure, see [Install UCP on Azure](/ee/ucp/admin/install | `--registry-password` | Password to use when pulling images | | `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) | | `--skip-cloud-provider` | Disables checks that rely on detecting the cloud provider (if any) on which the cluster is currently running. | +| `--storage-expt-enabled` | Enable experimental features in Kubernetes storage. | +| `--storage-iscsi` | Enable iSCSI-based Persistent Volumes in Kubernetes. | | `--swarm-experimental` | Enable Docker Swarm experimental features. Used for backwards compatibility | | `--swarm-port` | Port for the Docker Swarm manager. Used for backwards compatibility | | `--swarm-grpc-port` | Port for communication between nodes | diff --git a/reference/ucp/3.2/cli/restart.md b/reference/ucp/3.2/cli/restart.md index f1824f28ed..2e9b420800 100644 --- a/reference/ucp/3.2/cli/restart.md +++ b/reference/ucp/3.2/cli/restart.md @@ -4,7 +4,7 @@ description: Start or restart UCP components running on this node keywords: ucp, cli, restart --- -Start or restart UCP components running on this node +Start or restart UCP components running on this node. ## Usage diff --git a/reference/ucp/3.2/cli/restore.md b/reference/ucp/3.2/cli/restore.md index 6552c6b4f9..abbd3b1dd3 100644 --- a/reference/ucp/3.2/cli/restore.md +++ b/reference/ucp/3.2/cli/restore.md @@ -4,7 +4,7 @@ description: Restore a UCP cluster from a backup keywords: ucp, cli, restore --- -Restore a UCP cluster from a backup +Restore a UCP cluster from a backup. ## Usage @@ -39,8 +39,8 @@ to download new client bundles after the operation is completed. Any existing Client Bundles for non-admin users will still be fully operational. -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 +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. Notes: @@ -60,11 +60,11 @@ Notes: | Option | Description | |:-------------------|:----------------------------------------------------------------------------------------------| +| `--data-path-addr` | Address or interface to use for data path traffic | | `--debug, D` | Enable debug mode | -| `--jsonlog` | Produce json formatted output for easier parsing | +| `--host-address` | The network address to advertise to other nodes. Format: IP address or network interface name | | `--interactive, i` | Run in interactive mode and prompt for configuration values | +| `--jsonlog` | Produce json formatted output for easier parsing | | `--passphrase` | Decrypt the backup tar file with the provided passphrase | | `--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 | -| `--data-path-addr` | Address or interface to use for data path traffic | | `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. | diff --git a/reference/ucp/3.2/cli/stop.md b/reference/ucp/3.2/cli/stop.md index a246cb9fdf..9cc429c095 100644 --- a/reference/ucp/3.2/cli/stop.md +++ b/reference/ucp/3.2/cli/stop.md @@ -4,7 +4,7 @@ description: Stop UCP components running on this node keywords: ucp, cli, stop --- -Stop UCP components running on this node +Stop UCP components running on this node. ## Usage diff --git a/reference/ucp/3.2/cli/support.md b/reference/ucp/3.2/cli/support.md index 7649e26824..37afa8ea47 100644 --- a/reference/ucp/3.2/cli/support.md +++ b/reference/ucp/3.2/cli/support.md @@ -4,7 +4,7 @@ description: Create a support dump for UCP nodes keywords: ucp, cli, support, support dump, troubleshooting --- -Create a support dump for specified UCP nodes +Create a support dump for specified UCP nodes. ## Usage @@ -18,12 +18,14 @@ docker container run --rm \ ## Description -This command creates a support dump file for the specified node(s), and prints it to stdout. +This command creates a support dump file for the specified node(s), and prints it to stdout. This includes +the ID of the UCP components running on the node. The ID matches what you see when running +the `docker info` command while using a client bundle, and is used by other commands as confirmation. ## Options | Option | Description | |:--------------------------|:---------------------------| |`--loglines`|Specify number of lines to grab from `journalctl`. The default is 10,000 lines.| -|`--servicedriller`|Run the swarm service driller (ssd) tool. For more information on this tool, see [Docker Swarm Service Driller (ssd)](https://github.com/docker/libnetwork/tree/master/cmd/ssd) Not run by default.| |`--nodes`|Select specific nodes on which to produce a support dump. Comma-separated node IDs are allowed. The default selects all nodes.| +|`--servicedriller`|Run the swarm service driller (ssd) tool. For more information on this tool, see [Docker Swarm Service Driller (ssd)](https://github.com/docker/libnetwork/tree/master/cmd/ssd) Not run by default.| diff --git a/reference/ucp/3.2/cli/uninstall-ucp.md b/reference/ucp/3.2/cli/uninstall-ucp.md index a1277e692c..b6344baaa6 100644 --- a/reference/ucp/3.2/cli/uninstall-ucp.md +++ b/reference/ucp/3.2/cli/uninstall-ucp.md @@ -4,7 +4,7 @@ description: Uninstall UCP from this swarm keywords: ucp, cli, uninstall-ucp --- -Uninstall UCP from this swarm +Uninstall UCP from this swarm. ## Usage @@ -33,10 +33,10 @@ UCP is installed again. | Option | Description | | :-------------------- | :---------------------------------------------------------- | | `--debug, D` | Enable debug mode | -| `--jsonlog` | Produce json formatted output for easier parsing | +| `--id` | The ID of the UCP instance to uninstall | | `--interactive, i` | Run in interactive mode and prompt for configuration values | +| `--jsonlog` | Produce json formatted output for easier parsing | | `--pull` | Pull UCP images: `always`, when `missing`, or `never` | +| `--purge-config` | Remove UCP configs during uninstallation | | `--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 | -| `--purge-config` | Remove UCP configs during uninstallation | diff --git a/reference/ucp/3.2/cli/upgrade.md b/reference/ucp/3.2/cli/upgrade.md index de7d72ae24..24122013ad 100644 --- a/reference/ucp/3.2/cli/upgrade.md +++ b/reference/ucp/3.2/cli/upgrade.md @@ -4,7 +4,7 @@ description: Upgrade the UCP components on this node keywords: ucp, cli, upgrade --- -Upgrade the UCP cluster +Upgrade the UCP cluster. ## Usage @@ -18,7 +18,10 @@ Upgrade the UCP cluster ## Description -This command upgrades the UCP running on this cluster. +This command upgrades the UCP running on this cluster. To upgrade UCP: + +- (Optional) Upgrade the Docker Engine in all nodes. +- Run the upgrade command on one manager node. Before performing an upgrade, you should perform a backup by using the [backup](backup.md) command. @@ -31,17 +34,18 @@ healthy and that all nodes have been upgraded successfully. | 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 | +| `--cloud-provider` | The cloud provider for the cluster | +| `--debug, D` | Enable debug mode | +| `--force-minimums` | Force the install/upgrade even if the system does not meet the minimum requirements | +| `--host-address` | Override the previously configured host address with this IP or network interface | +| `--id` | The ID of the UCP instance to upgrade | +| `--jsonlog` | Produce json formatted output for easier parsing | +| `--interactive, i` | Run in interactive mode and prompt for configuration values | +| `--manual-worker-upgrade` | Specifies whether to manually upgrade worker nodes. Defaults to `false`. | +| `--nodeport-range` | Allowed port range for Kubernetes services of type `NodePort`. The default port range is `32768-35535`. | +| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IP. The default IP pool is `192.168.0.0/16`. | | `--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 | -| `--force-minimums` | Force the install/upgrade even if the system does not meet the minimum requirements | -| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IP. The default IP pool is `192.168.0.0/16`. | -| `--nodeport-range` | Allowed port range for Kubernetes services of type `NodePort`. The default port range is `32768-35535`. | -| `--cloud-provider` | The cloud provider for the cluster |