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 [] + +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