From 4d222edfd94f77d70a0c57288acf0ae6e46c222e Mon Sep 17 00:00:00 2001
From: guoshuaijie <guo.shuaijie@zte.com.cn>
Date: Thu, 7 Dec 2017 17:07:19 +0800
Subject: [PATCH] renew the installation document.

Change-Id: I164e71e80ca175806ff7059c713d265b1d94a9d4
---
 doc/source/install/get_started.rst |  8 +++++++-
 doc/source/install/index.rst       |  2 +-
 doc/source/install/install-rdo.rst | 13 ++++++++-----
 doc/source/install/next-steps.rst  |  3 +--
 4 files changed, 17 insertions(+), 9 deletions(-)

diff --git a/doc/source/install/get_started.rst b/doc/source/install/get_started.rst
index 86185e347..fae045627 100644
--- a/doc/source/install/get_started.rst
+++ b/doc/source/install/get_started.rst
@@ -7,9 +7,15 @@ Vitrage provides a root cause analysis service, which is used for analyzing the
 The Root Cause Analysis service consists of the following components:
 
 ``vitrage-graph`` service
-  The main process. It holds the in-memory entity graph, the template evaluator, and the different datasources.
+  The main process. It includes the in-memory entity graph and the template evaluator.
 ``vitrage-notifier`` service
   Used for notifying external systems about Vitrage alarms/state changes. It only calls Nova force-down API
   and Simple Network Management Protocol (SNMP) in the Ocata release.
 ``vitrage-api`` service
   The API layer for Vitrage.
+``vitrage-collector`` service
+  Responsible for retrieving data from the different datasources.
+``vitrage-ml`` service
+  Performs alarm analysis using Machine Learning methods.
+``vitrage-persistor`` service
+  Used to persist the events coming from the datasources in a database.
diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst
index d6dce493a..d9d4e5513 100644
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
@@ -13,4 +13,4 @@ Root Cause Analysis service
 The Root Cause Analysis service (vitrage) provides...
 
 This chapter assumes a working setup of OpenStack following the
-`OpenStack Installation Tutorial <http://docs.openstack.org/#install-guides>`_.
+`OpenStack Installation Guide <https://docs.openstack.org/install-guide/>`_.
diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst
index 0f2782f4b..219229224 100644
--- a/doc/source/install/install-rdo.rst
+++ b/doc/source/install/install-rdo.rst
@@ -37,7 +37,9 @@ To install a specific version, add the version number:
 +==================+=================+===============+
 | Ocata            | 1.5.1           | 1.1.1         |
 +------------------+-----------------+---------------+
-| Pike             | ...             | ...           |
+| Pike             | 1.8.2           | 1.4.0         |
++------------------+-----------------+---------------+
+| Queens           | ...             | ...           |
 +------------------+-----------------+---------------+
 
 Configure Vitrage
@@ -63,7 +65,7 @@ Create the Vitrage folders
 
 Copy `api-paste.ini`_ to /etc/vitrage/
 
-Copy the `datasources_values`_ folder with its content
+Copy the `datasources_values`_ folder with its content under /etc/vitrage/
 
 **Note:** You don't need to copy all files in this folder, only the ones that
 belong to datasources you plan to use. The only file that **must** be copied
@@ -71,8 +73,8 @@ is vitrage.yaml
 
 
 
-.. _api-paste.ini: http://git.openstack.org/cgit/openstack/vitrage/tree/etc/vitrage/api-paste.ini
-.. _datasources_values: http://git.openstack.org/cgit/openstack/vitrage/tree/etc/vitrage/datasources_values
+.. _api-paste.ini: https://git.openstack.org/cgit/openstack/vitrage/tree/etc/vitrage/api-paste.ini
+.. _datasources_values: https://git.openstack.org/cgit/openstack/vitrage/tree/etc/vitrage/datasources_values
 
 Create the vitrage.conf file
 ============================
@@ -106,6 +108,7 @@ Create /etc/vitrage/vitrage.conf file with the following information:
     auth_url = http://<ip>:35357
     auth_type = password
 
+Replace **<ip>** with your controller node's IP.
 Set the list of datasource you would like to use for Vitrage.
 
 **Note:** In order for a datasource to be supported, the underlying component
@@ -185,7 +188,7 @@ Install the Vitrage Dashboard
 
 Follow the vitrage-dashboard_ installation procedure.
 
-.. _vitrage-dashboard: http://git.openstack.org/cgit/openstack/vitrage-dashboard/tree/doc/source/installation.rst
+.. _vitrage-dashboard: https://git.openstack.org/cgit/openstack/vitrage-dashboard/tree/doc/source/contributor/installation.rst
 
 Automatic
 +++++++++
diff --git a/doc/source/install/next-steps.rst b/doc/source/install/next-steps.rst
index e1d727785..5bd4a1063 100644
--- a/doc/source/install/next-steps.rst
+++ b/doc/source/install/next-steps.rst
@@ -6,5 +6,4 @@ Next steps
 Your OpenStack environment now includes the vitrage service.
 
 To add additional services, see
-https://docs.openstack.org/project-install-guide/draft/index.html .
-
+https://docs.openstack.org/pike/install/ .