diff --git a/install-guide/source/common_prerequisites.rst b/install-guide/source/common_prerequisites.rst deleted file mode 100644 index 2a9d234c2..000000000 --- a/install-guide/source/common_prerequisites.rst +++ /dev/null @@ -1,75 +0,0 @@ -Prerequisites -------------- - -Before you install and configure the Root Cause Analyzis service, -you must create a database, service credentials, and API endpoints. - -#. To create the database, complete these steps: - - * Use the database access client to connect to the database - server as the ``root`` user: - - .. code-block:: console - - $ mysql -u root -p - - * Create the ``vitrage`` database: - - .. code-block:: mysql - - CREATE DATABASE vitrage; - - * Grant proper access to the ``vitrage`` database: - - .. code-block:: mysql - - GRANT ALL PRIVILEGES ON vitrage.* TO 'vitrage'@'localhost' \ - IDENTIFIED BY 'VITRAGE_DBPASS'; - GRANT ALL PRIVILEGES ON vitrage.* TO 'vitrage'@'%' \ - IDENTIFIED BY 'VITRAGE_DBPASS'; - - Replace ``VITRAGE_DBPASS`` with a suitable password. - - * Exit the database access client. - - .. code-block:: mysql - - exit; - -#. Source the ``admin`` credentials to gain access to - admin-only CLI commands: - - .. code-block:: console - - $ . admin-openrc - -#. To create the service credentials, complete these steps: - - * Create the ``vitrage`` user: - - .. code-block:: console - - $ openstack user create --domain default --password-prompt vitrage - - * Add the ``admin`` role to the ``vitrage`` user: - - .. code-block:: console - - $ openstack role add --project service --user vitrage admin - - * Create the vitrage service entities: - - .. code-block:: console - - $ openstack service create --name vitrage --description "Root Cause Analyzis" root cause analyzis - -#. Create the Root Cause Analyzis service API endpoints: - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - root cause analyzis public http://controller:XXXX/vY/%\(tenant_id\)s - $ openstack endpoint create --region RegionOne \ - root cause analyzis internal http://controller:XXXX/vY/%\(tenant_id\)s - $ openstack endpoint create --region RegionOne \ - root cause analyzis admin http://controller:XXXX/vY/%\(tenant_id\)s diff --git a/install-guide/source/conf.py b/install-guide/source/conf.py index 4d1649618..7ac6ae913 100644 --- a/install-guide/source/conf.py +++ b/install-guide/source/conf.py @@ -55,7 +55,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Installation Guide for Root Cause Analyzis Service' +project = u'Installation Guide for Root Cause Analysis Service' bug_tag = u'install-guide' copyright = u'2016, OpenStack contributors' diff --git a/install-guide/source/get_started.rst b/install-guide/source/get_started.rst index d5c79edc9..86185e347 100644 --- a/install-guide/source/get_started.rst +++ b/install-guide/source/get_started.rst @@ -1,6 +1,7 @@ ==================================== Root Cause Analysis service overview ==================================== + Vitrage provides a root cause analysis service, which is used for analyzing the topology and alarms of the cloud, and providing insights about it. The Root Cause Analysis service consists of the following components: diff --git a/install-guide/source/index.rst b/install-guide/source/index.rst index c11fee2a4..d6dce493a 100644 --- a/install-guide/source/index.rst +++ b/install-guide/source/index.rst @@ -1,5 +1,5 @@ =========================== -Root Cause Analyzis service +Root Cause Analysis service =========================== .. toctree:: @@ -10,7 +10,7 @@ Root Cause Analyzis service verify.rst next-steps.rst -The Root Cause Analyzis service (vitrage) provides... +The Root Cause Analysis service (vitrage) provides... This chapter assumes a working setup of OpenStack following the `OpenStack Installation Tutorial `_. diff --git a/install-guide/source/install-obs.rst b/install-guide/source/install-obs.rst deleted file mode 100644 index 38a435d8a..000000000 --- a/install-guide/source/install-obs.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _install-obs: - - -Install and configure for openSUSE and SUSE Linux Enterprise -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - - -Install and configure components --------------------------------- - - -Finalize installation ---------------------- diff --git a/install-guide/source/install-rdo.rst b/install-guide/source/install-rdo.rst index 8ed8a7bb1..88b90718e 100644 --- a/install-guide/source/install-rdo.rst +++ b/install-guide/source/install-rdo.rst @@ -4,10 +4,192 @@ Install and configure for Red Hat Enterprise Linux and CentOS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Install and configure components --------------------------------- +This section describes how to install and configure the Root Cause Analysis service +for Red Hat Enterprise Linux 7 and CentOS 7. + +Manual +++++++ + +Install Vitrage +--------------- + +Install Vitrage and python-vitrageclient +======================================== +#. Install Vitrage: + +.. code-block:: console + + $ sudo pip install vitrage + + $ sudo pip install python-vitrageclient + +To install a specific version, add the version number: + +.. code-block:: console + + $ sudo pip install vitrage==VITRAGE_VERSION + + $ sudo pip install python-vitrageclient==VITRAGE_CLIENT_VERSION + + ++------------------+-----------------+---------------+ +| Release version | Vitrage version | Client version| ++==================+=================+===============+ +| Ocata | 1.5.1 | 1.1.1 | ++------------------+-----------------+---------------+ +| Pike | ... | ... | ++------------------+-----------------+---------------+ + +Configure Vitrage +----------------- + +Create the Vitrage folders +========================== +#. Create /etc/vitrage folder and sub folders, **with permission 755**: + +.. code-block:: console + + $ mkdir /etc/vitrage + $ chmod 755 /etc/vitrage + + $ mkdir /etc/vitrage/static_datasources + $ chmod 755 /etc/vitrage/static_datasources + + $ mkdir /etc/vitrage/templates + $ chmod 755 /etc/vitrage/templates + + $ sudo mkdir /var/log/vitrage + $ sudo chmod 755 /var/log/vitrage + +Copy `policy.json`_ to /etc/vitrage/ + +Copy `api-paste.ini`_ to /etc/vitrage/ + +Copy the `datasources_values`_ folder with its content + +**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 +is vitrage.yaml -Finalize installation ---------------------- +.. _policy.json: http://git.openstack.org/cgit/openstack/vitrage/tree/etc/vitrage/policy.json +.. _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 + +Create the vitrage.conf file +============================ + +Create /etc/vitrage/vitrage.conf file with the following information: + +.. code:: bash + + [DEFAULT] + # debug = False + transport_url = + # notifiers = nova + + [service_credentials] + auth_url = http://:5000 + region_name = RegionOne + project_name = admin + password = + project_domain_id = default + user_domain_id = default + username = admin + auth_type = password + + [keystone_authtoken] + auth_uri = http://:5000 + project_domain_name = Default + project_name = service + user_domain_name = Default + password = + username = vitrage + auth_url = http://:35357 + auth_type = password + +Set the list of datasource you would like to use for Vitrage. + +**Note:** In order for a datasource to be supported, the underlying component +(like Neutron, Heat, Zabbix, etc.) should be installed separately. + +.. code:: bash + + [datasources] + types = nova.host,nova.instance,nova.zone,static,aodh,cinder.volume,neutron.network,neutron.port,heat.stack,doctor + +Configure notifications from other datasources +---------------------------------------------- + +Notifications from Aodh +======================= +In order to configure notifications from Aodh to Vitrage, set the following in +`/etc/aodh/aodh.conf`: + +.. code:: bash + + [oslo_messaging_notifications] + driver = messagingv2 + topics = notifications,vitrage_notifications + + +Notifications from other OpenStack components +============================================= + +In order to configure notifications from OpenStack components (Nova, Cinder, +Neutron, Heat and Aodh) to Vitrage, set the following in their conf files: + +.. code:: bash + + [DEFAULT] + notification_topics = notifications,vitrage_notifications + notification_driver=messagingv2 + + +Initialize Vitrage +------------------ + +Create the Vitrage account +========================== + +.. code:: bash + + openstack user create vitrage --password password --domain=Default + openstack role add admin --user vitrage --project service + openstack role add admin --user vitrage --project admin + +Create the Vitrage endpoint +=========================== + +.. code:: bash + + openstack service create rca --name vitrage --description="Root Cause Analysis Service" + openstack endpoint create --region --publicurl http://:8999 --internalurl http://:8999 --adminurl http://:8999 vitrage + + +Start the Vitrage Services +-------------------------- + +Run the following commands: + +.. code:: bash + + vitrage-graph + vitrage-api + vitrage-notifier + + +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 + +Automatic ++++++++++ + +Automatic installation for RDO is in progress; the patch can be found on the `RDO Gerrit`_ + +.. _`RDO Gerrit`: https://review.rdoproject.org/r/#/c/5962/ diff --git a/install-guide/source/install-ubuntu.rst b/install-guide/source/install-ubuntu.rst deleted file mode 100644 index 604d6bed8..000000000 --- a/install-guide/source/install-ubuntu.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _install-ubuntu: - -Install and configure for Ubuntu -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -Install and configure components --------------------------------- - - -Finalize installation ---------------------- diff --git a/install-guide/source/install.rst b/install-guide/source/install.rst index 52c4b664c..2dd2c14aa 100644 --- a/install-guide/source/install.rst +++ b/install-guide/source/install.rst @@ -4,17 +4,14 @@ Install and configure ~~~~~~~~~~~~~~~~~~~~~ This section describes how to install and configure the -Root Cause Analyzis service, code-named vitrage, on the controller node. +Root Cause Analysis service, code-named vitrage, on the controller node. This section assumes that you already have a working OpenStack -environment with at least the following components installed: -.. (add the appropriate services here and further notes) +environment. Note that installation and configuration vary by distribution. .. toctree:: :maxdepth: 2 - install-obs.rst install-rdo.rst - install-ubuntu.rst