From 10ea20ff870f2d03c751562a3ab163336569944e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samir=20Ibrad=C5=BEi=C4=87?= Date: Tue, 8 Mar 2016 20:43:48 +0900 Subject: [PATCH] Docs: Added release notes & troubleshooting section Change-Id: I63475b6ddeeea6822fc000f0f461c47197cf6682 --- doc/content/description.rst | 26 +++++++++++++--- doc/content/guide.rst | 48 ++++++++++++++++++++++++++++- doc/content/installation.rst | 4 +-- doc/user-guide.rst | 58 +++++++++++++++++++++++++++++++----- 4 files changed, 121 insertions(+), 15 deletions(-) diff --git a/doc/content/description.rst b/doc/content/description.rst index 45ac062..a58ea42 100644 --- a/doc/content/description.rst +++ b/doc/content/description.rst @@ -7,12 +7,12 @@ Introduction ============ MidoNet is an Apache licensed production grade network virtualization software -for Infrastructure-as-a-Service (IaaS) clouds. Plugin for Fuel 7.0 provides the +for Infrastructure-as-a-Service (IaaS) clouds. Plugin for Fuel |FuelVer| provides the puppet manifests to install all the components to deploy easily MidoNet with Fuel in both lab or production environments. Fuel MidoNet plugin is capable of deploying MidoNet v2015.06_ on top of Mirantis -OpenStack Fuel version 7.0 (including Maintenance Update 2). There are no +OpenStack Fuel version |FuelVer| (including Maintenance Update 2). There are no prerequisites to use the MidoNet plugin: MidoNet is Open Source, and the plugin sets the repositories from where download and install MidoNet packages. @@ -27,8 +27,8 @@ Requirements ======================= =============== Requirement Version/Comment ======================= =============== -Fuel 7.0 -MidoNet plugin for Fuel 3.0.1 +Fuel |FuelVer| +MidoNet plugin for Fuel |PluginVer| ======================= =============== Limitations @@ -51,3 +51,21 @@ Limitations .. _MEM: http://docs.midokura.com/docs/latest/manager-guide/content/index.html .. _provided: http://www.midokura.com/mem-eval + +Changes in MidoNet plugin |PluginVer| +------------------------------------- + +* New features: + + * Support for Fuel 7.0 Maintenance Release 2 + * Added post_install.sh script that sets up Fuel experimental features, + customized MidoNet roles and custom deployment graph + +* Bug fixes: + + * Provided updated python-neutron-plugin-midonet debian package + * MidoNet BGP gateway role parameters + * Neutron db creation timeouts + * Fix some OSTF test scenarios + * Numerous documentation fixes + diff --git a/doc/content/guide.rst b/doc/content/guide.rst index 6cc2475..9c68488 100644 --- a/doc/content/guide.rst +++ b/doc/content/guide.rst @@ -25,7 +25,7 @@ the differences betewwn the Neutron dafault ML2 deployments first. Neutron without MidoNet plugin `````````````````````````````` -Fuel 7.0 reference architecture contains some useful informaition in +Fuel |FuelVer| reference architecture contains some useful informaition in `Neutron Network Topologies `_ section. First, let's have an overview of Neutron-default ML2 topolgy: @@ -243,3 +243,49 @@ Finish environment configuration #. Press `Deploy button `_ to once you are done with environment configuration. + +Operations and Troubleshooting +------------------------------ + +A successful deployment done with MidoNet Fuel plugin will produce fully +working OpenStack environment, with MidoNet Neutron network back-end. +MidoNet is fully compatible with Neutron and Nova APIs and most of its +aspects can be directly managed by OpenStack Horizon WEB interface, as well +as Neutron API. + +Operating MidoNet +````````````````` + +For advanced networking features supported by MidoNet please +see `MidoNet Operations Guide`_. For general MidoNet troubleshooting, assuming +the deployment went fine, please see `MidoNet Troubleshooting Guide`_. + +.. _MidoNet Operations Guide: https://docs.midonet.org/docs/v2015.06/en/operations-guide/content/index.html +.. _MidoNet Troubleshooting Guide: https://docs.midonet.org/docs/v2015.06/en/troubleshooting-guide/content/index.html + + +Troubleshooting MidoNet Fuel deployment +``````````````````````````````````````` + +In a case MidoNet Fuel deployment failed for some reason, first thing to +do is to make sure that the initiated deployment satisfies the plugin +`Limitations`_. + +In a case MidoNet Fuel deployment failed for some other reason, useful thing +to be checked are various log outputs available in Fuel WEB UI. Click on the +**Logs** tab and observe logging information. Default log displayed in the +WEB interface shows "Web backend" logs, which are too general to provide +any troubleshooting information, we want to check "Astute" logs, which can be +selected by clicking *Source* drop down menu, followed by clicking **Show** +button. In case of deployment errors, important messages will be shown in red, +identifying which stage of deployment may have failed, and on which node(s). + +Next step is to look into how deployment tasks were executed at target nodes. +After identifying nodes in previous step, select "Other servers" in the +**Logs** drop-down menu, following by selecting an appropriate node in +**Node** and "puppet" in **Source** drop-down menus. Again, important failures +should be marked in red. Depending on user's level of understanding of these +messages, they should either be included in MidoNet support claims to help +to help the troubleshooting or an action can be taken by user to prevent issue +from happening on re-deployment. + diff --git a/doc/content/installation.rst b/doc/content/installation.rst index cae92bf..59311e6 100644 --- a/doc/content/installation.rst +++ b/doc/content/installation.rst @@ -12,7 +12,7 @@ Install the Plugin To install the MidoNet Fuel plugin: -#. Download MidoNet plugin v3.0.1 from `Fuel Plugins Catalog`_ +#. Download MidoNet plugin version |PluginVer| from `Fuel Plugins Catalog`_ #. Log into Fuel Master node and install the plugin using the `Fuel CLI `_: @@ -154,7 +154,7 @@ plugin post-install script, assuming the plugin is installed on top of clean Fuel master installation. In case the process still has to be done manually, follow these steps: -#. Create a group type for Fuel 7.0 in a YAML file called +#. Create a group type for Fuel |FuelVer| in a YAML file called ``/tmp/midonet_groups.yaml`` with the following content:: - id: nsdb diff --git a/doc/user-guide.rst b/doc/user-guide.rst index 5b19005..dd0f4fd 100644 --- a/doc/user-guide.rst +++ b/doc/user-guide.rst @@ -1,17 +1,59 @@ -======================================== -Guide to the MidoNet Plugin for Fuel 7.0 -======================================== -| -| -| +.. |FuelVer| replace:: 7.0 +.. |PrevPluginVer| replace:: 3.0.0 +.. |PluginVer| replace:: 3.0.1 + +============================= + Guide to the MidoNet Plugin +============================= + +.. class:: center + +version |PluginVer| for Fuel |FuelVer| + + +.. raw:: pdf + + PageBreak oneColumn -This document will guide you through the steps of install, configure and use the -MidoNet plugin for Fuel. .. contents:: .. section-numbering:: + +.. raw:: pdf + + PageBreak oneColumn + + +Revision history +================ + +========= =============== ========================== ========================= + Version Revision date Editor Comment +========= =============== ========================== ========================= + 0.1 15.01.2016 Carmela Rubinos Initial release + + (carmela@midokura.com) + 0.2 29.02.2016 Samir Ibradzic Version 3.0.1 changes + + (samir@midokura.com) + 0.3 07.03.2016 Samir Ibradzic Added release notes + and troubleshooting + (samir@midokura.com) +========= =============== ========================== ========================= + +.. raw:: pdf + + PageBreak oneColumn + + +Document purpose +================ + +This document will guide you through the steps of install, configure and use the +MidoNet plugin version |PluginVer| for Fuel |FuelVer|. + .. include:: content/description.rst .. include:: content/terms.rst .. include:: content/installation.rst