Masakari operator's documentation

Added overview of masakari, sample configuration and policies
required for masakari.

Change-Id: If81e92dbdaa4bd9869b7e60d5aaf313532c25676

doc/source/_static/masakari.policy.json.sample

@@ -0,0 +1,10 @@
+{
+    "admin_api": "is_admin:True",
+    "context_is_admin":  "role:admin",
+    "admin_or_owner":  "is_admin:True or project_id:%(project_id)s",
+    "default": "rule:admin_api",
+    "os_masakari_api:extensions": "rule:admin_api",
+    "os_masakari_api:segments": "rule:admin_api",
+    "os_masakari_api:os-hosts": "rule:admin_api",
+    "os_masakari_api:notifications": "rule:admin_api"
+}

doc/source/index.rst

@@ -57,6 +57,18 @@ masakari actually does, and why.
    architecture
    development.environment
 
+Operator Guide
+==============
+
+This section will help you in configuring masakari mannualy.
+
+.. toctree::
+    :maxdepth: 1
+
+    operators_guide
+    sample_config
+    sample_policy
+
 Indices and tables
 ==================
 

doc/source/masakari_overview.rst

@@ -0,0 +1,42 @@
+..
+      Copyright 2017 NTT DATA
+
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+=========================
+Masakari service overview
+=========================
+
+Masakari provides a Virtual Machines High Availability(VMHA), and rescues a
+KVM-based Virtual Machines(VM) from a failure events of the following:
+
+* VM process down - restart vm (use nova stop API, and nova start API).
+                    Libvirt events will be also emitted by other failures.
+* Provisioning process down - restarts process, changes nova-compute service
+                              status to maintenance mode
+                              (use nova service-disable).
+* nova-compute host failure - evacuate all the VMs from failure host to
+                              reserved host (use nova evacuate API).
+
+The service enables deployers to integrate with the Masakari service
+directly or through custom plug-ins.
+
+The Masakari service consists of the following components:
+
+``masakari-api``
+  An OpenStack-native REST API that processes API requests by sending
+  them to the ``masakari-engine`` over `Remote Procedure Call (RPC)`.
+
+``masakari-engine``
+  Processes the notifications recevied from ``masakari-api`` by execcuting the
+  recovery workflow in asynchronus way.

doc/source/operators_guide.rst

@@ -0,0 +1,23 @@
+..
+      Copyright 2017 NTT DATA
+
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+================
+Masakari Service
+================
+
+.. toctree::
+    :maxdepth: 1
+
+    masakari_overview

doc/source/sample_config.rst

@@ -0,0 +1,54 @@
+==============================
+Masakari Configuration Options
+==============================
+
+The following is a sample Masakari configuration for adaptation and use. It is
+auto-generated from Masakari when this documentation is built, so
+if you are having issues with an option, please compare your version of
+Masakari with the version of this documentation.
+
+.. literalinclude:: _static/masakari.conf.sample
+
+Minimal Configuration
+=====================
+
+Edit the ``/etc/masakari/masakari.conf`` file and complete the following actions
+
+In the ``[DEFAULT]`` section, set following options:
+
+.. code-block:: bash
+
+    auth_strategy = keystone
+    masakari_topic = ha_engine
+    os_privileged_user_tenant = service
+    os_privileged_user_auth_url = http://controller/identity
+    os_privileged_user_name = nova
+    os_privileged_user_password = PRIVILEGED_USER_PASS
+
+Replace ``PRIVILEGED_USER_PASS`` with the password you chose for the privileged user in the
+Identity service.
+
+In the ``[database]`` section, configure database access:
+
+.. code-block:: bash
+
+    connection = mysql+pymysql://root:MASAKARI_DBPASS@controller/masakari?charset=utf8
+
+In the ``[keystone_authtoken]`` sections, configure Identity service access:
+
+.. code-block:: bash
+
+    auth_url = http://controller/identity
+    memcached_servers = controller:11211
+    signing_dir = /var/cache/masakari
+    project_domain_name = Default
+    user_domain_name = Default
+    project_name = service
+    username = masakari
+    password = MASAKARI_PASS
+    auth_type = password
+    cafile = /opt/stack/data/ca-bundle.pem
+
+Replace ``MASAKARI_PASS`` with the password you chose for the ``masakari`` user in the Identity service.
+
+

doc/source/sample_policy.rst

@@ -0,0 +1,9 @@
+===============
+Masakari Policy
+===============
+
+The following is a sample masakari policy file. Operator can configure policies
+as per his requirement. It is recommended that all api's of masakari should
+be allowed to admin user only.
+
+.. literalinclude:: _static/masakari.policy.json.sample