Skip to content

Commit ee30fb9

Browse files
joaofnfernandesjoaofnfernandes
authored
Merge pull request #345 from joaofnfernandes/dtr-reference
Update docker/dtr image reference
2 parents 0888a73 + 77031cb commit ee30fb9

File tree

12 files changed

+260
-172
lines changed

12 files changed

+260
-172
lines changed

‎_data/toc.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -777,6 +777,8 @@ toc:
777777
title: backup
778778
- path: /docker-trusted-registry/reference/dumpcerts/
779779
title: dumpcerts
780+
- path: /docker-trusted-registry/reference/images/
781+
title: images
780782
- path: /docker-trusted-registry/reference/install/
781783
title: install
782784
- path: /docker-trusted-registry/reference/join/
@@ -789,6 +791,8 @@ toc:
789791
title: remove
790792
- path: /docker-trusted-registry/reference/restore/
791793
title: restore
794+
- path: /docker-trusted-registry/reference/upgrade/
795+
title: upgrade
792796
- sectiontitle: Configuration
793797
section:
794798
- path: /docker-trusted-registry/configure/configuration/

‎docker-trusted-registry/reference/backup.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Backup a DTR cluster to a tar file and stream it to stdout
1616
## Usage
1717

1818
```bash
19-
$ docker run -i --rm docker/dtr \
20-
backup [command options] > backup.tar
19+
docker run -i --rm docker/dtr \
20+
backup [command options] > backup.tar
2121
```
2222

2323
## Description
@@ -35,16 +35,17 @@ configured to store images on the filesystem or using a cloud provider.
3535
WARNING: This backup contains sensitive information and should be
3636
stored securely.
3737

38-
39-
| Option | Description |
40-
|:------------------------|:--------------------------------------------------------------------------------------|
41-
| `--ucp-url` | Specify the UCP controller URL [$UCP_URL] |
42-
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] |
43-
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] |
44-
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] |
45-
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] |
46-
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] |
47-
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] |
48-
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] |
49-
| `--existing-replica-id` | ID of an existing replica in a cluster [$DTR_EXISTING_REPLICA_ID] |
50-
| `--config-only` | Backup/restore only the configurations of DTR and not the database [$DTR_CONFIG_ONLY] |
38+
## Options
39+
40+
| Option | Description |
41+
|:------------------------|:-------------------------------------------------------------------|
42+
| `--ucp-url` | Specify the UCP controller URL including domain and port |
43+
| `--ucp-username` | Specify the UCP admin username |
44+
| `--ucp-password` | Specify the UCP admin password |
45+
| `--debug` | Enable debug mode, provides additional logging |
46+
| `--hub-username` | Specify the Docker Hub username for pulling images |
47+
| `--hub-password` | Specify the Docker Hub password for pulling images |
48+
| `--ucp-insecure-tls` | Disable TLS verification for UCP |
49+
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP |
50+
| `--existing-replica-id` | ID of an existing replica in a cluster |
51+
| `--config-only` | Backup/restore only the configurations of DTR and not the database |

‎docker-trusted-registry/reference/dumpcerts.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Dump out the TLS certificates used by this DTR instance
1616
## Usage
1717

1818
```bash
19-
$ docker run -it --rm docker/dtr \
19+
docker run -i --rm docker/dtr \
2020
dumpcerts [command options] > backup.tar
2121
```
2222

@@ -26,14 +26,16 @@ This command creates a backup of the certificates used by DTR for
2626
communicating across replicas with TLS.
2727

2828

