docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update DTR 2.2 docs

This commit is contained in:
Joao Fernandes 2017-01-09 15:47:55 -08:00
parent ddc5b669f1
commit 323c771372
7 changed files with 49 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
datacenter/dtr/2.2/guides/architecture.md
View File

@ -4,8 +4,6 @@ keywords: docker, registry, dtr, architecture
title: DTR architecture title: DTR architecture
--- ---
<!-- TODO: review page for v2.2 -->
Docker Trusted Registry (DTR) is a Dockerized application that runs on a Docker Docker Trusted Registry (DTR) is a Dockerized application that runs on a Docker
Universal Control Plane cluster. Universal Control Plane cluster.
@ -19,8 +17,9 @@ When you install DTR on a node, the following containers are started:
| Name | Description | | Name | Description |
|:-------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------| |:-------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------|
| dtr-api-&lt;replica_id&gt; | Executes the DTR business logic. It serves the DTR web application, and API | | dtr-api-&lt;replica_id&gt; | Executes the DTR business logic. It serves the DTR web application, and API |
| dtr-etcd-&lt;replica_id&gt; | A key-value store for persisting DTR configuration settings | | dtr-garant-&lt;replica_id&gt; | Manages DTR authentication |
| dtr-jobrunner-&lt;replica_id&gt; | Runs cleanup jobs in the background | | dtr-jobrunner-&lt;replica_id&gt; | Runs cleanup jobs in the background |
| dtr-nautilusstore-&lt;replica_id&gt; | Stores security scanning data |
| dtr-nginx-&lt;replica_id&gt; | Receives http and https requests and proxies them to other DTR components. By default it listens to ports 80 and 443 of the host | | dtr-nginx-&lt;replica_id&gt; | Receives http and https requests and proxies them to other DTR components. By default it listens to ports 80 and 443 of the host |
| dtr-notary-server-&lt;replica_id&gt; | Receives, validates, and serves content trust metadata, and is consulted when pushing or pulling to DTR with content trust enabled | | dtr-notary-server-&lt;replica_id&gt; | Receives, validates, and serves content trust metadata, and is consulted when pushing or pulling to DTR with content trust enabled |
| dtr-notary-signer-&lt;replica_id&gt; | Performs server-side timestamp and snapshot signing for content trust metadata | | dtr-notary-signer-&lt;replica_id&gt; | Performs server-side timestamp and snapshot signing for content trust metadata |
@ -49,6 +48,7 @@ DTR uses these named volumes for persisting data:
| dtr-ca-&lt;replica_id&gt; | Root key material for the DTR root CA that issues certificates | | dtr-ca-&lt;replica_id&gt; | Root key material for the DTR root CA that issues certificates |
| dtr-etcd-&lt;replica_id&gt; | DTR configuration data | | dtr-etcd-&lt;replica_id&gt; | DTR configuration data |
| dtr-notary-&lt;replica_id&gt; | Certificate and keys for the Notary components | | dtr-notary-&lt;replica_id&gt; | Certificate and keys for the Notary components |
| dtr-postgres-&lt;replica_id&gt; | DTR configuration data |
| dtr-registry-&lt;replica_id&gt; | Docker images data, if DTR is configured to store images on the local filesystem | | dtr-registry-&lt;replica_id&gt; | Docker images data, if DTR is configured to store images on the local filesystem |
| dtr-rethink-&lt;replica_id&gt; | Repository metadata | | dtr-rethink-&lt;replica_id&gt; | Repository metadata |
| dtr-nfs-registry-&lt;replica_id&gt; | Docker images data, if DTR is configured to store images on NFS | | dtr-nfs-registry-&lt;replica_id&gt; | Docker images data, if DTR is configured to store images on NFS |

13
datacenter/dtr/2.2/guides/install/index.md
View File

