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

Update docker/dtr image reference

This commit is contained in:
Joao Fernandes 2016-10-25 16:18:00 -07:00
parent 0888a73e7e
commit 77031cb909
12 changed files with 257 additions and 169 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_data/toc.yaml
View File

@ -777,6 +777,8 @@ toc:
title: backup title: backup
- path: /docker-trusted-registry/reference/dumpcerts/ - path: /docker-trusted-registry/reference/dumpcerts/
title: dumpcerts title: dumpcerts
- path: /docker-trusted-registry/reference/images/
title: images
- path: /docker-trusted-registry/reference/install/ - path: /docker-trusted-registry/reference/install/
title: install title: install
- path: /docker-trusted-registry/reference/join/ - path: /docker-trusted-registry/reference/join/
@ -789,6 +791,8 @@ toc:
title: remove title: remove
- path: /docker-trusted-registry/reference/restore/ - path: /docker-trusted-registry/reference/restore/
title: restore title: restore
- path: /docker-trusted-registry/reference/upgrade/
title: upgrade
- sectiontitle: Configuration - sectiontitle: Configuration
section: section:
- path: /docker-trusted-registry/configure/configuration/ - path: /docker-trusted-registry/configure/configuration/

29
docker-trusted-registry/reference/backup.md
View File

@ -16,8 +16,8 @@ Backup a DTR cluster to a tar file and stream it to stdout
## Usage ## Usage
```bash ```bash
$ docker run -i --rm docker/dtr \ docker run -i --rm docker/dtr \
backup [command options] > backup.tar backup [command options] > backup.tar
``` ```
## Description ## Description
@ -35,16 +35,17 @@ configured to store images on the filesystem or using a cloud provider.
WARNING: This backup contains sensitive information and should be WARNING: This backup contains sensitive information and should be
stored securely. stored securely.
## Options
| Option | Description | | Option | Description |
|:------------------------|:--------------------------------------------------------------------------------------| |:------------------------|:-------------------------------------------------------------------|
| `--ucp-url` | Specify the UCP controller URL [$UCP_URL] | | `--ucp-url` | Specify the UCP controller URL including domain and port |
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] | | `--ucp-username` | Specify the UCP admin username |
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] | | `--ucp-password` | Specify the UCP admin password |
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] | | `--debug` | Enable debug mode, provides additional logging |
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] | | `--hub-username` | Specify the Docker Hub username for pulling images |
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] | | `--hub-password` | Specify the Docker Hub password for pulling images |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] | | `--ucp-insecure-tls` | Disable TLS verification for UCP |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] | | `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP |
| `--existing-replica-id` | ID of an existing replica in a cluster [$DTR_EXISTING_REPLICA_ID] | | `--existing-replica-id` | ID of an existing replica in a cluster |
| `--config-only` | Backup/restore only the configurations of DTR and not the database [$DTR_CONFIG_ONLY] | | `--config-only` | Backup/restore only the configurations of DTR and not the database |

26
docker-trusted-registry/reference/dumpcerts.md
View File

@ -16,7 +16,7 @@ Dump out the TLS certificates used by this DTR instance
## Usage ## Usage
```bash ```bash
$ docker run -it --rm docker/dtr \ docker run -i --rm docker/dtr \
dumpcerts [command options] > backup.tar dumpcerts [command options] > backup.tar
``` ```
@ -26,14 +26,16 @@ This command creates a backup of the certificates used by DTR for
communicating across replicas with TLS. communicating across replicas with TLS.
| Option | Description | ## Options
|:------------------------|:-------------------------------------------------------------------|
| `--ucp-url ` | Specify the UCP controller URL [$UCP_URL] | | Option | Description |
| `--ucp-username ` | Specify the UCP admin username [$UCP_USERNAME] | |:------------------------|:---------------------------------------------------------|
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] | | `--ucp-url` | Specify the UCP controller URL including domain and port |
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] | | `--ucp-username` | Specify the UCP admin username |
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] | | `--ucp-password` | Specify the UCP admin password |
| `--hub-password ` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] | | `--debug` | Enable debug mode, provides additional logging |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] | | `--hub-username` | Specify the Docker Hub username for pulling images |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] | | `--hub-password` | Specify the Docker Hub password for pulling images |
| `--existing-replica-id` | ID of an existing replica in a cluster [$DTR_EXISTING_REPLICA_ID] | | `--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 |