29-
| Option | Description |
30-
|:------------------------|:-------------------------------------------------------------------|
31-
| `--ucp-url ` | Specify the UCP controller URL [$UCP_URL] |
32-
| `--ucp-username ` | Specify the UCP admin username [$UCP_USERNAME] |
33-
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] |
34-
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] |
35-
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] |
36-
| `--hub-password ` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] |
37-
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] |
38-
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] |
39-
| `--existing-replica-id` | ID of an existing replica in a cluster [$DTR_EXISTING_REPLICA_ID] |
29+
## Options
30+
31+
| Option | Description |
32+
|:------------------------|:---------------------------------------------------------|
33+
| `--ucp-url` | Specify the UCP controller URL including domain and port |
34+
| `--ucp-username` | Specify the UCP admin username |
35+
| `--ucp-password` | Specify the UCP admin password |
36+
| `--debug` | Enable debug mode, provides additional logging |
37+
| `--hub-username` | Specify the Docker Hub username for pulling images |
38+
| `--hub-password` | Specify the Docker Hub password for pulling images |
39+
| `--ucp-insecure-tls` | Disable TLS verification for UCP |
40+
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP |
41+
| `--existing-replica-id` | ID of an existing replica in a cluster |

‎docker-trusted-registry/reference/images.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
menu:
3+
main:
4+
description: Docker Trusted Registry images command reference.
5+
identifier: dtr_reference_images
6+
keywords:
7+
- docker, registry, reference, images
8+
parent: dtr_menu_reference
9+
title: images
10+
---
11+
12+
# docker/dtr images
13+
14+
Lists all the images necessary to install DTR
15+
16+
## Usage
17+
18+
```bash
19+
docker run -it --rm docker/dtr \
20+
images [command options]
21+
```
22+
23+
## Description
24+
25+
26+
This command lists all the images necessary to install DTR.

‎docker-trusted-registry/reference/index.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,23 @@ menu:
1010
title: Overview
1111
---
1212

13-
# docker/dtr image overview
13+
# docker/dtr overview
1414

1515
This tool has commands to install, configure, and backup Docker
1616
Trusted Registry (DTR). It also allows uninstalling DTR.
1717
By default the tool runs in interactive mode. It prompts you for
1818
the values needed.
19-
For running this tool in non-interactive mode, there are three
20-
ways you can use to pass values:
21-
22-
```bash
23-
$ docker run -it --rm docker/dtr command --option value
24-
$ docker run -e --rm docker/dtr command ENV_VARIABLE=value
25-
$ docker run -e --rm docker/dtr command ENV_VARIABLE
26-
```
2719

2820
Additional help is available for each command with the '--help' option.
2921

22+
3023
## Usage
3124

3225
```bash
33-
$ docker run -it --rm docker/dtr \
26+
docker run -it --rm docker/dtr \
3427
command [command options]
3528
```
3629

37-
## Options
38-
39-
| Option | Description |
40-
|:------------|:------------|
41-
| `--help, h` | Show help |
4230

4331
## Commands
4432

@@ -51,4 +39,6 @@ $ docker run -it --rm docker/dtr \
5139
| `restore` | Create a new DTR cluster from an existing backup |
5240
| `backup` | Backup a DTR cluster to a tar file and stream it to stdout |
5341
| `migrate` | Migrate configurations, accounts, and repository metadata from DTR 1.4.3 to 2.0 |
42+
| `upgrade` | Upgrade a v2.0.0 or later cluster to this version of DTR |
5443
| `dumpcerts` | Dump out the TLS certificates used by this DTR instance |
44+
| `images` | Lists all the images necessary to install DTR |

‎docker-trusted-registry/reference/install.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Install Docker Trusted Registry on this Docker Engine
1616
## Usage
1717

1818
```bash
19-
$ docker run -it --rm docker/dtr \
19+
docker run -it --rm docker/dtr \
2020
install [command options]
2121
```
2222

@@ -28,25 +28,29 @@ the 'join' command.
2828

2929
## Options
3030

