kudu git commit: docs: workflow for backing up or restoring an entire node

[ad...@apache.org]

Repository: kudu
Updated Branches:
  refs/heads/master f54dbb891 -> 06afa8f04


docs: workflow for backing up or restoring an entire node

I explicitly chose to be vague and not provide example shell commands
because this is such a niche workflow.

Change-Id: I638f4b169282d6688dec414eabfe4c81d0a3f5df
Reviewed-on: http://gerrit.cloudera.org:8080/10223
Reviewed-by: Alexey Serbin <as...@cloudera.com>
Reviewed-by: Will Berkeley <wd...@gmail.com>
Tested-by: Kudu Jenkins


Project: http://git-wip-us.apache.org/repos/asf/kudu/repo
Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/06afa8f0
Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/06afa8f0
Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/06afa8f0

Branch: refs/heads/master
Commit: 06afa8f04a8df5563935344a8127ff6a2cd60f8c
Parents: f54dbb8
Author: Adar Dembo <ad...@cloudera.com>
Authored: Thu Apr 26 15:48:18 2018 -0700
Committer: Adar Dembo <ad...@cloudera.com>
Committed: Thu May 3 21:39:28 2018 +0000

----------------------------------------------------------------------
 docs/administration.adoc | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kudu/blob/06afa8f0/docs/administration.adoc
----------------------------------------------------------------------
diff --git a/docs/administration.adoc b/docs/administration.adoc
index dd175b4..4c28669 100644
--- a/docs/administration.adoc
+++ b/docs/administration.adoc
@@ -974,3 +974,32 @@ $ rm -rf /data/0/kudu-tserver-wal/* /data/0/kudu-tserver-meta/* /data/1/kudu-tse
 . After directories are deleted, the server process can be started with the new
   directory configuration. The appropriate sub-directories will be created by
   Kudu upon starting up.
+
+[[physical_backup]]
+=== Physical backups of an entire node
+
+As documented in the link:known_issues.html#_replication_and_backup_limitations[Known Issues and Limitations],
+Kudu does not yet provide any built-in backup and restore functionality. However,
+it is possible to create a physical backup of a Kudu node (either tablet server
+or master) and restore it later.
+
+WARNING: The node to be backed up must be offline during the procedure, or else
+the backed up (or restored) data will be inconsistent.
+
+WARNING: Certain aspects of the Kudu node (such as its hostname) are embedded in
+the on-disk data. As such, it's not yet possible to restore a physical backup of
+a node onto another machine.
+
+. Stop all Kudu processes in the cluster. This prevents the tablets on the
+  backed up node from being rereplicated elsewhere unnecessarily.
+
+. If creating a backup, make a copy of the WAL, metadata, and data directories
+  on each node to be backed up. It is important that this copy preserve all file
+  attributes as well as sparseness.
+
+. If restoring from a backup, delete the existing WAL, metadata, and data
+  directories, then restore the backup via move or copy. As with creating a
+  backup, it is important that the restore preserve all file attributes and
+  sparseness.
+
+. Start all Kudu processes in the cluster.