update Mirantis OpenStack version to 5.1
Additional cleanups: * Removed duplicated explanation of Ceilometer performance considerations for MongoDB database backend from the terminology page and left it in the user guide where it belongs. * pt_archiver code fragment width reduced to fit inside page margins in PDF. * toctree and preface removed from pdf_relnotes.rst. Release notes are left referring 5.0.1, that will have to be addressed in a separate commit. Change-Id: Ife0d774c54c603a9eb8881649bf7cbdd8345e67d
This commit is contained in:
Dmitry Borodaenko
parent
3a64ff0d83
commit
5bfe5ad403
|
|
@ -58,10 +58,10 @@ copyright = u'2014, Mirantis Inc.'
|
|||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '5.0.1'
|
||||
version = '5.1'
|
||||
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '5.0.1'
|
||||
release = '5.1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
|
|||
14
index.rst
14
index.rst
|
|
@ -11,43 +11,43 @@ Welcome to Mirantis OpenStack Documentation
|
|||
This page contains the most recent Mirantis OpenStack documentation.
|
||||
Select a document from the left menu and navigate through the topics.
|
||||
|
||||
:ref:`planning-guide` `(pdf) <pdf/Mirantis-OpenStack-5.0-PlanningGuide.pdf>`__
|
||||
:ref:`planning-guide` `(pdf) <pdf/Mirantis-OpenStack-5.1-PlanningGuide.pdf>`__
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Planning information you should consider before
|
||||
installing Fuel and deploying Mirantis OpenStack.
|
||||
|
||||
:ref:`user-guide` `(pdf) <pdf/Mirantis-OpenStack-5.0-UserGuide.pdf>`__
|
||||
:ref:`user-guide` `(pdf) <pdf/Mirantis-OpenStack-5.1-UserGuide.pdf>`__
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This document describes how to deploy Mirantis OpenStack environments
|
||||
using Fuel.
|
||||
|
||||
:ref:`operations-guide` `(pdf) <pdf/Mirantis-OpenStack-5.0-OperationsGuide.pdf>`__
|
||||
:ref:`operations-guide` `(pdf) <pdf/Mirantis-OpenStack-5.1-OperationsGuide.pdf>`__
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
A collection of useful procedures for using and managing
|
||||
your Mirantis OpenStack environment.
|
||||
|
||||
:ref:`virtualbox` `(pdf) <pdf/Mirantis-OpenStack-5.0-Running-Mirantis-OpenStack-on-VirtualBox.pdf>`__
|
||||
:ref:`virtualbox` `(pdf) <pdf/Mirantis-OpenStack-5.1-Running-Mirantis-OpenStack-on-VirtualBox.pdf>`__
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This document provides information about running Mirantis OpenStack on VirtualBox
|
||||
for demonstration and evaluation purposes.
|
||||
|
||||
:ref:`ref-arch` `(pdf) <pdf/Mirantis-OpenStack-5.0-ReferenceArchitecture.pdf>`__
|
||||
:ref:`ref-arch` `(pdf) <pdf/Mirantis-OpenStack-5.1-ReferenceArchitecture.pdf>`__
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
A deep dive into the structure of the Mirantis OpenStack environment,
|
||||
network considerations, and deployment options.
|
||||
|
||||
:ref:`terminology-ref` `(pdf) <pdf/Mirantis-OpenStack-5.0-Terminology-Reference.pdf>`__
|
||||
:ref:`terminology-ref` `(pdf) <pdf/Mirantis-OpenStack-5.1-Terminology-Reference.pdf>`__
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Short articles about OpenStack terminology and technology
|
||||
with references to other documentation and other useful information.
|
||||
|
||||
:ref:`release-notes` `(pdf) <pdf/Mirantis-OpenStack-5.0-RelNotes.pdf>`__
|
||||
:ref:`release-notes` `(pdf) <pdf/Mirantis-OpenStack-5.1-RelNotes.pdf>`__
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The Release Notes provide general information about new features,
|
||||
|
|
|
|||
|
|
@ -27,16 +27,18 @@ Installation
|
|||
To install Ceilometer with Fuel,
|
||||
check the appropriate box when configuring your environment.
|
||||
|
||||
Notes
|
||||
-----
|
||||
Performance and database backend
|
||||
--------------------------------
|
||||
|
||||
Ceilometer can be configured to collect a large amount of metering data
|
||||
and thus perform a high volume of database writes.
|
||||
For example, with 100 resources and default configs
|
||||
Ceilometer collects around 16k samples per hour.
|
||||
Mirantis OpenStack 5.0 now defaults to installing MongoDB
|
||||
as the recommended back-end database for OpenStack Telemetry.
|
||||
|
||||
Starting with version 5.0, Mirantis OpenStack defaults to installing
|
||||
:ref:`mongodb-term` as the recommended back-end database for Ceilometer.
|
||||
The Fuel Master Node enables you to choose
|
||||
the installation of MongoDB as a role onto a node.
|
||||
the installation of MongoDB as a role onto a node;
|
||||
see :ref:`assign-roles-ug` for instructions.
|
||||
This resolves the Ceilometer performance issues caused
|
||||
by the volume of concurrent read/write operations.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ such as that required after a security breach.
|
|||
However, the accumulation of the expired tokens in the database
|
||||
can seriously degrade the performance of the entire OpenStack.
|
||||
|
||||
Beginning with Release 5.0,
|
||||
Beginning with version 5.0,
|
||||
Mirantis OpenStack includes the
|
||||
`pt-archiver <http://www.percona.com/doc/percona-toolkit/2.1/pt-archiver.html>`_
|
||||
command from the
|
||||
|
|
@ -24,7 +24,7 @@ script from TripleO is a good example:
|
|||
|
||||
::
|
||||
|
||||
pt-archiver --source h=$KEYSTONE_DB_HOST,u=$KEYSTONE_DB_USER,p=$KEYSTONE_DB_PASS,D=$KEYSTONE_DB_NAME,t=token \
|
||||
pt-archiver --source h=$DB_HOST,u=$DB_USER,p=$DB_PASS,D=$DB_NAME,t=token \
|
||||
--charset utf8 \
|
||||
--where "expires < UTC_TIMESTAMP()" \
|
||||
--purge \
|
||||
|
|
|
|||
|
|
@ -29,3 +29,5 @@ The following table lists the released revisions of this documentation:
|
|||
+--------------------+----------------------------+
|
||||
|August, 2014 |5.0.1 GA |
|
||||
+--------------------+----------------------------+
|
||||
|August, 2014 |5.1 GA |
|
||||
+--------------------+----------------------------+
|
||||
|
|
|
|||
|
|
@ -19,19 +19,6 @@ Fuel can install Ceilometer on systems running
|
|||
either the CentOS or Ubuntu operating system;
|
||||
check the appropriate box when configuring your environment.
|
||||
|
||||
Note that Ceilometer collects a great deal of data
|
||||
and performs a large volume of database writes;
|
||||
with 100 resources and default configs Ceilometer collects around
|
||||
16k samples per hour.
|
||||
|
||||
Mirantis OpenStack 5.0 now defaults to installing :ref:`mongodb-term`
|
||||
as the recommended back-end database for OpenStack Telemetry.
|
||||
The Fuel Master Node enables you to choose
|
||||
the installation of MongoDB as a role onto a node;
|
||||
see :ref:`assign-roles-ug` for instructions.
|
||||
This resolves the Ceilometer performance issues caused
|
||||
by the volume of concurrent read/write operations.
|
||||
|
||||
For more information, see
|
||||
* :ref:`ceilometer-deployment-notes`
|
||||
* `Ceilometer wiki <https://wiki.openstack.org/wiki/Ceilometer>`_
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Code name for the ninth release of the OpenStack software.
|
|||
For more information, see the
|
||||
`Icehouse web site <http://www.openstack.org/software/icehouse/>`_.
|
||||
|
||||
Mirantis OpenStack version 5.0 incorporates and supports
|
||||
Mirantis OpenStack version 5.0 and later incorporates and supports
|
||||
the Icehouse code base.
|
||||
The following features in Icehouse are not deployed by Fuel 5.x
|
||||
but can be configured manually using the standard OpenStack practices:
|
||||
|
|
|
|||
14
pdf/conf.py
14
pdf/conf.py
|
|
@ -18,11 +18,11 @@ exclude_patterns = ['_*', 'pages', 'contents', 'index', '*-guide', '*.rst']
|
|||
|
||||
pdf_documents = [
|
||||
# (master_doc, project, project, copyright),
|
||||
('pdf/pdf_planning-guide', u'Mirantis-OpenStack-5.0-PlanningGuide', u'Planning Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_user', u'Mirantis-OpenStack-5.0-UserGuide', u'User Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_operations', u'Mirantis-OpenStack-5.0-OperationsGuide', u'Operations Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_virtualbox', u'Mirantis-OpenStack-5.0-Running-Mirantis-OpenStack-on-VirtualBox', u'Running Mirantis OpenStack on VirtualBox', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_reference', u'Mirantis-OpenStack-5.0-ReferenceArchitecture', u'Reference Architecture', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_terminology', u'Mirantis-OpenStack-5.0-Terminology-Reference', u'Terminology Reference', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_relnotes', u'Mirantis-OpenStack-5.0-RelNotes', u'Release Notes', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_planning-guide', u'Mirantis-OpenStack-5.1-PlanningGuide', u'Planning Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_user', u'Mirantis-OpenStack-5.1-UserGuide', u'User Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_operations', u'Mirantis-OpenStack-5.1-OperationsGuide', u'Operations Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_virtualbox', u'Mirantis-OpenStack-5.1-Running-Mirantis-OpenStack-on-VirtualBox', u'Running Mirantis OpenStack on VirtualBox', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_reference', u'Mirantis-OpenStack-5.1-ReferenceArchitecture', u'Reference Architecture', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_terminology', u'Mirantis-OpenStack-5.1-Terminology-Reference', u'Terminology Reference', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_relnotes', u'Mirantis-OpenStack-5.1-RelNotes', u'Release Notes', u'2014, Mirantis Inc.'),
|
||||
]
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
.. cssclass:: header-table
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.1 | .. cssclass:: right|
|
||||
| | |
|
||||
| Operations Guide | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
.. cssclass:: header-table
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.1 | .. cssclass:: right|
|
||||
| | |
|
||||
| Planning Guide | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
.. cssclass:: header-table
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.1 | .. cssclass:: right|
|
||||
| | |
|
||||
| Reference Architecture | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
.. cssclass:: header-table
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.1 | .. cssclass:: right|
|
||||
| | |
|
||||
| Release Notes | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
|
|
@ -22,10 +22,6 @@
|
|||
|
||||
PageBreak oneColumn
|
||||
|
||||
.. toctree::
|
||||
|
||||
.. include:: /pages/preface/preface.rst
|
||||
|
||||
.. _release-notes:
|
||||
|
||||
.. include:: /contents/contents-release-notes.rst
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
.. cssclass:: header-table
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.1 | .. cssclass:: right|
|
||||
| | |
|
||||
| Terminology Reference | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
.. cssclass:: header-table
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.1 | .. cssclass:: right|
|
||||
| | |
|
||||
| User Guide | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
.. cssclass:: header-table
|
||||
|
||||
+------------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.1 | .. cssclass:: right|
|
||||
| | |
|
||||
| Running Mirantis OpenStack on VirtualBox | ###Section### |
|
||||
+------------------------------------------+-----------------------------------+
|
||||
|
|
|
|||
Loading…
Reference in New Issue