Merge branch 'patch-1' of https://github.com/mr-c/arvados into mr-c-patch-1
[arvados.git] / doc / admin / recovering-deleted-collections.html.textile.liquid
1 ---
2 layout: default
3 navsection: admin
4 title: Recovering deleted collections
5 ...
6
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 In some cases, it is possible to recover files that have been lost by modifying or deleting a collection.
14
15 Possibility of recovery depends on many factors, including:
16 * Whether the collection manifest is still available, e.g., in an audit log entry
17 * Whether the data blocks are also referenced by other collections
18 * Whether the data blocks have been unreferenced long enough to be marked for deletion/trash by keep-balance
19 * Blob signature TTL, trash lifetime, trash check interval, and other config settings
20
21 To attempt recovery of a previous version of a deleted/modified collection, use the @arvados-server recover-collection@ command. It should be run on one of your server nodes where the @arvados-server@ package is installed and the @/etc/arvados/config.yml@ file is up to date.
22
23 Specify the collection you want to recover by passing either the UUID of an audit log entry, or a file containing the manifest.
24
25 If recovery is successful, the @recover-collection@ program saves the recovered data a new collection belonging to the system user, and prints the new collection's UUID on stdout.
26
27 <pre>
28 # arvados-server recover-collection 9tee4-57u5n-nb5awmk1pahac2t
29 INFO[2020-06-05T19:52:29.557761245Z] loaded log entry                              logged_event_time="2020-06-05 16:48:01.438791 +0000 UTC" logged_event_type=update old_collection_uuid=9tee4-4zz18-1ex26g95epmgw5w src=9tee4-57u5n-nb5awmk1pahac2t
30 INFO[2020-06-05T19:52:29.642145127Z] recovery succeeded                            UUID=9tee4-4zz18-5trfp4k4xxg97f1 src=9tee4-57u5n-nb5awmk1pahac2t
31 9tee4-4zz18-5trfp4k4xxg97f1
32 INFO[2020-06-05T19:52:29.644699436Z] exiting
33 </pre>
34
35 In this example, the original data has been restored and saved in a new collection with UUID @9tee4-4zz18-5trfp4k4xxg97f1@.
36
37 For more options, run @arvados-server recover-collection -help@.