From 8636aa7bf2d7438c7fd188cbdb55364528cb6431 Mon Sep 17 00:00:00 2001
From: James Ramsay <jramsay@gitlab.com>
Date: Mon, 14 Oct 2019 16:56:44 +0000
Subject: [PATCH] Add more context to Praefect docs

---
 doc/administration/gitaly/praefect.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md
index 9b6c753375e91..9e47f7767fe46 100644
--- a/doc/administration/gitaly/praefect.md
+++ b/doc/administration/gitaly/praefect.md
@@ -3,6 +3,19 @@
 NOTE: **Note:** Praefect is an experimental service, and for testing purposes only at
 this time.
 
+Praefect is an optional reverse-proxy for [Gitaly](../index.md) to manage a
+cluster of Gitaly nodes for high availability through replication.
+If a Gitaly node becomes unavailable, it will be possible to fail over to a
+warm Gitaly replica.
+
+The first minimal version will support:
+
+- Eventual consistency of the secondary replicas.
+- Manual fail over from the primary to the secondary.
+
+Follow the [HA Gitaly epic](https://gitlab.com/groups/gitlab-org/-/epics/1489)
+for updates and roadmap.
+
 ## Omnibus
 
 ### Architecture
-- 
GitLab