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

Update DTR CLI reference docs

This commit is contained in:
Joao Fernandes 2016-11-07 11:32:44 -08:00
parent 03436c4300
commit 0b59c516cc
13 changed files with 234 additions and 343 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
datacenter/dtr/2.1/reference/backup.md
View File

@ -1,17 +1,11 @@
<!--[metadata]> ---
+++ title: backup
title ="backup" keywords:
description="Create a backup of DTR" - docker, dtr, cli, backup
keywords= ["docker, dtr, cli, backup"] description: Backup a DTR cluster to a tar file and stream it to stdout
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_backup"
+++
<![end-metadata]-->
# docker/dtr backup Backup a DTR cluster to a tar file and stream it to stdout
Create a backup of DTR
## Usage ## Usage
@ -23,37 +17,32 @@ docker run -i --rm docker/dtr \
## Description ## Description
This command creates a tar file with the contents of the volumes used by This command creates a backup of configurations and image metadata, in a tar
DTR, and prints it. You can then use the 'restore' command to restore the data file. It can be used to make periodic backups of a DTR installation.
from an existing backup.
Note: This command only creates backups of configurations, and image metadata.
It does not backup the Docker images stored in your registry.
* This command only creates backups of configurations, and image metadata. You should implement a separate backup policy for the Docker images stored
It doesn't backup users and organizations. Users and organizations can be in your registry, taking in consideration whether your DTR installation is
backed up when performing a UCP backup. configured to store images on the filesystem or using a cloud provider.
It also doesn't backup the Docker images stored in your registry. WARNING: This backup contains sensitive information and should be
You should implement a separate backup policy for the Docker images stored stored securely.
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 ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:--------------------------|:---------------------------|
|`--ucp-url`|The UCP URL including domain and port| |`--ucp-url`|Specify the UCP controller URL including domain and port|
|`--ucp-username`|The UCP administrator username| |`--ucp-username`|Specify the UCP admin username|
|`--ucp-password`|The UCP administrator password| |`--ucp-password`|Specify the UCP admin password|
|`--debug`|Enable debug mode for additional logging| |`--debug`|Enable debug mode, provides additional logging|
|`--hub-username`|Username to use when pulling images| |`--hub-username`|Specify the Docker Hub username for pulling images|
|`--hub-password`|Password to use when pulling images| |`--hub-password`|Specify the Docker Hub password for pulling images|
|`--ucp-insecure-tls`|Disable TLS verification for UCP| |`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP| |`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--existing-replica-id`|The ID of an existing DTR replica| |`--existing-replica-id`|ID of an existing replica in a cluster|
|`--config-only`|Backup/restore only the configurations of DTR and not the database| |`--config-only`|Backup/restore only the configurations of DTR and not the database|

34
datacenter/dtr/2.1/reference/dumpcerts.md
View File

@ -1,17 +1,11 @@
<!--[metadata]> ---
+++ title: dumpcerts
title ="dumpcerts" keywords:
description="Print the TLS certificates used by DTR" - docker, dtr, cli, dumpcerts
keywords= ["docker, dtr, cli, dumpcerts"] description: Dump out the TLS certificates used by this DTR instance
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_dumpcerts"
+++
<![end-metadata]-->
# docker/dtr dumpcerts Dump out the TLS certificates used by this DTR instance
Print the TLS certificates used by DTR
## Usage ## Usage
@ -31,13 +25,13 @@ communicating across replicas with TLS.
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:--------------------------|:---------------------------|
|`--ucp-url`|The UCP URL including domain and port| |`--ucp-url`|Specify the UCP controller URL including domain and port|
|`--ucp-username`|The UCP administrator username| |`--ucp-username`|Specify the UCP admin username|
|`--ucp-password`|The UCP administrator password| |`--ucp-password`|Specify the UCP admin password|
|`--debug`|Enable debug mode for additional logging| |`--debug`|Enable debug mode, provides additional logging|
|`--hub-username`|Username to use when pulling images| |`--hub-username`|Specify the Docker Hub username for pulling images|
|`--hub-password`|Password to use when pulling images| |`--hub-password`|Specify the Docker Hub password for pulling images|
|`--ucp-insecure-tls`|Disable TLS verification for UCP| |`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP| |`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--existing-replica-id`|The ID of an existing DTR replica| |`--existing-replica-id`|ID of an existing replica in a cluster|

