Update documentation for 1.1/Mitaka release

Change-Id: I7c527a47311dbd7cf7abe5cb42e88f58bacb9c0d
This commit is contained in:
Dmitry Mescheryakov 2016-06-28 14:55:35 +03:00
parent eced0bbc8a
commit 81d8318355
6 changed files with 34 additions and 26 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 112 KiB

After

Width:  |  Height:  |  Size: 111 KiB

View File

@ -54,9 +54,9 @@ author = u'Mirantis Inc.'
# built documents.
#
# The short X.Y version.
version = u'1.0-1.0.1-1'
version = u'1.1-1.1.1-1'
# The full version, including alpha/beta/rc tags.
release = u'1.0-1.0.1-1'
release = u'1.1-1.1.1-1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -199,7 +199,7 @@ html_static_path = ['_static']
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'DetachRabbitMQpluginforFueldoc'
htmlhelp_basename = 'DetachRabbitMQPluginforFuelDoc'
# -- Options for LaTeX output ---------------------------------------------
@ -221,7 +221,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'DetachRabbitMQpluginforFuel.tex', u'Detach RabbitMQ plugin for Fuel Documentation',
(master_doc, 'DetachRabbitMQPluginforFuel.tex', u'Detach RabbitMQ plugin for Fuel Documentation',
u'Mirantis Inc.', 'manual'),
]
@ -268,8 +268,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'DetachRabbitMQpluginforFuel', u'Detach RabbitMQ plugin for Fuel Documentation',
author, 'DetachRabbitMQpluginforFuel', 'One line description of project.',
(master_doc, 'DetachRabbitMQPluginforFuel', u'Detach RabbitMQ plugin for Fuel Documentation',
author, 'DetachRabbitMQPluginforFuel', 'One line description of project.',
'Miscellaneous'),
]

View File

@ -13,10 +13,3 @@ Welcome to Detach RabbitMQ plugin for Fuel's documentation!
installation_guide
user_guide
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`

View File

@ -10,22 +10,22 @@ Installation Guide
#. Copy the plugin on already installed Fuel Master node::
[user@home ~]$ scp detach-rabbitmq-1.0-1.0.1-1.noarch.rpm root@:/
[user@home ~]$ scp detach-rabbitmq-1.1-1.1.1-1.noarch.rpm root@:/
<the_Fuel_Master_node_IP>:~/
#. Log into the Fuel Master node. Install the plugin::
[root@fuel ~]# fuel plugins --install detach-rabbitmq-1.0-1.0.1-1.noarch.rpm
[root@fuel ~]# fuel plugins --install detach-rabbitmq-1.1-1.1.1-1.noarch.rpm
#. Verify that the plugin is installed correctly::
[root@fuel ~]# fuel plugins --list
id | name | version | package_version
---|-----------------|---------|----------------
1 | detach-rabbitmq | 1.0.1 | 3.0.0
id | name | version | package_version | releases
---+-----------------+---------+-----------------+--------------------
1 | detach-rabbitmq | 1.1.1 | 3.0.0 | ubuntu (mitaka-9.0)
.. target-notes::
.. _installing Fuel Master node: https://docs.mirantis.com/openstack/fuel/fuel-8.0/fuel-install-guide.html#introduction-to-fuel-installation
.. _installing Fuel Master node: http://docs.openstack.org/developer/fuel-docs/mitaka/userdocs/fuel-install-guide.html
.. _Fuel Plugins Catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/

View File

@ -23,9 +23,9 @@ Requirements
+----------------------------+--------------------+
| Requirement | Version/Comment |
+============================+====================+
| Fuel | 8.0 release |
| Fuel | 9.x release |
+----------------------------+--------------------+
| OpenStack compatibility | Liberty |
| OpenStack compatibility | Mitaka |
+----------------------------+--------------------+
| Operating systems | Ubuntu 14.04 LTS |
+----------------------------+--------------------+

View File

@ -7,7 +7,7 @@ User Guide
#. After the plugin is installed, `create a new OpenStack environment`_.
#. Open the Settings tab of the Fuel web UI and then select the Other menu.
Select "Separate RabbitMQ from controller" checkbox. With the radio button
Select "Detach RabbitMQ Plugin" checkbox. With the radio button
below select the plugin version (multiple options are available only when
several versions of the plugin are installed):
@ -55,9 +55,24 @@ The same applies to log of Pacemaker which manages RabbitMQ. Its location is:
- /var/log/remote/<node-name>/lrmd.log
- /var/log/remote/<node-name>/pengine.log
Upgrades
--------
It is possible to upgrade Fuel Master node from 8.0 to 9.0 using `the guide`_.
After the upgrade, the master node will both be able to maintain existing
Liberty OpenStack environments and deploy new Mitaka ones. If a Liberty
environment used Detach RabbitMQ 1.0 plugin, it will be possible to continue
using it. Also one can co-install Detach RabbitMQ 1.1 plugin onto the same
master node to support detaching RabbitMQ for new Mitaka environments. In that
case 'fuel plugins --list' command will show that two versions, 1.0 and 1.1,
of the plugin are installed.
Note: there is no procedure to upgrade a Liberty OpenStack environment with
Detach RabbitMQ plugin enabled to Mitaka version.
.. target-notes::
.. _create a new OpenStack environment: https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#create-a-new-openstack-environment
.. _configuring your environment: http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#configure-your-environment
.. _Deploy your environment: http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#deploy-changes
.. _create a new OpenStack environment: http://docs.openstack.org/developer/fuel-docs/mitaka/userdocs/fuel-user-guide/create-environment.html
.. _configuring your environment: http://docs.openstack.org/developer/fuel-docs/mitaka/userdocs/fuel-user-guide/configure-environment.html
.. _Deploy your environment: http://docs.openstack.org/developer/fuel-docs/mitaka/userdocs/fuel-user-guide/deploy-environment/deploy-changes.html#deploy-changes
.. _the guide: http://docs.openstack.org/developer/fuel-docs/mitaka/userdocs/fuel-install-guide/upgrade/upgrade-fuel.html