mirror of https://github.com/docker/docs.git
Adds DTR CLI and API ref docs
This commit is contained in:
Joao Fernandes
parent
e0e27a4ee1
commit
ddc5b669f1
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
description: Learn how to use the Docker Trusted Registry REST API
|
||||
keywords: dtr, api, reference
|
||||
title: Docker Trusted Registry 2.1 API
|
||||
title: Docker Trusted Registry 2.2 API
|
||||
---
|
||||
|
||||
<div class="swagger-section">
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
description: Backup a DTR cluster to a tar file and stream it to stdout
|
||||
keywords: docker, dtr, cli, backup
|
||||
title: docker/dtr backup
|
||||
keywords: docker, dtr, cli, backup
|
||||
description: Create a backup of DTR
|
||||
---
|
||||
|
||||
Backup a DTR cluster to a tar file and stream it to stdout
|
||||
Create a backup of DTR
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -16,31 +16,36 @@ docker run -i --rm docker/dtr \
|
|||
## Description
|
||||
|
||||
|
||||
This command creates a backup of configurations and image metadata, in a tar
|
||||
file. It can be used to make periodic backups of a DTR installation.
|
||||
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.
|
||||
|
||||
This command only creates backups of configurations, and image metadata.
|
||||
It does not backup the Docker images stored in your registry.
|
||||
Note:
|
||||
|
||||
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.
|
||||
* This command only creates backups of configurations, and image metadata.
|
||||
It doesn't backup users and organizations. Users and organizations can be
|
||||
backed up when performing a UCP backup.
|
||||
|
||||
WARNING: This backup contains sensitive information and should be
|
||||
stored securely.
|
||||
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.
|
||||
|
||||
* This backup contains sensitive information and should be
|
||||
stored securely.
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|:--------------------------|:---------------------------|
|
||||
|`--ucp-url`|Specify the UCP controller URL including domain and port|
|
||||
|`--ucp-username`|Specify the UCP admin username|
|
||||
|`--ucp-password`|Specify the UCP admin password|
|
||||
|`--debug`|Enable debug mode, provides additional logging|
|
||||
|`--hub-username`|Specify the Docker Hub username for pulling images|
|
||||
|`--hub-password`|Specify the Docker Hub password for pulling images|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--debug`|Enable debug mode for additional logging|
|
||||
|`--existing-replica-id`|The ID of an existing DTR replica|
|
||||
|`--hub-password`|Password to use when pulling images|
|
||||
|`--hub-username`|Username to use when pulling images|
|
||||
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|
||||
|`--existing-replica-id`|ID of an existing replica in a cluster|
|
||||
|`--config-only`|Backup/restore only the configurations of DTR and not the database|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--ucp-password`|The UCP administrator password|
|
||||
|`--ucp-url`|The UCP URL including domain and port|
|
||||
|`--ucp-username`|The UCP administrator username|
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: docker/dtr destroy
|
||||
keywords: docker, dtr, cli, destroy
|
||||
description: Destroy a DTR replica's data
|
||||
---
|
||||
|
||||
Destroy a DTR replica's data
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
docker run -it --rm docker/dtr \
|
||||
destroy [command options]
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
|
||||
This command cleans up any data associated with a replica. It is useful for cleaning up garbage in case of failures or to uninstall DTR. For scaling down a cluster see the remove command.
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|:--------------------------|:---------------------------|
|
||||
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random|
|
||||
|`--ucp-url`|The UCP URL including domain and port|
|
||||
|`--ucp-username`|The UCP administrator username|
|
||||
|`--ucp-password`|The UCP administrator password|
|
||||
|`--debug`|Enable debug mode for additional logging|
|
||||
|`--hub-username`|Username to use when pulling images|
|
||||
|`--hub-password`|Password to use when pulling images|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|
||||
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
---
|
||||
description: Dump out the TLS certificates used by this DTR instance
|
||||
keywords: docker, dtr, cli, dumpcerts
|
||||
title: docker/dtr dumpcerts
|
||||
---
|
||||
|
||||
Dump out the TLS certificates used by this DTR instance
|
||||
|
||||
## 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 | Description |
|
||||
|:--------------------------|:---------------------------|
|
||||
|`--ucp-url`|Specify the UCP controller URL including domain and port|
|
||||
|`--ucp-username`|Specify the UCP admin username|
|
||||
|`--ucp-password`|Specify the UCP admin password|
|
||||
|`--debug`|Enable debug mode, provides additional logging|
|
||||
|`--hub-username`|Specify the Docker Hub username for pulling images|
|
||||
|`--hub-password`|Specify the Docker Hub password for pulling images|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|
||||
|`--existing-replica-id`|ID of an existing replica in a cluster|
|
||||
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
description: Lists all the images necessary to install DTR
|
||||
keywords: docker, dtr, cli, images
|
||||
title: docker/dtr images
|
||||
keywords: docker, dtr, cli, images
|
||||
description: List all the images necessary to install DTR
|
||||
---
|
||||
|
||||
Lists all the images necessary to install DTR
|
||||
List all the images necessary to install DTR
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -17,3 +17,6 @@ docker run -it --rm docker/dtr \
|
|||
|
||||
|
||||
This command lists all the images necessary to install DTR.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
description: Learn about the commands available in the docker/dtr image.
|
||||
keywords: docker, dtr, install, uninstall, configure
|
||||
title: docker/dtr overview
|
||||
keywords: docker, dtr, install, uninstall, configure
|
||||
description: Learn about the commands available in the docker/dtr image.
|
||||
---
|
||||
|
||||
This tool has commands to install, configure, and backup Docker
|
||||
|
|
@ -24,12 +24,14 @@ docker run -it --rm docker/dtr \
|
|||
|
||||
| Option | Description |
|
||||
|:-----------------------------|:---------------------------|
|
||||
|`install`| Install Docker Trusted Registry on this Docker Engine|
|
||||
|`install`| Install Docker Trusted Registry|
|
||||
|`join`| Add a new replica to an existing DTR cluster|
|
||||
|`reconfigure`| Change DTR configurations|
|
||||
|`remove`| Remove a replica from a DTR cluster|
|
||||
|`restore`| Create a new DTR cluster from an existing backup|
|
||||
|`backup`| Backup a DTR cluster to a tar file and stream it to stdout|
|
||||
|`upgrade`| Upgrade a v2.0.0 or later cluster to this version of DTR|
|
||||
|`dumpcerts`| Dump out the TLS certificates used by this DTR instance|
|
||||
|`images`| Lists all the images necessary to install DTR|
|
||||
|`remove`| Remove a DTR replica from a cluster|
|
||||
|`destroy`| Destroy a DTR replica's data|
|
||||
|`restore`| Install and restore DTR from an existing backup|
|
||||
|`backup`| Create a backup of DTR|
|
||||
|`upgrade`| Upgrade DTR 2.0.0 or later cluster to this version|
|
||||
|`dumpcerts`| Print the TLS certificates used by DTR|
|
||||
|`images`| List all the images necessary to install DTR|
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
description: Install Docker Trusted Registry on this Docker Engine
|
||||
keywords: docker, dtr, cli, install
|
||||
title: docker/dtr install
|
||||
keywords: docker, dtr, cli, install
|
||||
description: Install Docker Trusted Registry
|
||||
---
|
||||
|
||||
Install Docker Trusted Registry on this Docker Engine
|
||||
Install Docker Trusted Registry
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -16,42 +16,50 @@ docker run -it --rm docker/dtr \
|
|||
## Description
|
||||
|
||||
|
||||
This command installs DTR on the Docker Engine that runs the command.
|
||||
After installing DTR, you can add more nodes to a DTR cluster with
|
||||
the 'join' command.
|
||||
This command installs Docker Trusted Registry (DTR) on a node managed by
|
||||
Docker Universal Control Plane (UCP).
|
||||
|
||||
After installing DTR, you can join additional DTR replicas using the 'join'
|
||||
command.
|
||||
|
||||
Example usage:
|
||||
|
||||
$ docker run -it --rm docker/dtr:2.2.0-tp2 install \
|
||||
--ucp-node <UCP_NODE_HOSTNAME> \
|
||||
--ucp-insecure-tls
|
||||
|
||||
Note: We recommend --ucp-ca "$(cat ca.pem)" instead of --ucp-insecure-tls for a production deployment.
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|:--------------------------|:---------------------------|
|
||||
|`--ucp-url`|Specify the UCP controller URL including domain and port|
|
||||
|`--ucp-username`|Specify the UCP admin username|
|
||||
|`--ucp-password`|Specify the UCP admin password|
|
||||
|`--debug`|Enable debug mode, provides additional logging|
|
||||
|`--hub-username`|Specify the Docker Hub username for pulling images|
|
||||
|`--hub-password`|Specify the Docker Hub password for pulling images|
|
||||
|`--http-proxy`|Set the HTTP proxy for outgoing requests|
|
||||
|`--https-proxy`|Set the HTTPS proxy for outgoing requests|
|
||||
|`--no-proxy`|Set the list of domains to not proxy to|
|
||||
|`--replica-http-port`|Specify the public HTTP port for the DTR replica; 0 means unchanged/default|
|
||||
|`--replica-https-port`|Specify the public HTTPS port for the DTR replica; 0 means unchanged/default|
|
||||
|`--log-protocol`|The protocol for sending container logs: tcp, tcp+tls, udp or internal. Default: internal|
|
||||
|`--debug`|Enable debug mode for additional logging|
|
||||
|`--dtr-ca`|Use a PEM-encoded TLS CA certificate for DTR. If not provided, one will be generated at install time.|
|
||||
|`--dtr-cert`|Use a PEM-encoded TLS certificate for DTR. If not provided, one will be generated at install time.|
|
||||
|`--dtr-external-url`|URL of the host or load balancer clients use to reach DTR. Format https://host[:port]|
|
||||
|`--dtr-key`|Use a PEM-encoded TLS private key for DTR. If not provided, one will be generated at install time.|
|
||||
|`--dtr-storage-volume`|Full path or volume name to store Docker images in the local filesystem|
|
||||
|`--enable-pprof`|Enables pprof profiling of the server|
|
||||
|`--extra-envs`|Environment variables or swarm constraints for DTR containers. Format var=val[&var=val]|
|
||||
|`--http-proxy`|The HTTP proxy used for outgoing requests|
|
||||
|`--https-proxy`|The HTTPS proxy used for outgoing requests|
|
||||
|`--hub-password`|Password to use when pulling images|
|
||||
|`--hub-username`|Username to use when pulling images|
|
||||
|`--log-host`|Endpoint to send logs to, required if --log-protocol is tcp or udp|
|
||||
|`--log-level`|Log level for container logs. Default: INFO|
|
||||
|`--log-tls-ca-cert`|PEM-encoded TLS CA cert for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-cert`|PEM-encoded TLS cert for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-key`|PEM-encoded TLS key for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-skip-verify`|Configures DTR logging driver's TLS verification. This verification is enabled by default, but it can be overrided by setting this option to true. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--dtr-external-url`|Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead.|
|
||||
|`--enable-pprof`|Enables pprof profiling of the server|
|
||||
|`--etcd-heartbeat-interval`|Set etcd's frequency (ms) that its leader will notify followers that it is still the leader.|
|
||||
|`--etcd-election-timeout`|Set etcd's timeout (ms) for how long a follower node will go without hearing a heartbeat before attempting to become leader itself.|
|
||||
|`--etcd-snapshot-count`|Set etcd's number of changes before creating a snapshot.|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--log-protocol`|The protocol for sending container logs: tcp, tcp+tls, udp or internal. Default: internal|
|
||||
|`--nfs-storage-url`|NFS to store Docker images. Requires NFS client libraries. Format nfs://<ip|hostname>/<mountpoint>|
|
||||
|`--no-proxy`|Don't use a proxy for these domains. Format acme.org[, acme.com]|
|
||||
|`--overlay-subnet`|The subnet used by the dtr-ol overlay network. Example: 10.0.0.0/24|
|
||||
|`--replica-http-port`|The public HTTP port for the DTR replica. Default is 80|
|
||||
|`--replica-https-port`|The public HTTPS port for the DTR replica. Default is 443|
|
||||
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random|
|
||||
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|
||||
|`--nfs-storage-url`|URL (with IP address or hostname) of the NFS mount if using NFS (e.g. nfs://<ip address>/<mount point>)|
|
||||
|`--ucp-node`|Specify the host to install Docker Trusted Registry|
|
||||
|`--replica-id`|Specify the replica ID. Must be unique per replica, leave blank for random|
|
||||
|`--unsafe`|Enable this flag to skip safety checks when installing or joining|
|
||||
|`--extra-envs`|List of extra environment variables to use for deploying the DTR containers for the replica. This can be used to specify swarm constraints. Separate the environment variables with ampersands (&). You can escape actual ampersands with backslashes (\). Can't be used in combination with --ucp-node|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--ucp-node`|The hostname of the node to install DTR|
|
||||
|`--ucp-password`|The UCP administrator password|
|
||||
|`--ucp-url`|The UCP URL including domain and port|
|
||||
|`--ucp-username`|The UCP administrator username|
|
||||
|`--unsafe`|Allow DTR to be installed on a UCP manager node|
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
description: Add a new replica to an existing DTR cluster
|
||||
keywords: docker, dtr, cli, join
|
||||
title: docker/dtr join
|
||||
keywords: docker, dtr, cli, join
|
||||
description: Add a new replica to an existing DTR cluster
|
||||
---
|
||||
|
||||
Add a new replica to an existing DTR cluster
|
||||
|
|
@ -11,30 +11,31 @@ Add a new replica to an existing DTR cluster
|
|||
## Description
|
||||
|
||||
|
||||
This command installs DTR on the Docker Engine that runs the command,
|
||||
and joins the new installation to an existing cluster.
|
||||
This command creates a replica of an existing DTR on a node managed by
|
||||
Docker Universal Control Plane (UCP).
|
||||
|
||||
To set up a cluster with high-availability, add 3, 5, or 7 nodes to
|
||||
the cluster.
|
||||
For setting DTR for high-availability, create 3, 5, or 7 replicas of DTR.
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|:--------------------------|:---------------------------|
|
||||
|`--ucp-url`|Specify the UCP controller URL including domain and port|
|
||||
|`--ucp-username`|Specify the UCP admin username|
|
||||
|`--ucp-password`|Specify the UCP admin password|
|
||||
|`--debug`|Enable debug mode, provides additional logging|
|
||||
|`--hub-username`|Specify the Docker Hub username for pulling images|
|
||||
|`--hub-password`|Specify the Docker Hub password for pulling images|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--debug`|Enable debug mode for additional logging|
|
||||
|`--existing-replica-id`|The ID of an existing DTR replica|
|
||||
|`--extra-envs`|Environment variables or swarm constraints for DTR containers. Format var=val[&var=val]|
|
||||
|`--hub-password`|Password to use when pulling images|
|
||||
|`--hub-username`|Username to use when pulling images|
|
||||
|`--replica-http-port`|The public HTTP port for the DTR replica. Default is 80|
|
||||
|`--replica-https-port`|The public HTTPS port for the DTR replica. Default is 443|
|
||||
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random|
|
||||
|`--skip-network-test`|Don't test if overlay networks are working correctly between UCP nodes|
|
||||
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|
||||
|`--ucp-node`|Specify the host to install Docker Trusted Registry|
|
||||
|`--replica-id`|Specify the replica ID. Must be unique per replica, leave blank for random|
|
||||
|`--unsafe`|Enable this flag to skip safety checks when installing or joining|
|
||||
|`--existing-replica-id`|ID of an existing replica in a cluster|
|
||||
|`--replica-http-port`|Specify the public HTTP port for the DTR replica; 0 means unchanged/default|
|
||||
|`--replica-https-port`|Specify the public HTTPS port for the DTR replica; 0 means unchanged/default|
|
||||
|`--skip-network-test`|Enable this flag to skip the overlay networking test|
|
||||
|`--extra-envs`|List of extra environment variables to use for deploying the DTR containers for the replica. This can be used to specify swarm constraints. Separate the environment variables with ampersands (&). You can escape actual ampersands with backslashes (\). Can't be used in combination with --ucp-node|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--ucp-node`|The hostname of the node to install DTR|
|
||||
|`--ucp-password`|The UCP administrator password|
|
||||
|`--ucp-url`|The UCP URL including domain and port|
|
||||
|`--ucp-username`|The UCP administrator username|
|
||||
|`--unsafe`|Allow DTR to be installed on a UCP manager node|
|
||||
|`--unsafe-join`|Perform the join despite the cluster containing unhealthy replicas.|
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
description: Change DTR configurations
|
||||
keywords: docker, dtr, cli, reconfigure
|
||||
title: docker/dtr reconfigure
|
||||
keywords: docker, dtr, cli, reconfigure
|
||||
description: Change DTR configurations
|
||||
---
|
||||
|
||||
Change DTR configurations
|
||||
|
|
@ -16,42 +16,38 @@ docker run -it --rm docker/dtr \
|
|||
## Description
|
||||
|
||||
|
||||
This command changes specified configurations for DTR and leaves
|
||||
existing configurations in its original state.
|
||||
This command changes DTR configuration settings.
|
||||
|
||||
|
||||
WARNING: DTR is restarted for the new configurations to take
|
||||
effect. To have no down time, configure your DTR for high-availability.
|
||||
DTR is restarted for the new configurations to take effect. To have no down
|
||||
time, configure your DTR for high-availability.
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|:--------------------------|:---------------------------|
|
||||
|`--ucp-url`|Specify the UCP controller URL including domain and port|
|
||||
|`--ucp-username`|Specify the UCP admin username|
|
||||
|`--ucp-password`|Specify the UCP admin password|
|
||||
|`--debug`|Enable debug mode, provides additional logging|
|
||||
|`--hub-username`|Specify the Docker Hub username for pulling images|
|
||||
|`--hub-password`|Specify the Docker Hub password for pulling images|
|
||||
|`--http-proxy`|Set the HTTP proxy for outgoing requests|
|
||||
|`--https-proxy`|Set the HTTPS proxy for outgoing requests|
|
||||
|`--no-proxy`|Set the list of domains to not proxy to|
|
||||
|`--replica-http-port`|Specify the public HTTP port for the DTR replica; 0 means unchanged/default|
|
||||
|`--replica-https-port`|Specify the public HTTPS port for the DTR replica; 0 means unchanged/default|
|
||||
|`--log-protocol`|The protocol for sending container logs: tcp, tcp+tls, udp or internal. Default: internal|
|
||||
|`--debug`|Enable debug mode for additional logging|
|
||||
|`--dtr-ca`|Use a PEM-encoded TLS CA certificate for DTR. If not provided, one will be generated at install time.|
|
||||
|`--dtr-cert`|Use a PEM-encoded TLS certificate for DTR. If not provided, one will be generated at install time.|
|
||||
|`--dtr-external-url`|URL of the host or load balancer clients use to reach DTR. Format https://host[:port]|
|
||||
|`--dtr-key`|Use a PEM-encoded TLS private key for DTR. If not provided, one will be generated at install time.|
|
||||
|`--dtr-storage-volume`|Full path or volume name to store Docker images in the local filesystem|
|
||||
|`--enable-pprof`|Enables pprof profiling of the server|
|
||||
|`--existing-replica-id`|The ID of an existing DTR replica|
|
||||
|`--http-proxy`|The HTTP proxy used for outgoing requests|
|
||||
|`--https-proxy`|The HTTPS proxy used for outgoing requests|
|
||||
|`--hub-password`|Password to use when pulling images|
|
||||
|`--hub-username`|Username to use when pulling images|
|
||||
|`--log-host`|Endpoint to send logs to, required if --log-protocol is tcp or udp|
|
||||
|`--log-level`|Log level for container logs. Default: INFO|
|
||||
|`--log-tls-ca-cert`|PEM-encoded TLS CA cert for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-cert`|PEM-encoded TLS cert for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-key`|PEM-encoded TLS key for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-skip-verify`|Configures DTR logging driver's TLS verification. This verification is enabled by default, but it can be overrided by setting this option to true. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--dtr-external-url`|Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead.|
|
||||
|`--enable-pprof`|Enables pprof profiling of the server|
|
||||
|`--etcd-heartbeat-interval`|Set etcd's frequency (ms) that its leader will notify followers that it is still the leader.|
|
||||
|`--etcd-election-timeout`|Set etcd's timeout (ms) for how long a follower node will go without hearing a heartbeat before attempting to become leader itself.|
|
||||
|`--etcd-snapshot-count`|Set etcd's number of changes before creating a snapshot.|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--log-protocol`|The protocol for sending container logs: tcp, tcp+tls, udp or internal. Default: internal|
|
||||
|`--nfs-storage-url`|NFS to store Docker images. Requires NFS client libraries. Format nfs://<ip|hostname>/<mountpoint>|
|
||||
|`--no-proxy`|Don't use a proxy for these domains. Format acme.org[, acme.com]|
|
||||
|`--replica-http-port`|The public HTTP port for the DTR replica. Default is 80|
|
||||
|`--replica-https-port`|The public HTTPS port for the DTR replica. Default is 443|
|
||||
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|
||||
|`--nfs-storage-url`|URL (with IP address or hostname) of the NFS mount if using NFS (e.g. nfs://<ip address>/<mount point>)|
|
||||
|`--existing-replica-id`|ID of an existing replica in a cluster|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--ucp-password`|The UCP administrator password|
|
||||
|`--ucp-url`|The UCP URL including domain and port|
|
||||
|`--ucp-username`|The UCP administrator username|
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
description: Remove a replica from a DTR cluster
|
||||
keywords: docker, dtr, cli, remove
|
||||
title: docker/dtr remove
|
||||
keywords: docker, dtr, cli, remove
|
||||
description: Remove a DTR replica from a cluster
|
||||
---
|
||||
|
||||
Remove a replica from a DTR cluster
|
||||
Remove a DTR replica from a cluster
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -16,22 +16,22 @@ docker run -it --rm docker/dtr \
|
|||
## Description
|
||||
|
||||
|
||||
This command removes a replica from the cluster, stops and removes all
|
||||
DTR containers, and deletes all DTR volumes.
|
||||
This command removes a replica from a DTR deployment. All DTR containers and
|
||||
volumes are removed from the node.
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|:--------------------------|:---------------------------|
|
||||
|`--ucp-url`|Specify the UCP controller URL including domain and port|
|
||||
|`--ucp-username`|Specify the UCP admin username|
|
||||
|`--ucp-password`|Specify the UCP admin password|
|
||||
|`--debug`|Enable debug mode, provides additional logging|
|
||||
|`--hub-username`|Specify the Docker Hub username for pulling images|
|
||||
|`--hub-password`|Specify the Docker Hub password for pulling images|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--debug`|Enable debug mode for additional logging|
|
||||
|`--existing-replica-id`|The ID of an existing DTR replica|
|
||||
|`--hub-password`|Password to use when pulling images|
|
||||
|`--hub-username`|Username to use when pulling images|
|
||||
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random|
|
||||
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|
||||
|`--force-remove`|Force removal of replica even if it can break your cluster's state. Necessary only when --existing-replica-id == --replica-id.|
|
||||
|`--replica-id`|Specify the replica ID. Must be unique per replica, leave blank for random|
|
||||
|`--existing-replica-id`|ID of an existing replica in a cluster|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--ucp-password`|The UCP administrator password|
|
||||
|`--ucp-url`|The UCP URL including domain and port|
|
||||
|`--ucp-username`|The UCP administrator username|
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
description: Create a new DTR cluster from an existing backup
|
||||
keywords: docker, dtr, cli, restore
|
||||
title: docker/dtr restore
|
||||
keywords: docker, dtr, cli, restore
|
||||
description: Install and restore DTR from an existing backup
|
||||
---
|
||||
|
||||
Create a new DTR cluster from an existing backup
|
||||
Install and restore DTR from an existing backup
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -18,49 +18,42 @@ docker run -i --rm docker/dtr \
|
|||
|
||||
This command performs a fresh installation of DTR, and reconfigures it
|
||||
with configuration data from a tar file generated by the 'backup' command.
|
||||
The command starts by installing DTR, restores the configurations
|
||||
stored on etcd, and then restores the repository metadata stored
|
||||
on RethinkDB.
|
||||
|
||||
This command does not restore Docker images. You should implement a separate
|
||||
restore procedure 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.
|
||||
the local filesystem or using a cloud provider.
|
||||
|
||||
|
||||
After restoring DTR, you can add more nodes to the DTR cluster with
|
||||
the 'join' command.
|
||||
After restoring, you can add more DTR replicas by using the the 'join' command.
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|:--------------------------|:---------------------------|
|
||||
|`--ucp-url`|Specify the UCP controller URL including domain and port|
|
||||
|`--ucp-username`|Specify the UCP admin username|
|
||||
|`--ucp-password`|Specify the UCP admin password|
|
||||
|`--debug`|Enable debug mode, provides additional logging|
|
||||
|`--hub-username`|Specify the Docker Hub username for pulling images|
|
||||
|`--hub-password`|Specify the Docker Hub password for pulling images|
|
||||
|`--http-proxy`|Set the HTTP proxy for outgoing requests|
|
||||
|`--https-proxy`|Set the HTTPS proxy for outgoing requests|
|
||||
|`--no-proxy`|Set the list of domains to not proxy to|
|
||||
|`--replica-http-port`|Specify the public HTTP port for the DTR replica; 0 means unchanged/default|
|
||||
|`--replica-https-port`|Specify the public HTTPS port for the DTR replica; 0 means unchanged/default|
|
||||
|`--log-protocol`|The protocol for sending container logs: tcp, tcp+tls, udp or internal. Default: internal|
|
||||
|`--debug`|Enable debug mode for additional logging|
|
||||
|`--dtr-ca`|Use a PEM-encoded TLS CA certificate for DTR. If not provided, one will be generated at install time.|
|
||||
|`--dtr-cert`|Use a PEM-encoded TLS certificate for DTR. If not provided, one will be generated at install time.|
|
||||
|`--dtr-external-url`|URL of the host or load balancer clients use to reach DTR. Format https://host[:port]|
|
||||
|`--dtr-key`|Use a PEM-encoded TLS private key for DTR. If not provided, one will be generated at install time.|
|
||||
|`--dtr-storage-volume`|Full path or volume name to store Docker images in the local filesystem|
|
||||
|`--enable-pprof`|Enables pprof profiling of the server|
|
||||
|`--http-proxy`|The HTTP proxy used for outgoing requests|
|
||||
|`--https-proxy`|The HTTPS proxy used for outgoing requests|
|
||||
|`--hub-password`|Password to use when pulling images|
|
||||
|`--hub-username`|Username to use when pulling images|
|
||||
|`--log-host`|Endpoint to send logs to, required if --log-protocol is tcp or udp|
|
||||
|`--log-level`|Log level for container logs. Default: INFO|
|
||||
|`--log-tls-ca-cert`|PEM-encoded TLS CA cert for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-cert`|PEM-encoded TLS cert for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-key`|PEM-encoded TLS key for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-skip-verify`|Configures DTR logging driver's TLS verification. This verification is enabled by default, but it can be overrided by setting this option to true. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--dtr-external-url`|Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead.|
|
||||
|`--enable-pprof`|Enables pprof profiling of the server|
|
||||
|`--etcd-heartbeat-interval`|Set etcd's frequency (ms) that its leader will notify followers that it is still the leader.|
|
||||
|`--etcd-election-timeout`|Set etcd's timeout (ms) for how long a follower node will go without hearing a heartbeat before attempting to become leader itself.|
|
||||
|`--etcd-snapshot-count`|Set etcd's number of changes before creating a snapshot.|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--log-protocol`|The protocol for sending container logs: tcp, tcp+tls, udp or internal. Default: internal|
|
||||
|`--nfs-storage-url`|NFS to store Docker images. Requires NFS client libraries. Format nfs://<ip|hostname>/<mountpoint>|
|
||||
|`--no-proxy`|Don't use a proxy for these domains. Format acme.org[, acme.com]|
|
||||
|`--replica-http-port`|The public HTTP port for the DTR replica. Default is 80|
|
||||
|`--replica-https-port`|The public HTTPS port for the DTR replica. Default is 443|
|
||||
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random|
|
||||
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|
||||
|`--ucp-node`|Specify the host to install Docker Trusted Registry|
|
||||
|`--replica-id`|Specify the replica ID. Must be unique per replica, leave blank for random|
|
||||
|`--config-only`|Backup/restore only the configurations of DTR and not the database|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--ucp-node`|The hostname of the node to install DTR|
|
||||
|`--ucp-password`|The UCP administrator password|
|
||||
|`--ucp-url`|The UCP URL including domain and port|
|
||||
|`--ucp-username`|The UCP administrator username|
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
description: Upgrade a v2.0.0 or later cluster to this version of DTR
|
||||
keywords: docker, dtr, cli, upgrade
|
||||
title: docker/dtr upgrade
|
||||
keywords: docker, dtr, cli, upgrade
|
||||
description: Upgrade DTR 2.0.0 or later cluster to this version
|
||||
---
|
||||
|
||||
Upgrade a v2.0.0 or later cluster to this version of DTR
|
||||
Upgrade DTR 2.0.0 or later cluster to this version
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -16,37 +16,20 @@ docker run -it --rm docker/dtr \
|
|||
## Description
|
||||
|
||||
|
||||
This command upgrades an existing DTR 2.0.0 or later cluster to the current version of
|
||||
this bootstrapper.
|
||||
This command upgrades DTR 2.0.0 or later to the current version of this image.
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|:--------------------------|:---------------------------|
|
||||
|`--ucp-url`|Specify the UCP controller URL including domain and port|
|
||||
|`--ucp-username`|Specify the UCP admin username|
|
||||
|`--ucp-password`|Specify the UCP admin password|
|
||||
|`--debug`|Enable debug mode, provides additional logging|
|
||||
|`--hub-username`|Specify the Docker Hub username for pulling images|
|
||||
|`--hub-password`|Specify the Docker Hub password for pulling images|
|
||||
|`--http-proxy`|Set the HTTP proxy for outgoing requests|
|
||||
|`--https-proxy`|Set the HTTPS proxy for outgoing requests|
|
||||
|`--no-proxy`|Set the list of domains to not proxy to|
|
||||
|`--replica-http-port`|Specify the public HTTP port for the DTR replica; 0 means unchanged/default|
|
||||
|`--replica-https-port`|Specify the public HTTPS port for the DTR replica; 0 means unchanged/default|
|
||||
|`--log-protocol`|The protocol for sending container logs: tcp, tcp+tls, udp or internal. Default: internal|
|
||||
|`--log-host`|Endpoint to send logs to, required if --log-protocol is tcp or udp|
|
||||
|`--log-level`|Log level for container logs. Default: INFO|
|
||||
|`--log-tls-ca-cert`|PEM-encoded TLS CA cert for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-cert`|PEM-encoded TLS cert for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-key`|PEM-encoded TLS key for DTR logging driver. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--log-tls-skip-verify`|Configures DTR logging driver's TLS verification. This verification is enabled by default, but it can be overrided by setting this option to true. This option is ignored if the address protocol is not tcp+tls.|
|
||||
|`--dtr-external-url`|Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead.|
|
||||
|`--enable-pprof`|Enables pprof profiling of the server|
|
||||
|`--etcd-heartbeat-interval`|Set etcd's frequency (ms) that its leader will notify followers that it is still the leader.|
|
||||
|`--etcd-election-timeout`|Set etcd's timeout (ms) for how long a follower node will go without hearing a heartbeat before attempting to become leader itself.|
|
||||
|`--etcd-snapshot-count`|Set etcd's number of changes before creating a snapshot.|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--debug`|Enable debug mode for additional logging|
|
||||
|`--existing-replica-id`|The ID of an existing DTR replica|
|
||||
|`--hub-password`|Password to use when pulling images|
|
||||
|`--hub-username`|Username to use when pulling images|
|
||||
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|
||||
|`--existing-replica-id`|ID of an existing replica in a cluster|
|
||||
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|
||||
|`--ucp-password`|The UCP administrator password|
|
||||
|`--ucp-url`|The UCP URL including domain and port|
|
||||
|`--ucp-username`|The UCP administrator username|
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue