Merge pull request docker#7713 from docker/backport-fixes

Remove redundant API and CLI directories

Author: JustinINevill

datacenter/dtr/2.5/reference/api/main.js

@@ -16,34 +16,38 @@ docker run -i --rm docker/dtr \
 ## Description
 
 
-This command creates a tar file with the contents of the volumes used by
-DTR, and prints it. You can then use the 'restore' command to restore the data
-from an existing backup.
+This command creates a `tar` file with the contents of the volumes used by
+DTR, and prints it. You can then use `docker/dtr restore` to restore the data
+from an existing backup. 
 
 Note:
 
   * This command only creates backups of configurations, and image metadata.
-    It doesn't backup users and organizations. Users and organizations can be
-    backed up when performing a UCP backup.
+    It does not back up users and organizations. Users and organizations can be
+    backed up during a UCP backup.
 
-    It also doesn't backup the Docker images stored in your registry.
+    It also doesn't back up Docker images stored in your registry.
     You should implement a separate backup policy for the Docker images stored
-    in your registry, taking in consideration whether your DTR installation is
-    configured to store images on the filesystem or using a cloud provider.
+    in your registry, taking into consideration whether your DTR installation is
+    configured to store images on the filesystem or is using a cloud provider.
 
   * This backup contains sensitive information and should be
     stored securely.
 
+  * Using the `--offline-backup` flag temporarily shuts down the RethinkDB container. 
+    Take the replica out of your load balancer to avoid downtime.
+
 
 ## Options
 
 | Option                        | Environment Variable      | Description                                                                          |
 |:------------------------------|:--------------------------|:-------------------------------------------------------------------------------------|
 | `--debug` | $DEBUG | Enable debug mode for additional logs. |
-| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing  healthy replica's database.. |
+| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica. To add, remove or modify a DTR replica, you must connect to an existing healthy replica's database. |
 | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. |
-| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https://<ucp-url>/ca, and  use --ucp-ca "$(cat ca.pem)". |
-| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP.The installation uses TLS but always trusts  the TLS certificate used by UCP, which can lead to man-in-the-middle attacks.  For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
+| `--offline-backup` | $DTR_OFFLINE_BACKUP | This flag takes RethinkDB down during backup and takes a more reliable backup. If you back up DTR with this flag, RethinkDB will go down during backup. However, offline backups are guaranteed to be more consistent than online backups. |
+| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP. Download the UCP TLS CA certificate from `https://<ucp-url>/ca`, and  use `--ucp-ca "$(cat ca.pem)"`. |
+| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP. The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to MITM (man-in-the-middle) attacks.  For production deployments, use `--ucp-ca "$(cat ca.pem)"` instead. |
 | `--ucp-password` | $UCP_PASSWORD | The UCP administrator password. |
 | `--ucp-url` | $UCP_URL | The UCP URL including domain and port. |
 | `--ucp-username` | $UCP_USERNAME | The UCP administrator username. |

datacenter/dtr/2.5/reference/cli/backup.md

@@ -26,14 +26,14 @@ There are three steps you can take to recover an unhealthy DTR cluster:
 2. If the majority of replicas are unhealthy, use this command to revert your
    cluster to a single DTR replica.
 3. If you can't repair your cluster to a single replica, you'll have to
-   restore from an existing backup, using the 'restore' command.
+   restore from an existing backup, using the `restore` command.
 
 When you run this command, a DTR replica of your choice is repaired and
 turned into the only replica in the whole DTR cluster.
 The containers for all the other DTR replicas are stopped and removed. When
-using the 'force' option, the volumes for these replicas are also deleted.
+using the `force` option, the volumes for these replicas are also deleted.
 
-After repairing the cluster, you should use the 'join' command to add more
+After repairing the cluster, you should use the `join` command to add more
 DTR replicas for high availability.
 
 
@@ -42,12 +42,12 @@ DTR replicas for high availability.
 | Option                        | Environment Variable      | Description                                                                          |
 |:------------------------------|:--------------------------|:-------------------------------------------------------------------------------------|
 | `--debug` | $DEBUG | Enable debug mode for additional logs. |
-| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing  healthy replica's database.. |
+| `--existing-replica-id` | $DTR_REPLICA_ID | The ID of an existing DTR replica. To add, remove or modify DTR, you must connect to an existing healthy replica's database. |
 | `--help-extended` | $DTR_EXTENDED_HELP | Display extended help text for a given command. |
