From 7d71e9723958d38ed4b9512aa90d7032d6d9565b Mon Sep 17 00:00:00 2001
From: "Q.hongtao" <qihongtao@inspur.com>
Date: Thu, 6 Aug 2020 14:39:12 +0800
Subject: [PATCH] Update cli doc: Add vitrage-purge-data.rst
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

In this section that only have 'vitrage-status'  on Vitrage’s command line
interface.It is easy to use the cli interface of 'vitrage-purge-data' to clear
tables, so I added this part of the document.

Change-Id: Ie74e4f1160643808a5772329c6388c4469633fd5
---
 doc/source/cli/index.rst              |  1 +
 doc/source/cli/vitrage-purge-data.rst | 51 +++++++++++++++++++++++++++
 2 files changed, 52 insertions(+)
 create mode 100644 doc/source/cli/vitrage-purge-data.rst

diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
index db506ceb6..b7a6aa317 100644
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -9,3 +9,4 @@ interface.
    :maxdepth: 1
 
    vitrage-status
+   vitrage-purge-data
\ No newline at end of file
diff --git a/doc/source/cli/vitrage-purge-data.rst b/doc/source/cli/vitrage-purge-data.rst
new file mode 100644
index 000000000..4c8db79bf
--- /dev/null
+++ b/doc/source/cli/vitrage-purge-data.rst
@@ -0,0 +1,51 @@
+==================
+vitrage-purge-data
+==================
+
+---------------------------------------------
+CLI interface for Vitrage Purge Data commands
+---------------------------------------------
+
+Synopsis
+========
+
+::
+
+  vitrage-purge-data --config-file [<args>]
+
+Description
+===========
+
+:program:`vitrage-purge-data` is a tool that provides routines for clearing
+the data of a Vitrage deployment tables.
+
+Options
+=======
+
+The standard pattern for executing a :program:`vitrage-purge-data` command is::
+
+    vitrage-purge-data --config-file /etc/vitrage/vitrage.conf
+
+
+The section describe those tables that are emptied after executing the command
+
+  **Related Tables**
+
+  .. list-table::
+     :widths: 20 80
+     :header-rows: 1
+
+     * - Number
+       - Table Name
+     * - 1
+       - active_actions
+     * - 2
+       - events
+     * - 3
+       - graph_snapshots
+     * - 4
+       - changes
+     * - 5
+       - edges
+     * - 6
+       - alarms