26
docker-trusted-registry/reference/images.md Normal file
View File

@ -0,0 +1,26 @@
---
menu:
main:
description: Docker Trusted Registry images command reference.
identifier: dtr_reference_images
keywords:
- docker, registry, reference, images
parent: dtr_menu_reference
title: images
---
# docker/dtr images
Lists all the images necessary to install DTR
## Usage
```bash
docker run -it --rm docker/dtr \
images [command options]
```
## Description
This command lists all the images necessary to install DTR.

20
docker-trusted-registry/reference/index.md
View File

@ -10,35 +10,23 @@ menu:
title: Overview title: Overview
--- ---
# docker/dtr image overview # 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.
By default the tool runs in interactive mode. It prompts you for By default the tool runs in interactive mode. It prompts you for
the values needed. the values needed.
For running this tool in non-interactive mode, there are three
ways you can use to pass values:
```bash
$ docker run -it --rm docker/dtr command --option value
$ docker run -e --rm docker/dtr command ENV_VARIABLE=value
$ docker run -e --rm docker/dtr command ENV_VARIABLE
```
Additional help is available for each command with the '--help' option. Additional help is available for each command with the '--help' option.
## Usage ## Usage
```bash ```bash
$ docker run -it --rm docker/dtr \ docker run -it --rm docker/dtr \
command [command options] command [command options]
``` ```
## Options
| Option | Description |
|:------------|:------------|
| `--help, h` | Show help |
## Commands ## Commands
@ -51,4 +39,6 @@ $ docker run -it --rm docker/dtr \
| `restore` | Create a new DTR cluster from an existing backup | | `restore` | Create a new DTR cluster from an existing backup |
| `backup` | Backup a DTR cluster to a tar file and stream it to stdout | | `backup` | Backup a DTR cluster to a tar file and stream it to stdout |
| `migrate` | Migrate configurations, accounts, and repository metadata from DTR 1.4.3 to 2.0 | | `migrate` | Migrate configurations, accounts, and repository metadata from DTR 1.4.3 to 2.0 |
| `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 | | `dumpcerts` | Dump out the TLS certificates used by this DTR instance |
| `images` | Lists all the images necessary to install DTR |

50
docker-trusted-registry/reference/install.md
View File

@ -16,7 +16,7 @@ Install Docker Trusted Registry on this Docker Engine
## Usage ## Usage
```bash ```bash
$ docker run -it --rm docker/dtr \ docker run -it --rm docker/dtr \
install [command options] install [command options]
``` ```
@ -28,25 +28,29 @@ the 'join' command.
## Options ## Options
| Option | Description | | Option | Description |
|:---------------------------|:-------------------------------------------------------------------------------------------------| |:----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--ucp-url` | Specify the UCP controller URL [$UCP_URL] | | `--ucp-url` | Specify the UCP controller URL including domain and port |
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] | | `--ucp-username` | Specify the UCP admin username |
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] | | `--ucp-password` | Specify the UCP admin password |
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] | | `--debug` | Enable debug mode, provides additional logging |
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] | | `--hub-username` | Specify the Docker Hub username for pulling images |
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] | | `--hub-password` | Specify the Docker Hub password for pulling images |
| `--http-proxy` | Set the HTTP proxy for outgoing requests [$DTR_HTTP_PROXY] | | `--http-proxy` | Set the HTTP proxy for outgoing requests |
| `--https-proxy` | Set the HTTPS proxy for outgoing requests [$DTR_HTTPS_PROXY] | | `--https-proxy` | Set the HTTPS proxy for outgoing requests |
| `--no-proxy` | Set the list of domains to not proxy to [$DTR_NO_PROXY] | | `--no-proxy` | Set the list of domains to not proxy to |
| `--replica-http-port "0"` | Specify the public HTTP port for the DTR replica [$REPLICA_HTTP_PORT] | | `--replica-http-port` | Specify the public HTTP port for the DTR replica; 0 means unchanged/default |
| `--replica-https-port "0"` | Specify the public HTTPS port for the DTR replica [$REPLICA_HTTPS_PORT] | | `--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, udp or internal. Default: internal [$LOG_PROTOCOL] | | `--log-protocol` | The protocol for sending container logs: tcp, udp or internal. Default: internal |
| `--log-host` | Endpoint to send logs to, required if --log-protocol is tcp or udp [$LOG_HOST] | | `--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` | Log level for container logs. Default: INFO |
| `--dtr-external-url` | Specify the domain name and port for the DTR load balancer [$DTR_LOAD_BALANCER] | | `--dtr-external-url` | Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead. |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] | | `--etcd-heartbeat-interval` | Set etcd's frequency (ms) that its leader will notify followers that it is still the leader. |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] | | `--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. |
| `--ucp-node` | Specify the host to install Docker Trusted Registry [$UCP_NODE] | | `--etcd-snapshot-count` | Set etcd's number of changes before creating a snapshot. |
| `--replica-id` | Specify the replica Id. Must be unique per replica, leave blank for random [$DTR_REPLICA_ID] | | `--ucp-insecure-tls` | Disable TLS verification for UCP |
| `--unsafe` | Enable this flag to skip safety checks when installing or joining [$DTR_UNSAFE] | | `--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 |
| `--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 |