20
datacenter/dtr/2.1/reference/images.md
View File

@ -1,17 +1,11 @@
<!--[metadata]> ---
+++ title: images
title ="images" keywords:
description="List all the images necessary to install DTR" - docker, dtr, cli, images
keywords= ["docker, dtr, cli, images"] description: Lists all the images necessary to install DTR
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_images"
+++
<![end-metadata]-->
# docker/dtr images Lists all the images necessary to install DTR
List all the images necessary to install DTR
## Usage ## Usage

33
datacenter/dtr/2.1/reference/index.md
View File

@ -1,16 +1,9 @@
<!--[metadata]> ---
+++ title: docker/dtr overview
title = "Overview" keywords:
description = "Learn about the commands available in the docker/dtr image." - docker, dtr, install, uninstall, configure
keywords = ["docker, dtr, install, uninstall, configure"] description: Learn about the commands available in the docker/dtr image.
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_overview"
weight=-10
+++
<![end-metadata]-->
# docker/dtr overview
This tool has commands to install, configure, and backup Docker This tool has commands to install, configure, and backup Docker
Trusted Registry (DTR). It also allows uninstalling DTR. Trusted Registry (DTR). It also allows uninstalling DTR.
@ -32,13 +25,13 @@ docker run -it --rm docker/dtr \
| Option | Description | | Option | Description |
|:-----------------------------|:---------------------------| |:-----------------------------|:---------------------------|
|`install`| Install Docker Trusted Registry| |`install`| Install Docker Trusted Registry on this Docker Engine|
|`join`| Add a new replica to an existing DTR cluster| |`join`| Add a new replica to an existing DTR cluster|
|`reconfigure`| Change DTR configurations| |`reconfigure`| Change DTR configurations|
|`remove`| Remove a DTR replica| |`remove`| Remove a replica from a DTR cluster|
|`restore`| Install and restore DTR from an existing backup| |`restore`| Create a new DTR cluster from an existing backup|
|`backup`| Create a backup of DTR| |`backup`| Backup a DTR cluster to a tar file and stream it to stdout|
|`upgrade`| Upgrade DTR 2.0.0 or later cluster to this version| |`upgrade`| Upgrade a v2.0.0 or later cluster to this version of DTR|
|`dumpcerts`| Print the TLS certificates used by DTR| |`dumpcerts`| Dump out the TLS certificates used by this DTR instance|
|`images`| List all the images necessary to install DTR| |`images`| Lists all the images necessary to install DTR|

77
datacenter/dtr/2.1/reference/install.md
View File

