Skip to content

Commit 72bfc24

Browse files
Jim GalasynJoao Fernandes
Jim Galasyn
authored and
Joao Fernandes
committed
Port DTR disaster topics to template (docker#399)
1 parent 119cf96 commit 72bfc24

File tree

5 files changed

+46
-13
lines changed

5 files changed

+46
-13
lines changed

datacenter/dtr/2.5/guides/admin/disaster-recovery/create-a-backup.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22
title: Create a backup
33
description: Learn how to create a backup of Docker Trusted Registry, for disaster recovery.
44
keywords: dtr, disaster recovery
5+
ui_tabs:
6+
- version: dtr-2.5
7+
orlower: true
58
---
9+
{% if include.version=="dtr-2.5" %}
610

711
{% assign metadata_backup_file = "dtr-metadata-backup.tar" %}
812
{% assign image_backup_file = "dtr-image-backup.tar" %}
@@ -20,7 +24,7 @@ Docker Trusted Registry maintains data about:
2024
| Notary data | Notary tags and signatures |
2125
| Scan results | Security scanning results for images |
2226
| Certificates and keys | The certificates, public keys, and private keys that are used for mutual TLS communication |
23-
| Images content | The images you push to DTR. This can be stored on the filesystem of the node running DTR, or other storage system, depending on the configuration |
27+
| Images content | The images you push to DTR. This can be stored on the file system of the node running DTR, or other storage system, depending on the configuration |
2428

2529
This data is persisted on the host running DTR, using named volumes.
2630
[Learn more about DTR named volumes](../architecture.md).
@@ -56,7 +60,7 @@ restore.
5660
Since you can configure the storage backend that DTR uses to store images,
5761
the way you backup images depends on the storage backend you're using.
5862

59-
If you've configured DTR to store images on the local filesystem or NFS mount,
63+
If you've configured DTR to store images on the local file system or NFS mount,
6064
you can backup the images by using ssh to log into a node where DTR is running,
6165
and creating a tar archive of the [dtr-registry volume](../architecture.md):
6266

@@ -149,3 +153,5 @@ gpg -d {{ metadata_backup_file }} | tar -t
149153
You can also create a backup of a UCP cluster and restore it into a new
150154
cluster. Then restore DTR on that new cluster to confirm that everything is
151155
working as expected.
156+
157+
{% endif %}

datacenter/dtr/2.5/guides/admin/disaster-recovery/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,15 @@ title: DTR disaster recovery overview
33
description: Learn the multiple disaster recovery strategies you can use with
44
Docker Trusted Registry.
55
keywords: dtr, disaster recovery
6+
ui_tabs:
7+
- version: dtr-2.5
8+
orlower: true
69
---
10+
{% if include.version=="dtr-2.5" %}
711

812
Docker Trusted Registry is a clustered application. You can join multiple
913
replicas for high availability.
14+
1015
For a DTR cluster to be healthy, a majority of its replicas (n/2 + 1) need to
1116
be healthy and be able to communicate with the other replicas. This is also
1217
known as maintaining quorum.
@@ -22,6 +27,7 @@ healthy and able to communicate with one another.
2227

2328
In this example the DTR cluster has five replicas but one of the nodes stopped
2429
working, and the other has problems with the DTR overlay network.
30+
2531
Even though these two replicas are unhealthy the DTR cluster has a majority
2632
of replicas still working, which means that the cluster is healthy.
2733

@@ -56,3 +62,5 @@ backup. Restoring from a backup should be only used as a last resort, since
5662
doing an emergency repair might prevent some data loss.
5763

5864
[Learn how to restore from a backup](restore-from-backup.md).
65+
66+
{% endif %}

datacenter/dtr/2.5/guides/admin/disaster-recovery/repair-a-cluster.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,18 @@
22
title: Repair a cluster
33
description: Learn how to repair DTR when the majority of replicas are unhealthy.
44
keywords: dtr, disaster recovery
5+
ui_tabs:
6+
- version: dtr-2.5
7+
orlower: true
8+
next_steps:
9+
- path: create-a-backup/
10+
title: Create a backup
11+
- path: restore-from-backup/
12+
title: Restore from an existing backup
513
---
614

15+
{% if include.version=="dtr-2.5" %}
16+
717
For a DTR cluster to be healthy, a majority of its replicas (n/2 + 1) need to
818
be healthy and be able to communicate with the other replicas. This is known
919
as maintaining quorum.
@@ -46,7 +56,7 @@ Start by finding the ID of the DTR replica that you want to repair from.
4656
You can find the list of replicas by navigating to the UCP web UI, or by using
4757
a UCP client bundle to run:
4858

49-
```
59+
```bash
5060
{% raw %}
5161
docker ps --format "{{.Names}}" | grep dtr
5262

@@ -57,7 +67,7 @@ docker ps --format "{{.Names}}" | grep dtr
5767

5868
Then, use your UCP client bundle to run the emergency repair command:
5969

60-
```
70+
```bash
6171
{% raw %}
6272
docker run -it --rm {{ page.dtr_org }}/{{ page.dtr_repo }}:{{ page.dtr_version }} emergency-repair \
6373
--ucp-insecure-tls \
@@ -75,7 +85,4 @@ If the emergency repair command fails, try running it again using a different
7585
replica ID. As a last resort, you can restore your cluster from an existing
7686
backup.
7787

78-
## Where to go next
79-
80-
* [Create a backup](create-a-backup.md)
81-
* [Restore from an existing backup](restore-from-backup.md)
88+
{% endif %}

datacenter/dtr/2.5/guides/admin/disaster-recovery/repair-a-single-replica.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,16 @@
22
title: Repair a single replica
33
description: Learn how to repair a single DTR replica when it is unhealthy.
44
keywords: dtr, disaster recovery
5+
ui_tabs:
6+
- version: dtr-2.5
7+
orlower: true
8+
next_steps:
9+
- path: ../disaster-recovery/
10+
title: Disaster recovery overview
511
---
612

13+
{% if include.version=="dtr-2.5" %}
14+
715
When one or more DTR replicas are unhealthy but the overall majority
816
(n/2 + 1) is healthy and able to communicate with one another, your DTR
917
cluster is still functional and healthy.
@@ -57,7 +65,7 @@ replicas you want to remove.
5765
You can find this in the **Stacks** page of the UCP web UI, or by using the UCP
5866
client bundle to run:
5967

60-
```
68+
```bash
6169
{% raw %}
6270
docker ps --format "{{.Names}}" | grep dtr
6371

@@ -100,6 +108,4 @@ docker run -it --rm \
100108

101109
[Learn more about high availability](../configure/set-up-high-availability.md).
102110

103-
## Where to go next
104-
105-
* [Disaster recovery overview](index.md)
111+
{% endif %}

datacenter/dtr/2.5/guides/admin/disaster-recovery/restore-from-backup.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22
title: Restore from a backup
33
description: Learn how to restore a DTR cluster from an existing backup
44
keywords: dtr, disaster recovery
5+
ui_tabs:
6+
- version: dtr-2.5
7+
orlower: true
58
---
9+
{% if include.version=="dtr-2.5" %}
610

711
{% assign metadata_backup_file = "dtr-metadata-backup.tar" %}
812
{% assign image_backup_file = "dtr-image-backup.tar" %}
@@ -85,4 +89,6 @@ Where:
8589
If you're scanning images, you now need to download the vulnerability database.
8690

8791
After you successfully restore DTR, you can join new replicas the same way you
88-
would after a fresh installation. [Learn more](configure/set-up-vulnerability-scans.md).
92+
would after a fresh installation. [Learn more](../configure/set-up-vulnerability-scans.md).
93+
94+
{% endif %}

0 commit comments

Comments
 (0)