@ -4,8 +4,6 @@ keywords: docker, dtr, registry, install
title: Install Docker Trusted Registry title: Install Docker Trusted Registry
--- ---
<!-- TODO: review page for v2.2 -->
Docker Trusted Registry (DTR) is a containerized application that runs on a Docker Trusted Registry (DTR) is a containerized application that runs on a
swarm managed by Docker Universal Control Plane (UCP). It can be installed swarm managed by Docker Universal Control Plane (UCP). It can be installed
on-premises or on a cloud infrastructure. on-premises or on a cloud infrastructure.
@ -21,7 +19,7 @@ infrastructure has all the [requirements DTR needs to run](system-requirements.m
Since DTR requires Docker Universal Control Plane (UCP) Since DTR requires Docker Universal Control Plane (UCP)
to run, you need to install UCP on all the nodes where you plan to install DTR. to run, you need to install UCP on all the nodes where you plan to install DTR.
[Learn how to install UCP](/datacenter/ucp/2.0/guides/installation/index.md). [Learn how to install UCP](/datacenter/ucp/2.1/guides/installation/index.md).
DTR needs to be installed on a worker node that is being managed by UCP. DTR needs to be installed on a worker node that is being managed by UCP.
You can't install DTR on a standalone Docker Engine. You can't install DTR on a standalone Docker Engine.
@ -38,23 +36,22 @@ Run the following command to install DTR:
```none ```none
# Pull the latest version of DTR # Pull the latest version of DTR
$ docker pull docker/dtr $ docker pull docker/dtr:2.2.0-beta1
# Install DTR # Install DTR
$ docker run -it --rm \ $ docker run -it --rm \
docker/dtr install \ docker/dtr:2.2.0-beta1 install \
--ucp-node <ucp-node-name> \ --ucp-node <ucp-node-name> \
--ucp-insecure-tls --ucp-insecure-tls
``` ```
Where the `--ucp-node` is the hostname of the UCP node where you want to deploy Where the `--ucp-node` is the hostname of the UCP node where you want to deploy
DTR. `--ucp-insecure-tls` tells the installer to trust the certificates used DTR. `--ucp-insecure-tls` tells the installer to trust the TLS certificates used
by UCP. by UCP.
The install command has other flags for customizing DTR at install time. The install command has other flags for customizing DTR at install time.
Check the [reference documentation to learn more](../../reference/cli/install.md). Check the [reference documentation to learn more](../../reference/cli/install.md).
## Step 4. Check that DTR is running ## Step 4. Check that DTR is running
In your browser, navigate to the Docker **Universal Control Plane** In your browser, navigate to the Docker **Universal Control Plane**
@ -113,7 +110,7 @@ To add replicas to a DTR cluster, use the `docker/dtr join` command:
```none ```none
docker run -it --rm \ docker run -it --rm \
docker/dtr join \ docker/dtr:2.2.0-beta1 join \
--ucp-node <ucp-node-name> \ --ucp-node <ucp-node-name> \
--ucp-insecure-tls --ucp-insecure-tls
``` ```

2
datacenter/dtr/2.2/guides/install/license.md
View File

@ -4,8 +4,6 @@ keywords: docker, dtr, install, license
title: License Docker Trusted Registry title: License Docker Trusted Registry
--- ---
<!-- TODO: review page for v2.2 -->
By default, you don't need to license your Docker Trusted Registry. When By default, you don't need to license your Docker Trusted Registry. When
installing DTR, it automatically starts using the same license file used on installing DTR, it automatically starts using the same license file used on
your Docker Universal Control Plane cluster. your Docker Universal Control Plane cluster.

10
datacenter/dtr/2.2/guides/install/scale-your-deployment.md
View File

@ -4,8 +4,6 @@ description: Lean how to scale Docker Trusted Registry by adding and removing re
keywords: docker, dtr, install, deploy keywords: docker, dtr, install, deploy
--- ---
<!-- TODO: review page for v2.2 -->
Docker Trusted Registry is designed to scale horizontally as your usage Docker Trusted Registry is designed to scale horizontally as your usage
increases. You can add or remove replicas to make DTR scale to your needs increases. You can add or remove replicas to make DTR scale to your needs
or for high availability. or for high availability.
@ -22,13 +20,13 @@ you're going to install these replicas also need to be managed by UCP.
To add replicas to an existing DTR deployment: To add replicas to an existing DTR deployment:
1. Use ssh to log into a node that is already part of UCP. 1. Use ssh to log into any node that is already part of UCP.
2. Run the DTR join command: 2. Run the DTR join command:
```none ```none
docker run -it --rm \ docker run -it --rm \
docker/dtr join \ docker/dtr:2.2.0-beta1 join \
--ucp-node <ucp-node-name> \ --ucp-node <ucp-node-name> \
--ucp-insecure-tls --ucp-insecure-tls
``` ```
@ -43,12 +41,12 @@ To add replicas to an existing DTR deployment:
To remove a DTR replica from your deployment: To remove a DTR replica from your deployment:
1. Use ssh to log into a node that is already part of UCP. 1. Use ssh to log into any node that is part of UCP.
2. Run the DTR remove command: 2. Run the DTR remove command:
```none ```none
docker run -it --rm \ docker run -it --rm \
docker/dtr remove \ docker/dtr:2.2.0-beta1 remove \
--ucp-insecure-tls --ucp-insecure-tls
``` ```

5
datacenter/dtr/2.2/guides/install/system-requirements.md
View File

@ -4,16 +4,13 @@ keywords: docker, DTR, architecture, requirements
title: Docker Trusted Registry system requirements title: Docker Trusted Registry system requirements
--- ---
<!-- TODO: review page for v2.2 -->
Docker Trusted Registry can be installed on-premises or on the cloud. Docker Trusted Registry can be installed on-premises or on the cloud.
Before installing, be sure your infrastructure has these requirements. Before installing, be sure your infrastructure has these requirements.
## Software requirements ## Software requirements
You can only install DTR on a node that is being managed by Docker Universal You can only install DTR on a node that is being managed by Docker Universal
Control Plane 2.0. Control Plane 2.1.
## Ports used ## Ports used

33
datacenter/dtr/2.2/guides/install/uninstall.md
View File

@ -4,36 +4,27 @@ keywords: docker, dtr, install, uninstall
title: Uninstall Docker Trusted Registry title: Uninstall Docker Trusted Registry
--- ---
<!-- TODO: review page for v2.2 --> Uninstalling DTR is a two-step process. You first scale your DTR deployment down
to a single replica. Then you uninstall the last DTR replica, which permanently
removes DTR and deletes all its data.
Use the `remove` command, to remove a DTR replica from an existing deployment. Start by [scaling down your DTR deployment](scale-your-deployment.md) to a
To uninstall a DTR cluster you remove all DTR replicas one at a time. single replica.
The remove command informs the DTR cluster that the node is about to be removed, When your DTR deployment is down to a single replica, you can use the
then it removes the replica, stops and removes all DTR containers from that node, `docker/dtr destroy` command to permanently remove DTR and all its data:
and deletes all DTR volumes.
To uninstall a DTR replica, run: 1. Use ssh to log into any node that is part of UCP.
2. Uninstall DTR:
```none ```none
docker run -it --rm \ docker run -it --rm \
docker/dtr remove \ docker/dtr:2.2.0-beta1 destroy \
--ucp-insecure-tls --ucp-insecure-tls
``` ```
You will be prompted for: To see what options are available in the destroy command, check the
[destroy command reference documentation](../../reference/cli/destroy.md).
* Existing replica id: the id of any healthy DTR replica of that cluster
* Replica id: the id of the DTR replica you want to remove. It can be the id of an
unhealthy replica that you want to remove from your deployment
* UCP username and password: the administrator credentials for UCP
To ensure you don't loose data, DTR will not remove the last replica from your
deployment. To confirm you really want to remove that replica, use the
`--force-remove` flag.
To see what options are available in the uninstall command, check the
[uninstall command reference documentation](../../reference/cli/remove.md).
## Where to go next ## Where to go next

55
datacenter/dtr/2.2/guides/install/upgrade.md
View File

@ -4,54 +4,45 @@ keywords: docker, dtr, upgrade, install
title: Upgrade DTR title: Upgrade DTR
--- ---
<!-- TODO: review page for v2.2 --> The first step in upgrading to a new minor version or patch release of DTR 2.2,
is ensuring you're running DTR 2.1. If that's not the case, start by upgrading
your installation to version 2.1, and then upgrade to 2.2.
The first step in upgrading to a new minor version or patch release of DTR 2.0, There is no downtime when upgrading a highly-available DTR cluster. If your
is ensuring you're running DTR 2.0. If that's not the case, start by upgrading
your installation to version 2.0.0, and then upgrade to the latest version
available.
There is no downtime when upgrading an highly-available DTR cluster. If your
DTR deployment has a single replica, schedule the upgrade to take place outside DTR deployment has a single replica, schedule the upgrade to take place outside
business peak hours to ensure the impact on your business is close to none. business peak hours to ensure the impact on your business is close to none.
## Step 1. Upgrade DTR to 2.0 ## Step 1. Upgrade DTR to 2.1
Make sure you're running DTR 2.0. If that's not the case, [upgrade your Make sure you're running DTR 2.1. If that's not the case, [upgrade your
installation to the 2.0 version](/datacenter/dtr/2.0/install/upgrade/upgrade-major.md). installation to the 2.1 version](/datacenter/dtr/2.1/install/upgrade/upgrade.md).
## Step 2. Upgrade DTR ## Step 2. Upgrade DTR
To upgrade DTR you use the `upgrade` command.
1. Download a UCP client bundle.
Having a UCP client bundle allows you to run Docker commands on a UCP To upgrade DTR, **login with ssh** into a node that's part of the UCP cluster.
cluster. Download a UCP client bundle and set up your CLI client to use it. Then pull the latest version of DTR:
2. Pull the latest `docker/dtr` image. ```none
$ docker pull docker/dtr:2.2.0-beta1
```
```bash If the node you're upgrading doesn't have access to the internet, you can
$ docker pull docker/dtr:<version> use a machine with internet connection to
``` [pull all the DTR images](install-offline.md).
If the node you're upgrading doesn't have access to the internet, you can Once you have the latest images on the node, run the upgrade command:
use a machine with internet connection to
[pull all the DTR images](install-offline.md).
4. Run the upgrade command. ```none
$ docker run -it --rm \
The upgrade command upgrades all DTR replicas that are part of your cluster: docker/dtr:2.2.0-beta1 upgrade \
```bash
$ docker run -it --rm \
docker/dtr:<version> upgrade \
--ucp-insecure-tls --ucp-insecure-tls
``` ```
By default the upgrade command runs in interactive mode and prompts you for By default the upgrade command runs in interactive mode and prompts you for
any necessary information. You can also check the any necessary information. You can also check the
[reference documentation](../../reference/cli/index.md) for other existing flags. [reference documentation](../../reference/cli/index.md) for other existing flags.
## Where to go next ## Where to go next