-| `--overlay-subnet` | $DTR_OVERLAY_SUBNET | The subnet used by the dtr-ol overlay network. Example: 10.0.0.0/24.For high-availalibity, DTR creates an overlay network between UCP nodes. This flag  allows you to choose the subnet for that network. Make sure the subnet you choose is not  used on any machine where DTR replicas are deployed. |
-| `--prune` | $PRUNE | Delete the data volumes of all unhealthy replicas.With this option, the volume of the DTR replica you're restoring    is preserved but the volumes for all other replicas are deleted. This has the same    result as completely uninstalling DTR from those replicas.. |
-| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https://<ucp-url>/ca, and  use --ucp-ca "$(cat ca.pem)". |
-| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP.The installation uses TLS but always trusts  the TLS certificate used by UCP, which can lead to man-in-the-middle attacks.  For production deployments, use --ucp-ca "$(cat ca.pem)" instead. |
+| `--overlay-subnet` | $DTR_OVERLAY_SUBNET | The subnet used by the dtr-ol overlay network. Example: `10.0.0.0/24`. For high-availability, DTR creates an overlay network between UCP nodes. This flag allows you to choose the subnet for that network. Make sure the subnet you choose is not used on any machine where DTR replicas are deployed. |
+| `--prune` | $PRUNE | Delete the data volumes of all unhealthy replicas. With this option, the volume of the DTR replica you`re restoring is preserved but the volumes for all other replicas are deleted. This has the same result as completely uninstalling DTR from those replicas. |
+| `--ucp-ca` | $UCP_CA | Use a PEM-encoded TLS CA certificate for UCP. Download the UCP TLS CA certificate from https://<ucp-url>/ca, and  use `--ucp-ca "$(cat ca.pem)"`. |
+| `--ucp-insecure-tls` | $UCP_INSECURE_TLS | Disable TLS verification for UCP. The installation uses TLS but always trusts  the TLS certificate used by UCP, which can lead to MITM (man-in-the-middle) attacks. For production deployments, use `--ucp-ca "$(cat ca.pem)"` instead. |
 | `--ucp-password` | $UCP_PASSWORD | The UCP administrator password. |
 | `--ucp-url` | $UCP_URL | The UCP URL including domain and port. |
 | `--ucp-username` | $UCP_USERNAME | The UCP administrator username. |

reference/dtr/2.5/cli/emergency-repair.md renamed to datacenter/dtr/2.5/reference/cli/emergency-repair.md

@@ -19,17 +19,20 @@ docker run -it --rm docker/dtr \
     command [command options]
 ```
 
+If not specified, `docker/dtr` uses the `latest` tag by default. To work with a different version, specify it in the command. For example, `docker run -it --rm docker/dtr:2.5.5`.
+
 
 ## Commands
 
-| Option                                    | Description                |
-|:------------------------------------------|:---------------------------|
-|[install](install)| Install Docker Trusted Registry                 |
-|[join](join)| Add a new replica to an existing DTR cluster                 |
-|[reconfigure](reconfigure)| Change DTR configurations                 |
-|[remove](remove)| Remove a DTR replica from a cluster                 |
-|[destroy](destroy)| Destroy a DTR replica's data                 |
-|[restore](restore)| Install and restore DTR from an existing backup                 |
-|[backup](backup)| Create a backup of DTR                 |
-|[upgrade](upgrade)| Upgrade DTR 2.3.x cluster to this version                 |
-|[images](images)| List all the images necessary to install DTR                 |
+| Option                               | Description                                     |
+|:-------------------------------------|:------------------------------------------------|
+| [install](install)                   | Install Docker Trusted Registry                 |
+| [join](join)                         | Add a new replica to an existing DTR cluster    |
+| [reconfigure](reconfigure)           | Change DTR configurations                       |
+| [remove](remove)                     | Remove a DTR replica from a cluster             |
+| [destroy](destroy)                   | Destroy a DTR replica's data                    |
+| [restore](restore)                   | Install and restore DTR from an existing backup |
+| [backup](backup)                     | Create a backup of DTR                          |
+| [upgrade](upgrade)                   | Upgrade DTR 2.4.x cluster to this version       |
+| [images](images)                     | List all the images necessary to install DTR    |
+| [emergency-repair](emergency-repair) | Recover DTR from loss of quorum                 |