@ -1,17 +1,11 @@
<!--[metadata]> ---
+++ title: install
title ="install" keywords:
description="Install Docker Trusted Registry" - docker, dtr, cli, install
keywords= ["docker, dtr, cli, install"] description: Install Docker Trusted Registry on this Docker Engine
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_install"
+++
<![end-metadata]-->
# docker/dtr install Install Docker Trusted Registry on this Docker Engine
Install Docker Trusted Registry
## Usage ## Usage
@ -23,46 +17,43 @@ docker run -it --rm docker/dtr \
## Description ## Description
This command installs Docker Trusted Registry (DTR) on a node managed by This command installs DTR on the Docker Engine that runs the command.
Docker Universal Control Plane (UCP). After installing DTR, you can add more nodes to a DTR cluster with
the 'join' command.
After installing DTR, you can join additional DTR replicas using the 'join'
command.
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:--------------------------|:---------------------------|
|`--ucp-url`|The UCP URL including domain and port| |`--ucp-url`|Specify the UCP controller URL including domain and port|
|`--ucp-username`|The UCP administrator username| |`--ucp-username`|Specify the UCP admin username|
|`--ucp-password`|The UCP administrator password| |`--ucp-password`|Specify the UCP admin password|
|`--debug`|Enable debug mode for additional logging| |`--debug`|Enable debug mode, provides additional logging|
|`--hub-username`|Username to use when pulling images| |`--hub-username`|Specify the Docker Hub username for pulling images|
|`--hub-password`|Password to use when pulling images| |`--hub-password`|Specify the Docker Hub password for pulling images|
|`--http-proxy`|The HTTP proxy used for outgoing requests| |`--http-proxy`|Set the HTTP proxy for outgoing requests|
|`--https-proxy`|The HTTPS proxy used for outgoing requests| |`--https-proxy`|Set the HTTPS proxy for outgoing requests|
|`--no-proxy`|Don't use a proxy for these domains. Format acme.org[, acme.com]| |`--no-proxy`|Set the list of domains to not proxy to|
|`--replica-http-port`|The public HTTP port for the DTR replica. Default is 80| |`--replica-http-port`|Specify the public HTTP port for the DTR replica; 0 means unchanged/default|
|`--replica-https-port`|The public HTTPS port for the DTR replica. Default is 443| |`--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-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-host`|Endpoint to send logs to, required if --log-protocol is tcp or udp|
|`--log-level`|Log level for container logs. Default: INFO| |`--log-level`|Log level for container logs. Default: INFO|
|`--log-tls-ca-cert`|PEM-encoded TLS CA cert for DTR logging driver. Ignored if the logging protocol is not tcp+tls| |`--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. Ignored if the logging 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. 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`|Disable TLS verification for the logging service. Ignored if the logging address 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`|URL of the host or load balancer clients use to reach DTR. Format https://host[:port]| |`--dtr-external-url`|Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead.|
|`--dtr-storage-volume`|Full path or volume name to store Docker images in the local filesystem|
|`--nfs-storage-url`|NFS to store Docker images. Requires NFS client libraries. Format nfs://<ip|hostname>/<mountpoint>|
|`--enable-pprof`|Enables pprof profiling of the server| |`--enable-pprof`|Enables pprof profiling of the server|
|`--etcd-heartbeat-interval`|Frequency in milliseconds that the key-value store leader notifies followers| |`--etcd-heartbeat-interval`|Set etcd's frequency (ms) that its leader will notify followers that it is still the leader.|
|`--etcd-election-timeout`|Timeout in milliseconds for key-value store membership| |`--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`|Number of changes between key-value store snapshots| |`--etcd-snapshot-count`|Set etcd's number of changes before creating a snapshot.|
|`--ucp-insecure-tls`|Disable TLS verification for UCP| |`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP| |`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--ucp-node`|The hostname of the node to install DTR| |`--nfs-storage-url`|URL (with IP address or hostname) of the NFS mount if using NFS (e.g. nfs://<ip address>/<mount point>)|
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random| |`--ucp-node`|Specify the host to install Docker Trusted Registry|
|`--unsafe`|Allow DTR to be installed on a UCP manager node| |`--replica-id`|Specify the replica ID. Must be unique per replica, leave blank for random|
|`--extra-envs`|Environment variables or swarm constraints for DTR containers. Format var=val[&var=val]| |`--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|

53
datacenter/dtr/2.1/reference/join.md
View File

@ -1,15 +1,9 @@
<!--[metadata]> ---
+++ title: join
title ="join" keywords:
description="Add a new replica to an existing DTR cluster" - docker, dtr, cli, join
keywords= ["docker, dtr, cli, join"] description: Add a new replica to an existing DTR cluster
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_join"
+++
<![end-metadata]-->
# docker/dtr join
Add a new replica to an existing DTR cluster Add a new replica to an existing DTR cluster
@ -18,30 +12,31 @@ Add a new replica to an existing DTR cluster
## Description ## Description
This command creates a replica of an existing DTR on a node managed by This command installs DTR on the Docker Engine that runs the command,
Docker Universal Control Plane (UCP). and joins the new installation to an existing cluster.
For setting DTR for high-availability, create 3, 5, or 7 replicas of DTR. To set up a cluster with high-availability, add 3, 5, or 7 nodes to
the cluster.
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:--------------------------|:---------------------------|
|`--ucp-url`|The UCP URL including domain and port| |`--ucp-url`|Specify the UCP controller URL including domain and port|
|`--ucp-username`|The UCP administrator username| |`--ucp-username`|Specify the UCP admin username|
|`--ucp-password`|The UCP administrator password| |`--ucp-password`|Specify the UCP admin password|
|`--debug`|Enable debug mode for additional logging| |`--debug`|Enable debug mode, provides additional logging|
|`--hub-username`|Username to use when pulling images| |`--hub-username`|Specify the Docker Hub username for pulling images|
|`--hub-password`|Password to use when pulling images| |`--hub-password`|Specify the Docker Hub password for pulling images|
|`--ucp-insecure-tls`|Disable TLS verification for UCP| |`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP| |`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--ucp-node`|The hostname of the node to install DTR| |`--ucp-node`|Specify the host to install Docker Trusted Registry|
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random| |`--replica-id`|Specify the replica ID. Must be unique per replica, leave blank for random|
|`--unsafe`|Allow DTR to be installed on a UCP manager node| |`--unsafe`|Enable this flag to skip safety checks when installing or joining|
|`--existing-replica-id`|The ID of an existing DTR replica| |`--existing-replica-id`|ID of an existing replica in a cluster|
|`--replica-http-port`|The public HTTP port for the DTR replica. Default is 80| |`--replica-http-port`|Specify the public HTTP port for the DTR replica; 0 means unchanged/default|
|`--replica-https-port`|The public HTTPS port for the DTR replica. Default is 443| |`--replica-https-port`|Specify the public HTTPS port for the DTR replica; 0 means unchanged/default|
|`--skip-network-test`|Don't test if overlay networks are working correctly between UCP nodes| |`--skip-network-test`|Enable this flag to skip the overlay networking test|
|`--extra-envs`|Environment variables or swarm constraints for DTR containers. Format var=val[&var=val]| |`--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|

12
datacenter/dtr/2.1/reference/menu.md
View File

@ -1,12 +0,0 @@
<!--[metadata]>
+++
title = "docker/dtr image reference"
description = "Learn about the commands available in the docker/dtr image."
keywords = ["docker, dtr, install, uninstall, configure"]
type = "menu"
[menu.main]
parent="dtr-menu-install"
identifier="dtr_menu_reference"
weight=60
+++
<![end-metadata]-->

51
datacenter/dtr/2.1/reference/migrate.md
View File

@ -1,51 +0,0 @@
<!--[metadata]>
+++
title = "migrate"
description = "Learn about the options available on the docker/dtr image."
keywords = ["docker, dtr, install, uninstall, configure"]
[menu.main]
parent="dtr_menu_reference"
identifier="dtr_reference_migrate"
+++
<![end-metadata]-->
# docker/dtr migrate
Migrate configurations, accounts, and repository metadata from DTR 1.4.3 to 2.0.
Only available in `docker/dtr` version 2.0.x.
## Usage
```bash
$ docker run -it --rm docker/dtr \
migrate [command options]
```
## Description
This command migrates configurations, accounts, and repository metadata from
Docker Trusted Registry 1.4.3 to 2.0.
To upgrade from DTR 1.4.3 to 2.0 you first need to do a fresh installation of
DTR 2.0. Then you run this command on the host where DTR 1.4.3 is running, to
migrate the data to the new installation. Finally, you decommission your
DTR 1.4.3 by uninstalling it.
| Option | Description |
|:-----------------------|:-------------------------------------------------------------------------------------|
| `--ucp-url ` | Specify the UCP controller URL [$UCP_URL] |
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] |
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] |
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] |
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] |
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] |
| `--run-full-migration` | Run full migration procedure instead of dumping configurations [$RUN_FULL_MIGRATION] |
| `--dtr-load-balancer` | Specify the domain name and port for the DTR load balancer [$DTR_LOAD_BALANCER] |
| `--dtr-insecure-tls` | Disable TLS verification for DTR [$DTR_INSECURE_TLS] |
| `--dtr-ca` | PEM-encoded TLS CA cert for DTR [$DTR_CA] |
| `--http-proxy` | Set the HTTP proxy for outgoing requests [$DTR_HTTP_PROXY] |
| `--https-proxy` | Set the HTTPS proxy for outgoing requests [$DTR_HTTPS_PROXY] |
| `--no-proxy` | Set the list of domains to not proxy to [$DTR_NO_PROXY] |

69
datacenter/dtr/2.1/reference/reconfigure.md
View File

@ -1,15 +1,9 @@
<!--[metadata]> ---
+++ title: reconfigure
title ="reconfigure" keywords:
description="Change DTR configurations" - docker, dtr, cli, reconfigure
keywords= ["docker, dtr, cli, reconfigure"] description: Change DTR configurations
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_reconfigure"
+++
<![end-metadata]-->
# docker/dtr reconfigure
Change DTR configurations Change DTR configurations
@ -23,42 +17,43 @@ docker run -it --rm docker/dtr \
## Description ## Description
This command changes DTR configuration settings. This command changes specified configurations for DTR and leaves
existing configurations in its original state.
DTR is restarted for the new configurations to take effect. To have no down
time, configure your DTR for high-availability. WARNING: DTR is restarted for the new configurations to take
effect. To have no down time, configure your DTR for high-availability.
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:--------------------------|:---------------------------|
|`--ucp-url`|The UCP URL including domain and port| |`--ucp-url`|Specify the UCP controller URL including domain and port|
|`--ucp-username`|The UCP administrator username| |`--ucp-username`|Specify the UCP admin username|
|`--ucp-password`|The UCP administrator password| |`--ucp-password`|Specify the UCP admin password|
|`--debug`|Enable debug mode for additional logging| |`--debug`|Enable debug mode, provides additional logging|
|`--hub-username`|Username to use when pulling images| |`--hub-username`|Specify the Docker Hub username for pulling images|
|`--hub-password`|Password to use when pulling images| |`--hub-password`|Specify the Docker Hub password for pulling images|
|`--http-proxy`|The HTTP proxy used for outgoing requests| |`--http-proxy`|Set the HTTP proxy for outgoing requests|
|`--https-proxy`|The HTTPS proxy used for outgoing requests| |`--https-proxy`|Set the HTTPS proxy for outgoing requests|
|`--no-proxy`|Don't use a proxy for these domains. Format acme.org[, acme.com]| |`--no-proxy`|Set the list of domains to not proxy to|
|`--replica-http-port`|The public HTTP port for the DTR replica. Default is 80| |`--replica-http-port`|Specify the public HTTP port for the DTR replica; 0 means unchanged/default|
|`--replica-https-port`|The public HTTPS port for the DTR replica. Default is 443| |`--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-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-host`|Endpoint to send logs to, required if --log-protocol is tcp or udp|
|`--log-level`|Log level for container logs. Default: INFO| |`--log-level`|Log level for container logs. Default: INFO|
|`--log-tls-ca-cert`|PEM-encoded TLS CA cert for DTR logging driver. Ignored if the logging protocol is not tcp+tls| |`--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. Ignored if the logging 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. 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`|Disable TLS verification for the logging service. Ignored if the logging address 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`|URL of the host or load balancer clients use to reach DTR. Format https://host[:port]| |`--dtr-external-url`|Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead.|
|`--dtr-storage-volume`|Full path or volume name to store Docker images in the local filesystem|
|`--nfs-storage-url`|NFS to store Docker images. Requires NFS client libraries. Format nfs://<ip|hostname>/<mountpoint>|
|`--enable-pprof`|Enables pprof profiling of the server| |`--enable-pprof`|Enables pprof profiling of the server|
|`--etcd-heartbeat-interval`|Frequency in milliseconds that the key-value store leader notifies followers| |`--etcd-heartbeat-interval`|Set etcd's frequency (ms) that its leader will notify followers that it is still the leader.|
|`--etcd-election-timeout`|Timeout in milliseconds for key-value store membership| |`--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`|Number of changes between key-value store snapshots| |`--etcd-snapshot-count`|Set etcd's number of changes before creating a snapshot.|
|`--ucp-insecure-tls`|Disable TLS verification for UCP| |`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP| |`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--existing-replica-id`|The ID of an existing DTR replica| |`--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|

42
datacenter/dtr/2.1/reference/remove.md
View File

@ -1,17 +1,11 @@
<!--[metadata]> ---
+++ title: remove
title ="remove" keywords:
description="Remove a DTR replica" - docker, dtr, cli, remove
keywords= ["docker, dtr, cli, remove"] description: Remove a replica from a DTR cluster
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_remove"
+++
<![end-metadata]-->
# docker/dtr remove Remove a replica from a DTR cluster
Remove a DTR replica
## Usage ## Usage
@ -23,23 +17,23 @@ docker run -it --rm docker/dtr \
## Description ## Description
This command removes a replica from a DTR deployment. All DTR containers and This command removes a replica from the cluster, stops and removes all
volumes are removed from the node. DTR containers, and deletes all DTR volumes.
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:--------------------------|:---------------------------|
|`--ucp-url`|The UCP URL including domain and port| |`--ucp-url`|Specify the UCP controller URL including domain and port|
|`--ucp-username`|The UCP administrator username| |`--ucp-username`|Specify the UCP admin username|
|`--ucp-password`|The UCP administrator password| |`--ucp-password`|Specify the UCP admin password|
|`--debug`|Enable debug mode for additional logging| |`--debug`|Enable debug mode, provides additional logging|
|`--hub-username`|Username to use when pulling images| |`--hub-username`|Specify the Docker Hub username for pulling images|
|`--hub-password`|Password to use when pulling images| |`--hub-password`|Specify the Docker Hub password for pulling images|
|`--ucp-insecure-tls`|Disable TLS verification for UCP| |`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP| |`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--force-remove`|Force a DTR replica to be removed| |`--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`|Assign an ID to the DTR replica. By default the ID is random| |`--replica-id`|Specify the replica ID. Must be unique per replica, leave blank for random|
|`--existing-replica-id`|The ID of an existing DTR replica| |`--existing-replica-id`|ID of an existing replica in a cluster|

73
datacenter/dtr/2.1/reference/restore.md
View File

@ -1,17 +1,11 @@
<!--[metadata]> ---
+++ title: restore
title ="restore" keywords:
description="Install and restore DTR from an existing backup" - docker, dtr, cli, restore
keywords= ["docker, dtr, cli, restore"] description: Create a new DTR cluster from an existing backup
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_restore"
+++
<![end-metadata]-->
# docker/dtr restore Create a new DTR cluster from an existing backup
Install and restore DTR from an existing backup
## Usage ## Usage
@ -25,47 +19,50 @@ docker run -i --rm docker/dtr \
This command performs a fresh installation of DTR, and reconfigures it This command performs a fresh installation of DTR, and reconfigures it
with configuration data from a tar file generated by the 'backup' command. 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 This command does not restore Docker images. You should implement a separate
restore procedure for the Docker images stored in your registry, taking in restore procedure for the Docker images stored in your registry, taking in
consideration whether your DTR installation is configured to store images on consideration whether your DTR installation is configured to store images on
the local filesystem or using a cloud provider. the filesystem or using a cloud provider.
After restoring, you can add more DTR replicas by using the the 'join' command.
After restoring DTR, you can add more nodes to the DTR cluster with
the 'join' command.
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:--------------------------|:---------------------------|
|`--ucp-url`|The UCP URL including domain and port| |`--ucp-url`|Specify the UCP controller URL including domain and port|
|`--ucp-username`|The UCP administrator username| |`--ucp-username`|Specify the UCP admin username|
|`--ucp-password`|The UCP administrator password| |`--ucp-password`|Specify the UCP admin password|
|`--debug`|Enable debug mode for additional logging| |`--debug`|Enable debug mode, provides additional logging|
|`--hub-username`|Username to use when pulling images| |`--hub-username`|Specify the Docker Hub username for pulling images|
|`--hub-password`|Password to use when pulling images| |`--hub-password`|Specify the Docker Hub password for pulling images|
|`--http-proxy`|The HTTP proxy used for outgoing requests| |`--http-proxy`|Set the HTTP proxy for outgoing requests|
|`--https-proxy`|The HTTPS proxy used for outgoing requests| |`--https-proxy`|Set the HTTPS proxy for outgoing requests|
|`--no-proxy`|Don't use a proxy for these domains. Format acme.org[, acme.com]| |`--no-proxy`|Set the list of domains to not proxy to|
|`--replica-http-port`|The public HTTP port for the DTR replica. Default is 80| |`--replica-http-port`|Specify the public HTTP port for the DTR replica; 0 means unchanged/default|
|`--replica-https-port`|The public HTTPS port for the DTR replica. Default is 443| |`--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-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-host`|Endpoint to send logs to, required if --log-protocol is tcp or udp|
|`--log-level`|Log level for container logs. Default: INFO| |`--log-level`|Log level for container logs. Default: INFO|
|`--log-tls-ca-cert`|PEM-encoded TLS CA cert for DTR logging driver. Ignored if the logging protocol is not tcp+tls| |`--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. Ignored if the logging 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. 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`|Disable TLS verification for the logging service. Ignored if the logging address 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`|URL of the host or load balancer clients use to reach DTR. Format https://host[:port]| |`--dtr-external-url`|Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead.|
|`--dtr-storage-volume`|Full path or volume name to store Docker images in the local filesystem|
|`--nfs-storage-url`|NFS to store Docker images. Requires NFS client libraries. Format nfs://<ip|hostname>/<mountpoint>|
|`--enable-pprof`|Enables pprof profiling of the server| |`--enable-pprof`|Enables pprof profiling of the server|
|`--etcd-heartbeat-interval`|Frequency in milliseconds that the key-value store leader notifies followers| |`--etcd-heartbeat-interval`|Set etcd's frequency (ms) that its leader will notify followers that it is still the leader.|
|`--etcd-election-timeout`|Timeout in milliseconds for key-value store membership| |`--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`|Number of changes between key-value store snapshots| |`--etcd-snapshot-count`|Set etcd's number of changes before creating a snapshot.|
|`--ucp-insecure-tls`|Disable TLS verification for UCP| |`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP| |`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--ucp-node`|The hostname of the node to install DTR| |`--ucp-node`|Specify the host to install Docker Trusted Registry|
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random| |`--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| |`--config-only`|Backup/restore only the configurations of DTR and not the database|

54
datacenter/dtr/2.1/reference/upgrade.md
View File

@ -1,17 +1,11 @@
<!--[metadata]> ---
+++ title: upgrade
title ="upgrade" keywords:
description="Upgrade DTR 2.0.0 or later cluster to this version" - docker, dtr, cli, upgrade
keywords= ["docker, dtr, cli, upgrade"] description: Upgrade a v2.0.0 or later cluster to this version of DTR
[menu.main] ---
parent="dtr_menu_reference"
identifier="dtr_reference_upgrade"
+++
<![end-metadata]-->
# docker/dtr upgrade 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 ## Usage
@ -23,20 +17,38 @@ docker run -it --rm docker/dtr \
## Description ## Description
This command upgrades DTR 2.0.0 or later to the current version of this image. This command upgrades an existing DTR 2.0.0 or later cluster to the current version of
this bootstrapper.
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:--------------------------|:---------------------------|
|`--ucp-url`|The UCP URL including domain and port| |`--ucp-url`|Specify the UCP controller URL including domain and port|
|`--ucp-username`|The UCP administrator username| |`--ucp-username`|Specify the UCP admin username|
|`--ucp-password`|The UCP administrator password| |`--ucp-password`|Specify the UCP admin password|
|`--debug`|Enable debug mode for additional logging| |`--debug`|Enable debug mode, provides additional logging|
|`--hub-username`|Username to use when pulling images| |`--hub-username`|Specify the Docker Hub username for pulling images|
|`--hub-password`|Password to use when 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| |`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP| |`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--existing-replica-id`|The ID of an existing DTR replica| |`--existing-replica-id`|ID of an existing replica in a cluster|

2
datacenter/dtr/2.1/release-notes/index.md
View File

@ -1,7 +1,7 @@
--- ---
title: Docker Trusted Registry release notes title: Docker Trusted Registry release notes
keywords:
description: Docker Trusted Registry release notes description: Docker Trusted Registry release notes
keywords:
- docker, documentation, about, technology, understanding, enterprise, hub, registry, release notes, Docker Trusted Registry - docker, documentation, about, technology, understanding, enterprise, hub, registry, release notes, Docker Trusted Registry
--- ---