43
docker-trusted-registry/reference/join.md
View File

@ -13,13 +13,6 @@ title: join
Add a new replica to an existing DTR cluster Add a new replica to an existing DTR cluster
## Usage
```bash
$ docker run -it --rm docker/dtr \
join [command options]
```
## Description ## Description
This command installs DTR on the Docker Engine that runs the command, This command installs DTR on the Docker Engine that runs the command,
@ -28,21 +21,23 @@ and joins the new installation to an existing cluster.
To set up a cluster with high-availability, add 3, 5, or 7 nodes to To set up a cluster with high-availability, add 3, 5, or 7 nodes to
the cluster. the cluster.
## Options
| Option | Description | | Option | Description |
|:---------------------------|:---------------------------------------------------------------------------------------------| |:------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--ucp-url` | Specify the UCP controller URL [$UCP_URL] | | `--ucp-url` | Specify the UCP controller URL including domain and port |
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] | | `--ucp-username` | Specify the UCP admin username |
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] | | `--ucp-password` | Specify the UCP admin password |
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] | | `--debug` | Enable debug mode, provides additional logging |
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] | | `--hub-username` | Specify the Docker Hub username for pulling images |
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] | | `--hub-password` | Specify the Docker Hub password for pulling images |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] | | `--ucp-insecure-tls` | Disable TLS verification for UCP |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] | | `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP |
| `--ucp-node` | Specify the host to install Docker Trusted Registry [$UCP_NODE] | | `--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 [$DTR_REPLICA_ID] | | `--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 [$DTR_UNSAFE] | | `--unsafe` | Enable this flag to skip safety checks when installing or joining |
| `--existing-replica-id` | ID of an existing replica in a cluster [$DTR_EXISTING_REPLICA_ID] | | `--existing-replica-id` | ID of an existing replica in a cluster |
| `--replica-http-port "0"` | Specify the public HTTP port for the DTR replica [$REPLICA_HTTP_PORT] | | `--replica-http-port` | Specify the public HTTP port for the DTR replica; 0 means unchanged/default |
| `--replica-https-port "0"` | Specify the public HTTPS port for the DTR replica [$REPLICA_HTTPS_PORT] | | `--replica-https-port` | Specify the public HTTPS port for the DTR replica; 0 means unchanged/default |
| `--skip-network-test` | Whether to skip the overlay networking test or not [$DTR_SKIP_NETWORK_TEST] | | `--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 |

38
docker-trusted-registry/reference/migrate.md
View File

@ -16,7 +16,7 @@ Migrate configurations, accounts, and repository metadata from DTR 1.4.3 to 2.0
## Usage ## Usage
```bash ```bash
$ docker run -it --rm docker/dtr \ docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock docker/dtr \
migrate [command options] migrate [command options]
``` ```
@ -31,20 +31,22 @@ migrate the data to the new installation. Finally, you decommission your
DTR 1.4.3 by uninstalling it. DTR 1.4.3 by uninstalling it.
| Option | Description | ## Options
|:-----------------------|:-------------------------------------------------------------------------------------|
| `--ucp-url ` | Specify the UCP controller URL [$UCP_URL] | | Option | Description |
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] | |:-----------------------|:-----------------------------------------------------------------------------------------------------------|
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] | | `--ucp-url` | Specify the UCP controller URL including domain and port |
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] | | `--ucp-username` | Specify the UCP admin username |
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] | | `--ucp-password` | Specify the UCP admin password |
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] | | `--debug` | Enable debug mode, provides additional logging |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] | | `--hub-username` | Specify the Docker Hub username for pulling images |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] | | `--hub-password` | Specify the Docker Hub password for pulling images |
| `--run-full-migration` | Run full migration procedure instead of dumping configurations [$RUN_FULL_MIGRATION] | | `--ucp-insecure-tls` | Disable TLS verification for UCP |
| `--dtr-load-balancer` | Specify the domain name and port for the DTR load balancer [$DTR_LOAD_BALANCER] | | `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP |
| `--dtr-insecure-tls` | Disable TLS verification for DTR [$DTR_INSECURE_TLS] | | `--run-full-migration` | Run full migration procedure instead of dumping configurations |
| `--dtr-ca` | PEM-encoded TLS CA cert for DTR [$DTR_CA] | | `--dtr-external-url` | Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead. |
| `--http-proxy` | Set the HTTP proxy for outgoing requests [$DTR_HTTP_PROXY] | | `--dtr-insecure-tls` | Disable TLS verification for DTR |
| `--https-proxy` | Set the HTTPS proxy for outgoing requests [$DTR_HTTPS_PROXY] | | `--dtr-ca` | PEM-encoded TLS CA cert for DTR |
| `--no-proxy` | Set the list of domains to not proxy to [$DTR_NO_PROXY] | | `--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 |

50
docker-trusted-registry/reference/reconfigure.md
View File

@ -13,11 +13,11 @@ title: reconfigure
Change DTR configurations Change DTR configurations
# Usage ## Usage
```bash ```bash
$ docker run -it --rm docker/dtr \ docker run -it --rm docker/dtr \
reconfigure [command options] reconfigure [command options]
``` ```
## Description ## Description
@ -28,24 +28,28 @@ existing configurations in its original state.
WARNING: DTR is restarted for the new configurations to take WARNING: DTR is restarted for the new configurations to take
effect. To have no down time, configure your DTR for high-availability. effect. To have no down time, configure your DTR for high-availability.
## Options
| Option | Description | | Option | Description |
|:---------------------------|:-------------------------------------------------------------------------------------------------| |:----------------------------|:------------------------------------------------------------------------------------------------------------------------------------|
| `--ucp-url` | Specify the UCP controller URL [$UCP_URL] | | `--ucp-url` | Specify the UCP controller URL including domain and port |
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] | | `--ucp-username` | Specify the UCP admin username |
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] | | `--ucp-password` | Specify the UCP admin password |
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] | | `--debug` | Enable debug mode, provides additional logging |
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] | | `--hub-username` | Specify the Docker Hub username for pulling images |
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] | | `--hub-password` | Specify the Docker Hub password for pulling images |
| `--http-proxy` | Set the HTTP proxy for outgoing requests [$DTR_HTTP_PROXY] | | `--http-proxy` | Set the HTTP proxy for outgoing requests |
| `--https-proxy` | Set the HTTPS proxy for outgoing requests [$DTR_HTTPS_PROXY] | | `--https-proxy` | Set the HTTPS proxy for outgoing requests |
| `--no-proxy` | Set the list of domains to not proxy to [$DTR_NO_PROXY] | | `--no-proxy` | Set the list of domains to not proxy to |
| `--replica-http-port "0"` | Specify the public HTTP port for the DTR replica [$REPLICA_HTTP_PORT] | | `--replica-http-port` | Specify the public HTTP port for the DTR replica; 0 means unchanged/default |
| `--replica-https-port "0"` | Specify the public HTTPS port for the DTR replica [$REPLICA_HTTPS_PORT] | | `--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, udp or internal. Default: internal [$LOG_PROTOCOL] | | `--log-protocol` | The protocol for sending container logs: tcp, udp or internal. Default: internal |
| `--log-host` | Endpoint to send logs to, required if --log-protocol is tcp or udp [$LOG_HOST] | | `--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` | Log level for container logs. Default: INFO |
| `--dtr-load-balancer` | Specify the domain name and port for the DTR load balancer [$DTR_LOAD_BALANCER] | | `--dtr-external-url` | Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead. |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] | | `--etcd-heartbeat-interval` | Set etcd's frequency (ms) that its leader will notify followers that it is still the leader. |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] | | `--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. |
| `--existing-replica-id` | ID of an existing replica in a cluster [$DTR_EXISTING_REPLICA_ID] | | `--etcd-snapshot-count` | Set etcd's number of changes before creating a snapshot. |
| `--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 |

33
docker-trusted-registry/reference/remove.md
View File

@ -16,8 +16,8 @@ Remove a replica from a DTR cluster
## Usage ## Usage
```bash ```bash
$ docker run -it --rm docker/dtr \ docker run -it --rm docker/dtr \
remove [command options] remove [command options]
``` ```
## Description ## Description
@ -25,17 +25,18 @@ $ docker run -it --rm docker/dtr \
This command removes a replica from the cluster, stops and removes all This command removes a replica from the cluster, stops and removes all
DTR containers, and deletes all DTR volumes. DTR containers, and deletes all DTR volumes.
| Option | Description | ## Options
|:------------------------|:---------------------------------------------------------------------------------------------|
| `--ucp-url` | Specify the UCP controller URL [$UCP_URL] | | Option | Description |
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] | |:------------------------|:-------------------------------------------------------------------------------------------------------------------------------|
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] | | `--ucp-url` | Specify the UCP controller URL including domain and port |
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] | | `--ucp-username` | Specify the UCP admin username |
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] | | `--ucp-password` | Specify the UCP admin password |
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] | | `--debug` | Enable debug mode, provides additional logging |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] | | `--hub-username` | Specify the Docker Hub username for pulling images |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] | | `--hub-password` | Specify the Docker Hub password for pulling images |
| `--ucp-node` | Specify the host to install Docker Trusted Registry [$UCP_NODE] | | `--ucp-insecure-tls` | Disable TLS verification for UCP |
| `--force-remove` | Force removal of replica even if it will break your cluster's state [$DTR_CONFIG_ONLY] | | `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP |
| `--replica-id` | Specify the replica Id. Must be unique per replica, leave blank for random [$DTR_REPLICA_ID] | | `--force-remove` | Force removal of replica even if it can break your cluster's state. Necessary only when --existing-replica-id == --replica-id. |
| `--existing-replica-id` | ID of an existing replica in a cluster [$DTR_EXISTING_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 |

53
docker-trusted-registry/reference/restore.md
View File

@ -16,8 +16,8 @@ Create a new DTR cluster from an existing backup
## Usage ## Usage
```bash ```bash
$ docker run -i --rm docker/dtr \ docker run -i --rm docker/dtr \
restore [command options] < backup.tar restore [command options] < backup.tar
``` ```
## Description ## Description
@ -37,25 +37,30 @@ After restoring DTR, you can add more nodes to the DTR cluster with
the 'join' command. the 'join' command.
| Option | Description | ## Options
|:---------------------------|:-------------------------------------------------------------------------------------------------|
| `--ucp-url` | Specify the UCP controller URL [$UCP_URL] | | Option | Description |
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] | |:----------------------------|:------------------------------------------------------------------------------------------------------------------------------------|
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] | | `--ucp-url` | Specify the UCP controller URL including domain and port |
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] | | `--ucp-username` | Specify the UCP admin username |
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] | | `--ucp-password` | Specify the UCP admin password |
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] | | `--debug` | Enable debug mode, provides additional logging |
| `--http-proxy` | Set the HTTP proxy for outgoing requests [$DTR_HTTP_PROXY] | | `--hub-username` | Specify the Docker Hub username for pulling images |
| `--https-proxy` | Set the HTTPS proxy for outgoing requests [$DTR_HTTPS_PROXY] | | `--hub-password` | Specify the Docker Hub password for pulling images |
| `--no-proxy` | Set the list of domains to not proxy to [$DTR_NO_PROXY] | | `--http-proxy` | Set the HTTP proxy for outgoing requests |
| `--replica-http-port "0"` | Specify the public HTTP port for the DTR replica [$REPLICA_HTTP_PORT] | | `--https-proxy` | Set the HTTPS proxy for outgoing requests |
| `--replica-https-port "0"` | Specify the public HTTPS port for the DTR replica [$REPLICA_HTTPS_PORT] | | `--no-proxy` | Set the list of domains to not proxy to |
| `--log-protocol` | The protocol for sending container logs: tcp, udp or internal. Default: internal [$LOG_PROTOCOL] | | `--replica-http-port` | Specify the public HTTP port for the DTR replica; 0 means unchanged/default |
| `--log-host` | Endpoint to send logs to, required if --log-protocol is tcp or udp [$LOG_HOST] | | `--replica-https-port` | Specify the public HTTPS port for the DTR replica; 0 means unchanged/default |
| `--log-level` | Log level for container logs. Default: INFO [$LOG_LEVEL] | | `--log-protocol` | The protocol for sending container logs: tcp, udp or internal. Default: internal |
| `--dtr-load-balancer` | Specify the domain name and port for the DTR load balancer [$DTR_LOAD_BALANCER] | | `--log-host` | Endpoint to send logs to, required if --log-protocol is tcp or udp |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] | | `--log-level` | Log level for container logs. Default: INFO |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] | | `--dtr-external-url` | Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead. |
| `--ucp-node` | Specify the host to install Docker Trusted Registry [$UCP_NODE] | | `--etcd-heartbeat-interval` | Set etcd's frequency (ms) that its leader will notify followers that it is still the leader. |
| `--replica-id` | Specify the replica Id. Must be unique per replica, leave blank for random [$DTR_REPLICA_ID] | | `--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. |
| `--config-only` | Backup/restore only the configurations of DTR and not the database [$DTR_CONFIG_ONLY] | | `--etcd-snapshot-count` | Set etcd's number of changes before creating a snapshot. |
| `--ucp-insecure-tls` | Disable TLS verification for UCP |
| `--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 |

54
docker-trusted-registry/reference/upgrade.md Normal file
View File

@ -0,0 +1,54 @@
---
description: Docker Trusted Registry upgrade command reference.
keywords:
- docker, registry, restore, upgrade
menu:
main:
identifier: dtr_reference_upgrade
parent: dtr_menu_reference
title: upgrade
---
# docker/dtr upgrade
Upgrade a v2.0.0 or later cluster to this version of DTR
## Usage
```bash
docker run -it --rm docker/dtr \
upgrade [command options]
```
## Description
This command upgrades an existing DTR 2.0.0 or later cluster to the current version of
this bootstrapper.
## 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, 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 |
| `--dtr-external-url` | Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead. |
| `--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-ca` | Use a PEM-encoded TLS CA certificate for UCP |
| `--existing-replica-id` | ID of an existing replica in a cluster |