From 6e51854c1b2b16cedc2a605297cd024ee47c9721 Mon Sep 17 00:00:00 2001 From: Joao Fernandes Date: Wed, 5 Oct 2016 18:00:19 -0700 Subject: [PATCH] Updates CLI and API docs for 2.0 Closes 3085 --- reference/backup.md | 63 ++++++++++++++++++-------------- reference/dumpcerts.md | 36 ++++++++++--------- reference/images.md | 29 +++++++++++++++ reference/index.md | 44 +++++++++-------------- reference/install.md | 76 +++++++++++++++++++++++---------------- reference/join.md | 57 +++++++++++++++-------------- reference/menu.md | 2 +- reference/migrate.md | 3 +- reference/reconfigure.md | 73 +++++++++++++++++++++---------------- reference/remove.md | 48 +++++++++++++------------ reference/restore.md | 78 ++++++++++++++++++++++------------------ reference/upgrade.md | 42 ++++++++++++++++++++++ 12 files changed, 334 insertions(+), 217 deletions(-) create mode 100644 reference/images.md create mode 100644 reference/upgrade.md diff --git a/reference/backup.md b/reference/backup.md index e1181c7015..8f5ca87a37 100644 --- a/reference/backup.md +++ b/reference/backup.md @@ -1,8 +1,8 @@ + +# docker/dtr images + +List 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. + + + diff --git a/reference/index.md b/reference/index.md index 96f9939dba..2371f24bc7 100644 --- a/reference/index.md +++ b/reference/index.md @@ -1,54 +1,44 @@ -# 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 -| Option | Description | -|:--------------|:--------------------------------------------------------------------------------| -| `install` | Install Docker Trusted Registry on this Docker Engine | -| `join` | Add a new replica to an existing DTR cluster | -| `reconfigure` | Change DTR configurations | -| `remove` | Remove a replica from a DTR cluster | -| `restore` | Create a new DTR cluster from an existing backup | -| `backup` | Backup a DTR cluster to a tar file and stream it to stdout | -| `migrate` | Migrate configurations, accounts, and repository metadata from DTR 1.4.3 to 2.0 | -| `dumpcerts` | Dump out the TLS certificates used by this DTR instance | +| Option | Description | +|:-----------------------------|:---------------------------| +|`install`| Install Docker Trusted Registry| +|`join`| Add a new replica to an existing DTR cluster| +|`reconfigure`| Change DTR configurations| +|`remove`| Remove a DTR replica| +|`restore`| Install and restore DTR from an existing backup| +|`backup`| Create a backup of DTR| +|`upgrade`| Upgrade DTR 2.0.0 or later cluster to this version| +|`dumpcerts`| Print the TLS certificates used by DTR| +|`images`| List all the images necessary to install DTR| + diff --git a/reference/install.md b/reference/install.md index c76ba6edb5..8445609103 100644 --- a/reference/install.md +++ b/reference/install.md @@ -1,8 +1,8 @@ + +# docker/dtr upgrade + +Upgrade DTR 2.0.0 or later cluster to this version + +## Usage + +```bash +docker run -it --rm docker/dtr \ + upgrade [command options] +``` + +## Description + + +This command upgrades DTR 2.0.0 or later to the current version of this image. + + +## Options + +| Option | Description | +|:--------------------------|:---------------------------| +|`--ucp-url`|The UCP URL including domain and port| +|`--ucp-username`|The UCP administrator username| +|`--ucp-password`|The UCP administrator password| +|`--debug`|Enable debug mode for additional logging| +|`--hub-username`|Username to use when pulling images| +|`--hub-password`|Password to use when pulling images| +|`--ucp-insecure-tls`|Disable TLS verification for UCP| +|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP| +|`--existing-replica-id`|The ID of an existing DTR replica| +