Update control files to 5.0 and date to May 2014
List of major releases is removed from preface.rst: the intention of this table is to track revisions of documentation for the current major release. Change-Id: If0d87ccfdcb9b312174a6e1ddeefa03dd38f253f
This commit is contained in:
Meg McRoberts
Dmitry Borodaenko
parent
899168af2f
commit
18850814d1
@ -58,10 +58,10 @@ copyright = u'2014, Mirantis Inc.'
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '4.1'
|
||||
version = '5.0'
|
||||
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '4.1'
|
||||
release = '5.0'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
||||
14
index.rst
14
index.rst
@ -15,36 +15,36 @@ PDFs
|
||||
---------
|
||||
The following Mirantis OpenStack documentation is available in PDF:
|
||||
|
||||
* `Pre-Installation Guide <pdf/Mirantis-OpenStack-4.1-Pre-InstallationGuide.pdf>`_
|
||||
* `Pre-Installation Guide <pdf/Mirantis-OpenStack-5.0-Pre-InstallationGuide.pdf>`_
|
||||
|
||||
Prerequisites and pre-installation steps that you must execute before
|
||||
installing Fuel.
|
||||
|
||||
* `Installation Guide <pdf/Mirantis-OpenStack-4.1-InstallGuide.pdf>`_
|
||||
* `Installation Guide <pdf/Mirantis-OpenStack-5.0-InstallGuide.pdf>`_
|
||||
|
||||
This document describes how to pre-configure your
|
||||
OpenStack environment and install the Fuel Master Node.
|
||||
|
||||
* `User Guide <pdf/Mirantis-OpenStack-4.1-UserGuide.pdf>`_
|
||||
* `User Guide <pdf/Mirantis-OpenStack-5.0-UserGuide.pdf>`_
|
||||
|
||||
This document describes how to deploy compute nodes for Fuel.
|
||||
|
||||
* `Operations Guide <pdf/Mirantis-OpenStack-4.1-OperationsGuide.pdf>`_
|
||||
* `Operations Guide <pdf/Mirantis-OpenStack-5.0-OperationsGuide.pdf>`_
|
||||
|
||||
A collection of useful procedures for using and managing
|
||||
your Mirantis OpenStack environment.
|
||||
|
||||
* `Reference Architecture <pdf/Mirantis-OpenStack-4.1-ReferenceArchitecture.pdf>`_
|
||||
* `Reference Architecture <pdf/Mirantis-OpenStack-5.0-ReferenceArchitecture.pdf>`_
|
||||
|
||||
A deep dive into the structure of the Fuel OpenStack environment,
|
||||
network considerations, and deployment options.
|
||||
|
||||
* `Terminology Reference <pdf/Mirantis-OpenStack-4.1-Terminology-Reference.pdf>`_
|
||||
* `Terminology Reference <pdf/Mirantis-OpenStack-5.0-Terminology-Reference.pdf>`_
|
||||
|
||||
Short articles about OpenStack terminology and technology
|
||||
with references to other documentation and other useful information.
|
||||
|
||||
* `Release Notes 4.1 <pdf/Mirantis-OpenStack-4.1-RelNotes.pdf>`_
|
||||
* `Release Notes 5.0 <pdf/Mirantis-OpenStack-5.0-RelNotes.pdf>`_
|
||||
|
||||
The Release Notes provide general information about new features,
|
||||
fixed issues, and known limitations in Mirantis OpenStack |version|.
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
|
||||
.. _install-guide:
|
||||
|
||||
=====================
|
||||
==================
|
||||
Installation Guide
|
||||
=====================
|
||||
==================
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 3
|
||||
|
||||
@ -10,8 +10,8 @@ Before You Download and Install Fuel
|
||||
Before downloading and installing Fuel:
|
||||
|
||||
- Be sure that you your hardware configuration is adequate;
|
||||
check the `Prerequisites information <http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#prerequisites>`_.
|
||||
check the `Prerequisites information <http://docs.mirantis.com/fuel/fuel-5.0/install-guide.html#prerequisites>`_.
|
||||
|
||||
- Understand the network architecture and define your network configuration;
|
||||
see `Understanding and Configuring the Network <http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#understanding-and-configuring-the-network>`_
|
||||
and `Network Architecture <http://docs.mirantis.com/fuel/fuel-4.0/reference-architecture.html#network-architecture>`_.
|
||||
see `Understanding and Configuring the Network <http://docs.mirantis.com/fuel/fuel-5.0/install-guide.html#understanding-and-configuring-the-network>`_
|
||||
and `Network Architecture <http://docs.mirantis.com/fuel/fuel-5.0/reference-architecture.html#network-architecture>`_.
|
||||
|
||||
@ -7,30 +7,25 @@
|
||||
.. _Preface:
|
||||
|
||||
Preface
|
||||
=============================
|
||||
=======
|
||||
|
||||
This documentation provides information on how to use Mirantis Fuel
|
||||
to deploy OpenStack environment. The information is for reference purposes
|
||||
and is subject to change.
|
||||
|
||||
Intended Audience
|
||||
-----------------------------
|
||||
-----------------
|
||||
|
||||
This documentation is intended for OpenStack administrators and
|
||||
assumes that you have experience with network and cloud concepts.
|
||||
|
||||
Documentation History
|
||||
-----------------------------
|
||||
---------------------
|
||||
|
||||
The following table lists the released revisions of this documentation:
|
||||
|
||||
+--------------------+----------------------------+
|
||||
|Revision Date |Description |
|
||||
+====================+============================+
|
||||
|October, 2013 |3.2 GA |
|
||||
+--------------------+----------------------------+
|
||||
|December, 2013 |3.2.1 GA |
|
||||
+--------------------+----------------------------+
|
||||
|December, 2013 |4.0 GA |
|
||||
+--------------------+----------------------------+
|
||||
|March, 2014 |4.1 GA |
|
||||
|May, 2014 |5.0 GA |
|
||||
+--------------------+----------------------------+
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
Issues Resolved in Mirantis OpenStack 4.1
|
||||
Issues Resolved in Mirantis OpenStack 5.0
|
||||
=========================================
|
||||
|
||||
@ -88,7 +88,7 @@ with a VLAN splinters workaround enabled in two separate modes -- soft trunks an
|
||||
This introduces additional performance overhead.
|
||||
In the hard trunks mode, you should use fewer than 50 VLANs in the Neutron VLAN mode.
|
||||
|
||||
See `Advanced Network Configuration using Open VSwitch <http://docs.mirantis.com/fuel/fuel-4.1/reference-architecture.html?highlight=vlan%20splinters#advanced-network-configuration-using-open-vswitch>`_
|
||||
See `Advanced Network Configuration using Open VSwitch <http://docs.mirantis.com/fuel/fuel-5.0/reference-architecture.html?highlight=vlan%20splinters#advanced-network-configuration-using-open-vswitch>`_
|
||||
for more information about using Open VSwitch..
|
||||
|
||||
GRE-enabled Neutron installation runs inter VM traffic through management network
|
||||
|
||||
@ -16,23 +16,23 @@ The following documents provide information:
|
||||
|
||||
* For a list of the types of networks used in OpenStack
|
||||
(Public, Storage, Administrative, and so forth), see
|
||||
`Network Configuration Options <http://docs.mirantis.com/fuel/fuel-4.1/pre-install-guide.html#network-configuration-options>`_
|
||||
`Network Configuration Options <http://docs.mirantis.com/fuel/fuel-5.0/pre-install-guide.html#network-configuration-options>`_
|
||||
|
||||
* For diagrams, detailed discussions, and instructions for deploying
|
||||
the different networking models, see
|
||||
`Network Deployment Models <http://docs.mirantis.com/fuel/fuel-4.1/pre-install-guide.html#network-deployment-models>`_,
|
||||
`Understanding and Configuring the Network <http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#understanding-and-configuring-the-network>`_, and
|
||||
`Fuel Deployment Schema <http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#fuel-deployment-schema>`_
|
||||
`Network Deployment Models <http://docs.mirantis.com/fuel/fuel-5.0/pre-install-guide.html#network-deployment-models>`_,
|
||||
`Understanding and Configuring the Network <http://docs.mirantis.com/fuel/fuel-5.0/install-guide.html#understanding-and-configuring-the-network>`_, and
|
||||
`Fuel Deployment Schema <http://docs.mirantis.com/fuel/fuel-5.0/install-guide.html#fuel-deployment-schema>`_
|
||||
|
||||
* For information about calculating the hardware required for your deployment, see
|
||||
`Calculating Network <http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#calculating-network>`_.
|
||||
`Calculating Network <http://docs.mirantis.com/fuel/fuel-5.0/install-guide.html#calculating-network>`_.
|
||||
|
||||
* `Installing Fuel Master Node <http://docs.mirantis.com/fuel/fuel-4.1/install-guide.html#installing-fuel-master-node>`_
|
||||
* `Installing Fuel Master Node <http://docs.mirantis.com/fuel/fuel-5.0/install-guide.html#installing-fuel-master-node>`_
|
||||
includes instructions for changing network parameters
|
||||
during and after installation.
|
||||
|
||||
* `Advanced Network Configuration Using VSwitch <http://docs.mirantis.com/fuel/fuel-4.1/reference-architecture.html#advanced-network-configuration-using-open-vswitch>`_
|
||||
* `Advanced Network Configuration Using VSwitch <http://docs.mirantis.com/fuel/fuel-5.0/reference-architecture.html#advanced-network-configuration-using-open-vswitch>`_
|
||||
describes Open VSwitch and includes instructions for adjusting the network configuration
|
||||
by editing configuration files and using the command-line tools.
|
||||
|
||||
* `Network Architecture <http://docs.mirantis.com/fuel/fuel-4.1/reference-architecture.html#network-architecture>`_
|
||||
* `Network Architecture <http://docs.mirantis.com/fuel/fuel-5.0/reference-architecture.html#network-architecture>`_
|
||||
|
||||
@ -16,6 +16,6 @@ Each tenant has a virtual Neutron router with one or more private networks,
|
||||
each of which can communicate with the outside world.
|
||||
This allows full routing isolation for each tenant private network.
|
||||
|
||||
See `Neutron Deployment <http://docs.mirantis.com/fuel/fuel-4.1/pre-install-guide.html#neutron>`_
|
||||
See `Neutron Deployment <http://docs.mirantis.com/fuel/fuel-5.0/pre-install-guide.html#neutron>`_
|
||||
for a description of the recommended network configuration parameters
|
||||
for using the Neutron service.
|
||||
|
||||
@ -7,7 +7,7 @@ Nova Network
|
||||
The Nova-network model was the original networking model for OpenStack.
|
||||
It supports two topologies -- the FlatDHCPManager and VLAN Manager --
|
||||
that can be used to deploy private networks for tenants;
|
||||
see `Nova-network Deployment Model <http://docs.mirantis.com/fuel/fuel-4.1/pre-install-guide.html#nova-network>`_
|
||||
see `Nova-network Deployment Model <http://docs.mirantis.com/fuel/fuel-5.0/pre-install-guide.html#nova-network>`_
|
||||
for more information about using Nova-network in Mirantis OpenStack.
|
||||
|
||||
Nova network is scheduled for deprecation
|
||||
|
||||
12
pdf/conf.py
12
pdf/conf.py
@ -17,12 +17,12 @@ execfile('../common_conf.py')
|
||||
exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide', '*.rst']
|
||||
|
||||
pdf_documents = [
|
||||
('pdf/pdf_user', u'Mirantis-OpenStack-4.1-UserGuide', u'User Guide',
|
||||
('pdf/pdf_user', u'Mirantis-OpenStack-5.0-UserGuide', u'User Guide',
|
||||
u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_install', u'Mirantis-OpenStack-4.1-InstallGuide', u'Installation Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_operations', u'Mirantis-OpenStack-4.1-OperationsGuide', u'Operations Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_reference', u'Mirantis-OpenStack-4.1-ReferenceArchitecture', u'Reference Architecture', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_preinstall', u'Mirantis-OpenStack-4.1-Pre-InstallationGuide', u'Pre-Installation Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_terminology', u'Mirantis-OpenStack-4.1-Terminology-Reference', u'Terminology Reference', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_install', u'Mirantis-OpenStack-5.0-InstallGuide', u'Installation Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_operations', u'Mirantis-OpenStack-5.0-OperationsGuide', u'Operations Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_reference', u'Mirantis-OpenStack-5.0-ReferenceArchitecture', u'Reference Architecture', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_preinstall', u'Mirantis-OpenStack-5.0-Pre-InstallationGuide', u'Pre-Installation Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_terminology', u'Mirantis-OpenStack-5.0-Terminology-Reference', u'Terminology Reference', u'2014, Mirantis Inc.'),
|
||||
# (master_doc, project, project, copyright),
|
||||
]
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
.. header::
|
||||
|
||||
.. cssclass:: header-table
|
||||
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v4.1 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| | |
|
||||
| Installation Guide | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
@ -11,7 +11,7 @@
|
||||
.. footer::
|
||||
|
||||
.. cssclass:: footer-table
|
||||
|
||||
|
||||
+--------------------------+----------------------+
|
||||
| | .. cssclass:: right|
|
||||
| | |
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
.. header::
|
||||
|
||||
.. cssclass:: header-table
|
||||
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v4.1 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| | |
|
||||
| Operations Guide | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
@ -11,7 +11,7 @@
|
||||
.. footer::
|
||||
|
||||
.. cssclass:: footer-table
|
||||
|
||||
|
||||
+--------------------------+----------------------+
|
||||
| | .. cssclass:: right|
|
||||
| | |
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
.. header::
|
||||
|
||||
.. cssclass:: header-table
|
||||
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v4.1 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| | |
|
||||
| Pre-Installation Guide | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
@ -11,7 +11,7 @@
|
||||
.. footer::
|
||||
|
||||
.. cssclass:: footer-table
|
||||
|
||||
|
||||
+--------------------------+----------------------+
|
||||
| | .. cssclass:: right|
|
||||
| | |
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
.. header::
|
||||
|
||||
.. cssclass:: header-table
|
||||
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v4.1 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| | |
|
||||
| Reference Architecture | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
@ -11,7 +11,7 @@
|
||||
.. footer::
|
||||
|
||||
.. cssclass:: footer-table
|
||||
|
||||
|
||||
+--------------------------+----------------------+
|
||||
| | .. cssclass:: right|
|
||||
| | |
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
.. cssclass:: header-table
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v4.1 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| | |
|
||||
| Terminology Reference | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
.. header::
|
||||
|
||||
.. cssclass:: header-table
|
||||
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v4.1 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| | |
|
||||
| User Guide | ###Section### |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
@ -11,7 +11,7 @@
|
||||
.. footer::
|
||||
|
||||
.. cssclass:: footer-table
|
||||
|
||||
|
||||
+--------------------------+----------------------+
|
||||
| | .. cssclass:: right|
|
||||
| | |
|
||||
|
||||
@ -58,10 +58,10 @@ copyright = u'2014, Mirantis Inc.'
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '4.1'
|
||||
version = '5.0'
|
||||
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '4.1'
|
||||
release = '5.0'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
@ -281,7 +281,7 @@ nwdiag_antialias = True
|
||||
|
||||
extensions += ['rst2pdf.pdfbuilder']
|
||||
pdf_documents = [
|
||||
('relnotes/index', u'Mirantis-OpenStack-4.1-RelNotes', u'Release Notes',
|
||||
('relnotes/index', u'Mirantis-OpenStack-5.0-RelNotes', u'Release Notes',
|
||||
u'2014, Mirantis Inc.')
|
||||
# (master_doc, project, project, copyright),
|
||||
]
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
.. header::
|
||||
|
||||
.. cssclass:: header-table
|
||||
|
||||
|
||||
+-------------------------------------+-----------------------------------+
|
||||
| Mirantis OpenStack v4.1 | .. cssclass:: right|
|
||||
| Mirantis OpenStack v5.0 | .. cssclass:: right|
|
||||
| | |
|
||||
| | Release Notes |
|
||||
+-------------------------------------+-----------------------------------+
|
||||
@ -11,7 +11,7 @@
|
||||
.. footer::
|
||||
|
||||
.. cssclass:: footer-table
|
||||
|
||||
|
||||
+--------------------------+----------------------+
|
||||
| ©2014, Mirantis Inc. | .. cssclass:: right|
|
||||
| | |
|
||||
@ -22,4 +22,4 @@
|
||||
|
||||
PageBreak oneColumn
|
||||
|
||||
.. include:: /pages/release-notes/v4-1-havana-full.rst
|
||||
.. include:: /pages/release-notes/v5-0-icehouse-full.rst
|
||||
|
||||
Loading…
Reference in New Issue
Block a user