Skip to content

Update docker/dtr image reference #345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 25, 2016
Merged

Update docker/dtr image reference #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _data/toc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,8 @@ toc:
title: backup
- path: /docker-trusted-registry/reference/dumpcerts/
title: dumpcerts
- path: /docker-trusted-registry/reference/images/
title: images
- path: /docker-trusted-registry/reference/install/
title: install
- path: /docker-trusted-registry/reference/join/
Expand All @@ -789,6 +791,8 @@ toc:
title: remove
- path: /docker-trusted-registry/reference/restore/
title: restore
- path: /docker-trusted-registry/reference/upgrade/
title: upgrade
- sectiontitle: Configuration
section:
- path: /docker-trusted-registry/configure/configuration/
Expand Down
31 changes: 16 additions & 15 deletions docker-trusted-registry/reference/backup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Backup a DTR cluster to a tar file and stream it to stdout
## Usage

```bash
$ docker run -i --rm docker/dtr \
backup [command options] > backup.tar
docker run -i --rm docker/dtr \
backup [command options] > backup.tar
```

## Description
Expand All @@ -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
stored securely.


| 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] |
| `--existing-replica-id` | ID of an existing replica in a cluster [$DTR_EXISTING_REPLICA_ID] |
| `--config-only` | Backup/restore only the configurations of DTR and not the database [$DTR_CONFIG_ONLY] |
## 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 |
| `--config-only` | Backup/restore only the configurations of DTR and not the database |
26 changes: 14 additions & 12 deletions docker-trusted-registry/reference/dumpcerts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Dump out the TLS certificates used by this DTR instance
## Usage

```bash
$ docker run -it --rm docker/dtr \
docker run -i --rm docker/dtr \
dumpcerts [command options] > backup.tar
```

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


| 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] |
| `--existing-replica-id` | ID of an existing replica in a cluster [$DTR_EXISTING_REPLICA_ID] |
## 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 |
26 changes: 26 additions & 0 deletions docker-trusted-registry/reference/images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 changes: 5 additions & 15 deletions docker-trusted-registry/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,23 @@ menu:
title: Overview
---

# docker/dtr image overview
# docker/dtr overview

This tool has commands to install, configure, and backup Docker
Trusted Registry (DTR). It also allows uninstalling DTR.
By default the tool runs in interactive mode. It prompts you for
the values needed.
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.


## Usage

```bash
$ docker run -it --rm docker/dtr \
docker run -it --rm docker/dtr \
command [command options]
```

## Options

| Option | Description |
|:------------|:------------|
| `--help, h` | Show help |

## Commands

Expand All @@ -51,4 +39,6 @@ $ docker run -it --rm docker/dtr \
| `restore` | Create a new DTR cluster from an existing backup |
| `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 |
| `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 |
50 changes: 27 additions & 23 deletions docker-trusted-registry/reference/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Install Docker Trusted Registry on this Docker Engine
## Usage

```bash
$ docker run -it --rm docker/dtr \
docker run -it --rm docker/dtr \
install [command options]
```

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

## Options

| 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] |
| `--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] |
| `--replica-http-port "0"` | Specify the public HTTP port for the DTR replica [$REPLICA_HTTP_PORT] |
| `--replica-https-port "0"` | Specify the public HTTPS port for the DTR replica [$REPLICA_HTTPS_PORT] |
| `--log-protocol` | The protocol for sending container logs: tcp, udp or internal. Default: internal [$LOG_PROTOCOL] |
| `--log-host` | Endpoint to send logs to, required if --log-protocol is tcp or udp [$LOG_HOST] |
| `--log-level` | Log level for container logs. Default: INFO [$LOG_LEVEL] |
| `--dtr-external-url` | Specify the domain name and port for the DTR load balancer [$DTR_LOAD_BALANCER] |
| `--ucp-insecure-tls` | Disable TLS verification for UCP [$UCP_INSECURE_TLS] |
| `--ucp-ca` | Use a PEM-encoded TLS CA certificate for UCP [$UCP_CA] |
| `--ucp-node` | Specify the host to install Docker Trusted Registry [$UCP_NODE] |
| `--replica-id` | Specify the replica Id. Must be unique per replica, leave blank for random [$DTR_REPLICA_ID] |
| `--unsafe` | Enable this flag to skip safety checks when installing or joining [$DTR_UNSAFE] |
| 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 |
| `--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 |
Loading