Update DTR reference docs

This commit is contained in:
Joao Fernandes 2017-02-07 19:13:08 -08:00
parent ae7ada9ee3
commit a55e8c8e9c
8 changed files with 26 additions and 23 deletions

View File

@ -25,7 +25,7 @@ $(function () {
clientId: "your-client-id",
clientSecret: "your-client-secret",
realm: "your-realms",
appName: "your-app-name",
appName: "your-app-name",
scopeSeparator: ","
});
}

View File

@ -16,14 +16,14 @@ docker run -it --rm docker/dtr \
## Description
This command cleans up any data associated with a replica. It is useful for cleaning up garbage in case of failures or to uninstall DTR. For scaling down a cluster see the remove command.
This command forcefully removes all containers and volumes associated with the given DTR replica without notifying the rest of the cluster. Use it on all replicas when you want to uninstall DTR.
## Options
| Option | Description |
|:--------------------------|:---------------------------|
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random|
|`--replica-id`|The ID of the replica to destroy|
|`--ucp-url`|The UCP URL including domain and port|
|`--ucp-username`|The UCP administrator username|
|`--ucp-password`|The UCP administrator password|

View File

@ -22,14 +22,16 @@ docker run -it --rm docker/dtr \
## Commands
| Option | Description |
|:--------------|:---------------------------------------------------|
| `backup` | Create a backup of DTR |
| `destroy` | Destroy a DTR replica's data |
| `images` | List all the images necessary to install DTR |
| `install` | Install Docker Trusted Registry |
| `join` | Add a new replica to an existing DTR cluster |
| `reconfigure` | Change DTR configurations |
| `remove` | Remove a DTR replica from a cluster |
| `restore` | Install and restore DTR from an existing backup |
| `upgrade` | Upgrade DTR 2.0.0 or later cluster to this version |
| 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 from a cluster|
|`destroy`| Destroy a DTR replica's data|
|`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|

View File

@ -24,7 +24,7 @@ command.
Example usage:
$ docker run -it --rm docker/dtr:2.2.0-tp2 install \
$ docker run -it --rm docker/dtr:2.2.0 install \
--ucp-node <UCP_NODE_HOSTNAME> \
--ucp-insecure-tls
@ -57,9 +57,9 @@ Note: We recommend --ucp-ca "$(cat ca.pem)" instead of --ucp-insecure-tls for a
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-node`|The hostname of the node to install DTR|
|`--ucp-node`|The hostname of the target UCP node. Set to empty string or "_random_" to pick one at random.|
|`--ucp-password`|The UCP administrator password|
|`--ucp-url`|The UCP URL including domain and port|
|`--ucp-username`|The UCP administrator username|
|`--unsafe`|Allow DTR to be installed on a UCP manager node|
|`--unsafe`|Allow DTR to be installed on any engine version|

View File

@ -32,10 +32,10 @@ For setting DTR for high-availability, create 3, 5, or 7 replicas of DTR.
|`--skip-network-test`|Don't test if overlay networks are working correctly between UCP nodes|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-node`|The hostname of the node to install DTR|
|`--ucp-node`|The hostname of the target UCP node. Set to empty string or "_random_" to pick one at random.|
|`--ucp-password`|The UCP administrator password|
|`--ucp-url`|The UCP URL including domain and port|
|`--ucp-username`|The UCP administrator username|
|`--unsafe`|Allow DTR to be installed on a UCP manager node|
|`--unsafe`|Allow DTR to be installed on any engine version|
|`--unsafe-join`|Perform the join despite the cluster containing unhealthy replicas.|

View File

@ -16,8 +16,7 @@ docker run -it --rm docker/dtr \
## Description
This command removes a replica from a DTR deployment. All DTR containers and
volumes are removed from the node.
This command gracefully scales down your DTR cluster by removing exactly one replica. All other replicas must be healthy and will remain healthy after this operation.
## Options
@ -28,7 +27,7 @@ volumes are removed from the node.
|`--existing-replica-id`|The ID of an existing DTR replica|
|`--hub-password`|Password to use when pulling images|
|`--hub-username`|Username to use when pulling images|
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random|
|`--replica-id`|The ID of the replica you want to remove from the cluster|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-password`|The UCP administrator password|

View File

@ -38,6 +38,7 @@ After restoring, you can add more DTR replicas by using the the 'join' command.
|`--dtr-key`|Use a PEM-encoded TLS private key for DTR. If not provided, one will be generated at install time.|
|`--dtr-storage-volume`|Full path or volume name to store Docker images in the local filesystem|
|`--enable-pprof`|Enables pprof profiling of the server|
|`--extra-envs`|Environment variables or swarm constraints for DTR containers. Format var=val[&var=val]|
|`--http-proxy`|The HTTP proxy used for outgoing requests|
|`--https-proxy`|The HTTPS proxy used for outgoing requests|
|`--hub-password`|Password to use when pulling images|
@ -52,7 +53,7 @@ After restoring, you can add more DTR replicas by using the the 'join' command.
|`--replica-id`|Assign an ID to the DTR replica. By default the ID is random|
|`--ucp-ca`|Use a PEM-encoded TLS CA certificate for UCP|
|`--ucp-insecure-tls`|Disable TLS verification for UCP|
|`--ucp-node`|The hostname of the node to install DTR|
|`--ucp-node`|The hostname of the target UCP node. Set to empty string or "_random_" to pick one at random.|
|`--ucp-password`|The UCP administrator password|
|`--ucp-url`|The UCP URL including domain and port|
|`--ucp-username`|The UCP administrator username|

View File

@ -32,4 +32,5 @@ This command upgrades DTR 2.0.0 or later to the current version of this image.
|`--ucp-password`|The UCP administrator password|
|`--ucp-url`|The UCP URL including domain and port|
|`--ucp-username`|The UCP administrator username|
|`--unsafe-upgrade`|Perform the upgrade ignoring version checks.|