mirror of https://github.com/docker/docs.git
Update DTR 2.4 CLI docs
This commit is contained in:
Joao Fernandes
Joao Fernandes
parent
ceb24a9ee7
commit
bcd9004979
|
|
@ -9,7 +9,7 @@ Create a backup of DTR
|
|||
## Usage
|
||||
|
||||
```bash
|
||||
docker run --log-driver none -i --rm docker/dtr \
|
||||
docker run -i --rm docker/dtr \
|
||||
backup [command options] > backup.tar
|
||||
```
|
||||
|
||||
|
|
@ -20,13 +20,13 @@ This command creates a tar file with the contents of the volumes used by
|
|||
DTR, and prints it. You can then use the 'restore' command to restore the data
|
||||
from an existing backup.
|
||||
|
||||
**Note**:
|
||||
Note:
|
||||
|
||||
* This command only creates backups of configurations, and image metadata.
|
||||
It doesn't back up users and organizations. Users and organizations can be
|
||||
It doesn't backup users and organizations. Users and organizations can be
|
||||
backed up when performing a UCP backup.
|
||||
|
||||
It also doesn't back up the Docker images stored in your registry.
|
||||
It also doesn't backup the Docker images stored in your registry.
|
||||
You should implement a separate backup policy for the Docker images stored
|
||||
in your registry, taking in consideration whether your DTR installation is
|
||||
configured to store images on the filesystem or using a cloud provider.
|
||||
|
|
@ -42,10 +42,10 @@ from an existing backup.
|
|||
| `--debug` | $DEBUG | Enable debug mode for additional logs. |
|
||||
| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. |
|
||||
| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica. To safely remove a DTR replica from the cluster, the remove command needs to notify a healthy replica about the replica that's about to be removed. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. |
|
||||
| `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP. Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP. The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP.The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-password` | $UCP_PASSWORD | The UCP administrator password. |
|
||||
| `--ucp-url` | $UCP_URL | The UCP URL including domain and port. |
|
||||
| `--ucp-username` | $UCP_USERNAME | The UCP administrator username. |
|
||||
|
|
|
|||
|
|
@ -33,8 +33,8 @@ Use the 'remove' command to gracefully scale down your DTR cluster.
|
|||
| `--ucp-password` | $UCP_PASSWORD | The UCP administrator password. |
|
||||
| `--debug` | $DEBUG | Enable debug mode for additional logs. |
|
||||
| `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP. The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP. Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP.The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. |
|
||||
| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. |
|
||||
|
||||
|
|
|
|||
|
|
@ -1,37 +0,0 @@
|
|||
---
|
||||
title: docker/dtr dumpcerts
|
||||
description: Print the TLS certificates used by DTR
|
||||
keywords: dtr, cli, certificate, cert, tls
|
||||
---
|
||||
|
||||
Print the TLS certificates used by DTR
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
docker run -i --rm docker/dtr \
|
||||
dumpcerts [command options] > backup.tar
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
This command creates a backup of the certificates used by DTR for
|
||||
communicating across replicas with TLS.
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Environment Variable | Description |
|
||||
| :---------------------- | :------------------- | :---------------------------------------------- |
|
||||
| `--debug` | $DEBUG | Enable debug mode for additional logs. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica. |
|
||||
| `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP. |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP. |
|
||||
| `--ucp-password` | $UCP_PASSWORD | The UCP administrator password. |
|
||||
| `--ucp-url` | $UCP_URL | The UCP URL including domain and port. |
|
||||
| `--ucp-username` | $UCP_USERNAME | The UCP administrator username. |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -4,7 +4,7 @@ description: Learn about the commands available in the docker/dtr image.
|
|||
keywords: dtr, install, uninstall, configure
|
||||
---
|
||||
|
||||
This tool has commands to install, configure, and back up Docker
|
||||
This tool has commands to install, configure, and backup Docker
|
||||
Trusted Registry (DTR). It also allows uninstalling DTR.
|
||||
By default the tool runs in interactive mode. It prompts you for
|
||||
the values needed.
|
||||
|
|
@ -31,7 +31,7 @@ docker run -it --rm docker/dtr \
|
|||
|[destroy](destroy)| Destroy a DTR replica's data |
|
||||
|[restore](restore)| Install and restore DTR from an existing backup |
|
||||
|[backup](backup)| Create a backup of DTR |
|
||||
|[upgrade](upgrade)| Upgrade DTR 2.0.0 or later cluster to this version |
|
||||
|[upgrade](upgrade)| Upgrade DTR 2.3.x cluster to this version |
|
||||
|[dumpcerts](dumpcerts)| Print the TLS certificates used by DTR |
|
||||
|[images](images)| List all the images necessary to install DTR |
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ command.
|
|||
|
||||
Example usage:
|
||||
|
||||
$ docker run -it --rm dtr-internal.caas.docker.io/caas/dtr:2.4.0-alpha-008434_ge02413a install \
|
||||
$ docker run -it --rm dtr-internal.caas.docker.io/caas/dtr:2.4.0-tp5-008777_g5f14189-dirty install \
|
||||
--ucp-node <UCP_NODE_HOSTNAME> \
|
||||
--ucp-insecure-tls
|
||||
|
||||
|
|
|
|||
|
|
@ -6,12 +6,7 @@ keywords: dtr, cli, join
|
|||
|
||||
Add a new replica to an existing DTR cluster
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
docker run -it --rm docker/dtr \
|
||||
join [command options]
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
|
|
@ -29,17 +24,17 @@ For setting DTR for high-availability, create 3, 5, or 7 replicas of DTR.
|
|||
| `--debug` | $DEBUG | Enable debug mode for additional logs. |
|
||||
| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. |
|
||||
| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. |
|
||||
| `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. |
|
||||
| `--replica-http-port` | $REPLICA_HTTP_PORT | The public HTTP port for the DTR replica. Default is 80. This allows you to customize the HTTP port where users can reach DTR. Once users access the HTTP port, they are redirected to use an HTTPS connection, using the port specified with --replica-https-port. This port can also be used for unencrypted health checks. |
|
||||
| `--replica-https-port` | $REPLICA_HTTPS_PORT | The public HTTPS port for the DTR replica. Default is 443. This allows you to customize the HTTPS port where users can reach DTR. Each replica can use a different port. |
|
||||
| `--replica-http-port` | $REPLICA_HTTP_PORT | The public HTTP port for the DTR replica. Default is 80.This allows you to customize the HTTP port where users can reach DTR. Once users access the HTTP port, they are redirected to use an HTTPS connection, using the port specified with --replica-https-port. This port can also be used for unencrypted health checks. |
|
||||
| `--replica-https-port` | $REPLICA_HTTPS_PORT | The public HTTPS port for the DTR replica. Default is 443.This allows you to customize the HTTPS port where users can reach DTR. Each replica can use a different port. |
|
||||
| `--replica-id` | $DTR_INSTALL_REPLICA_ID | Assign an ID to the DTR replica. Random by default. |
|
||||
| `--skip-network-test` | $DTR_SKIP_NETWORK_TEST | Don't test if overlay networks are working correctly between UCP nodes. For high-availability, DTR creates an overlay network between UCP nodes and tests that it is working when joining replicas. Don't use this option for production deployments. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP. Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP. The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-node` | $UCP_NODE | The hostname of the UCP node to deploy DTR. Random by default. You can find the hostnames of the nodes in the cluster in the UCP web UI, or by running `docker node ls` on a UCP manager node. |
|
||||
| `--skip-network-test` | $DTR_SKIP_NETWORK_TEST | Don't test if overlay networks are working correctly between UCP nodes.For high-availalibity, DTR creates an overlay network between UCP nodes and tests that it is working when joining replicas. Don't use this option for production deployments. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP.The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-node` | $UCP_NODE | The hostname of the UCP node to deploy DTR. Random by default.You can find the hostnames of the nodes in the cluster in the UCP web UI, or by running 'docker node ls' on a UCP manager node.. |
|
||||
| `--ucp-password` | $UCP_PASSWORD | The UCP administrator password. |
|
||||
| `--ucp-url` | $UCP_URL | The UCP URL including domain and port. |
|
||||
| `--ucp-username` | $UCP_USERNAME | The UCP administrator username. |
|
||||
| `--unsafe-join` | $DTR_UNSAFE_JOIN | Join a new replica even if the cluster is unhealthy. Joining replicas to an unhealthy DTR cluster leads to split-brain scenarios and data loss. Don't use this option for production deployments. |
|
||||
| `--unsafe-join` | $DTR_UNSAFE_JOIN | Join a new replica even if the cluster is unhealthy.Joining replicas to an unhealthy DTR cluster leads to split-brain scenarios, and data loss. Don't use this option for production deployments. |
|
||||
|
||||
|
|
|
|||
|
|
@ -27,28 +27,28 @@ time, configure your DTR for high-availability.
|
|||
| Option | Environment Variable | Description |
|
||||
|:------------------------------|:--------------------------|:-------------------------------------------------------------------------------------|
|
||||
| `--debug` | $DEBUG | Enable debug mode for additional logs. |
|
||||
| `--dtr-ca` | $DTR_CA | Use a PEM-encoded TLS CA certificate for DTR. By default DTR generates a self-signed TLS certificate during deployment. You can use your own TLS CA certificate with --dtr-ca "$(cat ca.pem)". |
|
||||
| `--dtr-cert` | $DTR_CERT | Use a PEM-encoded TLS certificate for DTR. By default DTR generates a self-signed TLS certificate during deployment. You can use your own TLS certificate with --dtr-cert "$(cat ca.pem)". |
|
||||
| `--dtr-external-url` | $DTR_EXTERNAL_URL | URL of the host or load balancer clients use to reach DTR. When you use this flag, users are redirected to UCP for logging in. Once authenticated they are redirected to the URL you specify in this flag. If you don't use this flag, DTR is deployed without single sign-on with UCP. Users and teams are shared but users log separately into the two applications. You can enable and disable single sign-on in the DTR settings. Format https://host[:port], where port is the value you used with `--replica-https-port`. |
|
||||
| `--dtr-key` | $DTR_KEY | Use a PEM-encoded TLS private key for DTR. By default DTR generates a self-signed TLS certificate during deployment. You can use your own TLS private key with --dtr-key "$(cat ca.pem)". |
|
||||
| `--dtr-storage-volume` | $DTR_STORAGE_VOLUME | Customize the volume to store Docker images. By default DTR creates a volume to store the Docker images in the local filesystem of the node where DTR is running, without high-availability. Use this flag to specify a full path or volume name for DTR to store images. For high-availability, make sure all DTR replicas can read and write data on this volume. If you're using NFS, use `--nfs-storage-url` instead. |
|
||||
| `--enable-pprof` | $DTR_PPROF | Enables pprof profiling of the server. Once DTR is deployed with this flag, you can access the pprof endpoint for the api server at /debug/pprof, and the registry endpoint at /registry_debug_pprof/debug/pprof. |
|
||||
| `--dtr-ca` | $DTR_CA | Use a PEM-encoded TLS CA certificate for DTR.By default DTR generates a self-signed TLS certificate during deployment. You can use your own TLS CA certificate with --dtr-ca "$(cat ca.pem)". |
|
||||
| `--dtr-cert` | $DTR_CERT | Use a PEM-encoded TLS certificate for DTR.By default DTR generates a self-signed TLS certificate during deployment. You can use your own TLS certificate with --dtr-cert "$(cat ca.pem)". |
|
||||
| `--dtr-external-url` | $DTR_EXTERNAL_URL | URL of the host or load balancer clients use to reach DTR.When you use this flag, users are redirected to UCP for logging in. Once authenticated they are redirected to the url you specify in this flag. If you don't use this flag, DTR is deployed without single sign-on with UCP. Users and teams are shared but users login separately into the two applications. You can enable and disable single sign-on in the DTR settings. Format https://host[:port], where port is the value you used with --replica-https-port. |
|
||||
| `--dtr-key` | $DTR_KEY | Use a PEM-encoded TLS private key for DTR.By default DTR generates a self-signed TLS certificate during deployment. You can use your own TLS private key with --dtr-key "$(cat ca.pem)". |
|
||||
| `--dtr-storage-volume` | $DTR_STORAGE_VOLUME | Customize the volume to store Docker images.By default DTR creates a volume to store the Docker images in the local filesystem of the node where DTR is running, without high-availability. Use this flag to specify a full path or volume name for DTR to store images. For high-availability, make sure all DTR replicas can read and write data on this volume. If you're using NFS, use --nfs-storage-url instead. |
|
||||
| `--enable-pprof` | $DTR_PPROF | Enables pprof profiling of the server.Once DTR is deployed with this flag, you can access the pprof endpoint for the api server at /debug/pprof, and the registry endpoint at /registry_debug_pprof/debug/pprof. |
|
||||
| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. |
|
||||
| `--enzi-host` | $ENZI_HOST | The Enzi host. Format host[:port]. |
|
||||
| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica. To safely remove a DTR replica from the cluster, the remove command needs to notify a healthy replica about the replica that's about to be removed. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. |
|
||||
| `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. |
|
||||
| `--http-proxy` | $DTR_HTTP_PROXY | The HTTP proxy used for outgoing requests. |
|
||||
| `--https-proxy` | $DTR_HTTPS_PROXY | The HTTPS proxy used for outgoing requests. |
|
||||
| `--log-host` | $LOG_HOST | Where to send logs to. The endpoint to send logs to. Use this flag if you set `--log-protocol` to tcp or udp. |
|
||||
| `--log-host` | $LOG_HOST | Where to send logs to.The endpoint to send logs to. Use this flag if you set --log-protocol to tcp or udp. |
|
||||
| `--log-level` | $LOG_LEVEL | Log level for all container logs when logging to syslog. Default: INFO. |
|
||||
| `--log-protocol` | $LOG_PROTOCOL | The protocol for sending logs. Default is internal. This allows to define the protocol used to send container logs to an external system. The supported protocals are tcp, udp, or internal. Use this flag with `--log-host`. |
|
||||
| `--nfs-storage-url` | $NFS_STORAGE_URL | NFS to store Docker images. Format nfs://<ip|hostname>/<mountpoint>. By default DTR creates a volume to store the Docker images in the local filesystem of the node where DTR is running, without high-availability. Use this flag to specify an NFS mount for DTR to store images, using the format nfs://<ip|hostname>/<mountpoint>. To use this flag, you need to install an NFS client library like nfs-common in the node where you're deploying DTR. You can test this by running showmount -e <nfs-server>. When you join new replicas, they will start using NFS so you don't need to use this flag. To reconfigure DTR to stop using NFS, leave this option empty. |
|
||||
| `--no-proxy` | $DTR_NO_PROXY | List of domains the proxy should not be used for. When using `--http-proxy` you can use this flag to specify a list of domains that you don't want to route throught the proxy. Format acme.com[, acme.org]. |
|
||||
| `--replica-http-port` | $REPLICA_HTTP_PORT | The public HTTP port for the DTR replica. Default is 80. This allows you to customize the HTTP port where users can reach DTR. Once users access the HTTP port, they are redirected to use an HTTPS connection, using the port specified with `--replica-https-port`. This port can also be used for unencrypted health checks. |
|
||||
| `--replica-https-port` | $REPLICA_HTTPS_PORT | The public HTTPS port for the DTR replica. Default is 443. This allows you to customize the HTTPS port where users can reach DTR. Each replica can use a different port. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP. Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP. The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--log-protocol` | $LOG_PROTOCOL | The protocol for sending logs. Default is internal.This allows to define the protocol used to send container logs to an external system. The supported protocals are tcp, udp, or internal. Use this flag with --log-host. |
|
||||
| `--nfs-storage-url` | $NFS_STORAGE_URL | NFS to store Docker images. Format nfs://<ip|hostname>/<mountpoint>.By default DTR creates a volume to store the Docker images in the local filesystem of the node where DTR is running, without high-availability. Use this flag to specify an NFS mount for DTR to store images, using the format nfs://<ip|hostname>/<mountpoint>. To use this flag, you need to install an NFS client library like nfs-common in the node where you're deploying DTR. You can test this by running showmount -e <nfs-server>. When you join new replicas, they will start using NFS so you don't need to use this flag. To reconfigure DTR to stop using NFS, leave this option empty. |
|
||||
| `--no-proxy` | $DTR_NO_PROXY | List of domains the proxy should not be used for.When using --http-proxy you can use this flag to specify a list of domains that you don't want to route throught the proxy. Format acme.com[, acme.org]. |
|
||||
| `--replica-http-port` | $REPLICA_HTTP_PORT | The public HTTP port for the DTR replica. Default is 80.This allows you to customize the HTTP port where users can reach DTR. Once users access the HTTP port, they are redirected to use an HTTPS connection, using the port specified with --replica-https-port. This port can also be used for unencrypted health checks. |
|
||||
| `--replica-https-port` | $REPLICA_HTTPS_PORT | The public HTTPS port for the DTR replica. Default is 443.This allows you to customize the HTTPS port where users can reach DTR. Each replica can use a different port. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP.The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-password` | $UCP_PASSWORD | The UCP administrator password. |
|
||||
| `--ucp-url` | $UCP_URL | The UCP URL including domain and port. |
|
||||
| `--ucp-username` | $UCP_USERNAME | The UCP administrator username. |
|
||||
|
|
|
|||
|
|
@ -28,12 +28,12 @@ this operation.
|
|||
| `--debug` | $DEBUG | Enable debug mode for additional logs. |
|
||||
| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. |
|
||||
| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica. To safely remove a DTR replica from the cluster, the remove command needs to notify a healthy replica about the replica that's about to be removed. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. |
|
||||
| `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. |
|
||||
| `--replica-id` | $DTR_REMOVE_REPLICA_ID | DEPRECATED Alias for --replica-ids. |
|
||||
| `--replica-ids` | $DTR_REMOVE_REPLICA_IDS | A comma separated list of IDs of replicas to remove from the cluster. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP. Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP. The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP.The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-password` | $UCP_PASSWORD | The UCP administrator password. |
|
||||
| `--ucp-url` | $UCP_URL | The UCP URL including domain and port. |
|
||||
| `--ucp-username` | $UCP_USERNAME | The UCP administrator username. |
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
title: docker/dtr upgrade
|
||||
description: Upgrade DTR 2.0.0 or later cluster to this version
|
||||
description: Upgrade DTR 2.3.x cluster to this version
|
||||
keywords: dtr, cli, upgrade
|
||||
---
|
||||
|
||||
Upgrade DTR 2.0.0 or later cluster to this version
|
||||
Upgrade DTR 2.3.x cluster to this version
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ docker run -it --rm docker/dtr \
|
|||
## Description
|
||||
|
||||
|
||||
This command upgrades DTR 2.0.0 or later to the current version of this image.
|
||||
This command upgrades DTR 2.3.x to the current version of this image.
|
||||
|
||||
|
||||
## Options
|
||||
|
|
@ -26,10 +26,10 @@ This command upgrades DTR 2.0.0 or later to the current version of this image.
|
|||
| `--debug` | $DEBUG | Enable debug mode for additional logs. |
|
||||
| `--enzi-ca` | $ENZI_TLS_CA | Use a PEM-encoded TLS CA certificate for Enzi. |
|
||||
| `--enzi-insecure-tls` | $ENZI_TLS_INSECURE | Disable TLS verification for Enzi. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica. To safely remove a DTR replica from the cluster, the remove command needs to notify a healthy replica about the replica that's about to be removed. |
|
||||
| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica's database.. |
|
||||
| `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP. Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP. The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https://<ucp-url>/ca, and use --ucp-ca "$(cat ca.pem)". |
|
||||
| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP.The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
|
||||
| `--ucp-password` | $UCP_PASSWORD | The UCP administrator password. |
|
||||
| `--ucp-url` | $UCP_URL | The UCP URL including domain and port. |
|
||||
| `--ucp-username` | $UCP_USERNAME | The UCP administrator username. |
|
||||
|
|
|
|||
Loading…
Reference in New Issue