31-
| Option | Description |
32-
|:---------------------------|:-------------------------------------------------------------------------------------------------|
33-
| `--ucp-url` | Specify the UCP controller URL [$UCP_URL] |
34-
| `--ucp-username` | Specify the UCP admin username [$UCP_USERNAME] |
35-
| `--ucp-password` | Specify the UCP admin password [$UCP_PASSWORD] |
36-
| `--debug` | Enable debug mode, provides additional logging [$DEBUG] |
37-
| `--hub-username` | Specify the Docker Hub username for pulling images [$HUB_USERNAME] |
38-
| `--hub-password` | Specify the Docker Hub password for pulling images [$HUB_PASSWORD] |
39-
| `--http-proxy` | Set the HTTP proxy for outgoing requests [$DTR_HTTP_PROXY] |
40-
| `--https-proxy` | Set the HTTPS proxy for outgoing requests [$DTR_HTTPS_PROXY] |
41-
| `--no-proxy` | Set the list of domains to not proxy to [$DTR_NO_PROXY] |
42-
| `--replica-http-port "0"` | Specify the public HTTP port for the DTR replica [$REPLICA_HTTP_PORT] |
43-
| `--replica-https-port "0"` | Specify the public HTTPS port for the DTR replica [$REPLICA_HTTPS_PORT] |
44-
| `--log-protocol` | The protocol for sending container logs: tcp, udp or internal. Default: internal [$LOG_PROTOCOL] |
45-
| `--log-host` | Endpoint to send logs to, required if --log-protocol is tcp or udp [$LOG_HOST] |
46-
| `--log-level` | Log level for container logs. Default: INFO [$LOG_LEVEL] |
47-
| `--dtr-external-url` | Specify the domain name and port for the DTR load balancer [$DTR_LOAD_BALANCER] |
48-
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] |
49-
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] |
50-
| `--ucp-node` | Specify the host to install Docker Trusted Registry [$UCP_NODE] |
51-
| `--replica-id` | Specify the replica Id. Must be unique per replica, leave blank for random [$DTR_REPLICA_ID] |
52-
| `--unsafe` | Enable this flag to skip safety checks when installing or joining [$DTR_UNSAFE] |
31+
| Option | Description |
32+
|:----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
33+
| `--ucp-url` | Specify the UCP controller URL including domain and port |
34+
| `--ucp-username` | Specify the UCP admin username |
35+
| `--ucp-password` | Specify the UCP admin password |
36+
| `--debug` | Enable debug mode, provides additional logging |
37+
| `--hub-username` | Specify the Docker Hub username for pulling images |
38+
| `--hub-password` | Specify the Docker Hub password for pulling images |
39+
| `--http-proxy` | Set the HTTP proxy for outgoing requests |
40+
| `--https-proxy` | Set the HTTPS proxy for outgoing requests |
41+
| `--no-proxy` | Set the list of domains to not proxy to |
42+
| `--replica-http-port` | Specify the public HTTP port for the DTR replica; 0 means unchanged/default |
43+
| `--replica-https-port` | Specify the public HTTPS port for the DTR replica; 0 means unchanged/default |
44+
| `--log-protocol` | The protocol for sending container logs: tcp, udp or internal. Default: internal |
45+
| `--log-host` | Endpoint to send logs to, required if --log-protocol is tcp or udp |
46+
| `--log-level` | Log level for container logs. Default: INFO |
47+
| `--dtr-external-url` | Specify the external domain name and port for DTR. If using a load balancer, use its external URL instead. |
48+
| `--etcd-heartbeat-interval` | Set etcd's frequency (ms) that its leader will notify followers that it is still the leader. |
49+
| `--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. |
50+
| `--etcd-snapshot-count` | Set etcd's number of changes before creating a snapshot. |
51+
| `--ucp-insecure-tls` | Disable TLS verification for UCP |
52+
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP |
53+
| `--ucp-node` | Specify the host to install Docker Trusted Registry |
54+
| `--replica-id` | Specify the replica ID. Must be unique per replica, leave blank for random |
55+
| `--unsafe` | Enable this flag to skip safety checks when installing or joining |
56+
| `--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 |

0 commit comments

Comments
 (0)