Replace intro material for Planning and User Guides
This replaces 94510 Changes for new intro: - pre-install -- 0010-intro text is replaced with new material - user-guide -- 0000-intro text is replaced with new material - install-guide -- deleted 0000-intro-header and the contents of the 0000-intro subdirectory (they were deleted in 94510 because they are no longer needed) This also pulls install-guide out of the build. This is necessary to make the 5.0 release and is not a permanent change so unused files such as those in the contents/ and pdf/ directories have not been removed: - contents.rst - index.rst - install-guide.rst - pdf/conf.py -- had to delete the install-guide line Modified some top-level *.rst files trying to resolve build and xref issues -- some of these tags had _ rather than - which causes problems. Change-Id: I9ab382034caf2ecb7aaa9c552d10552e97be89cf
This commit is contained in:
Meg McRoberts
Matthew Mosesohn
parent
2b577b48f4
commit
a97a5d91f5
|
|
@ -13,7 +13,6 @@ Documentation
|
|||
:maxdepth: 3
|
||||
|
||||
pre-install-guide
|
||||
install-guide
|
||||
user-guide
|
||||
operations
|
||||
virtualbox
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ The following Mirantis OpenStack documentation is available in PDF:
|
|||
Prerequisites and pre-installation steps that you must execute before
|
||||
installing Fuel and deploying Mirantis OpenStack.
|
||||
|
||||
* `Installation Guide <pdf/Mirantis-OpenStack-5.0-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.
|
||||
|
|
|
|||
|
|
@ -1,12 +0,0 @@
|
|||
.. index:: Installation Guide
|
||||
|
||||
.. _install-guide:
|
||||
|
||||
==================
|
||||
Installation Guide
|
||||
==================
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 3
|
||||
|
||||
.. include:: /contents/contents-install.rst
|
||||
|
|
@ -1,6 +1,5 @@
|
|||
|
||||
.. include:: /pages/install-guide/0000-intro/0000-intro-header.rst
|
||||
.. include:: /pages/install-guide/0000-intro/0100-fuel-intro.rst
|
||||
.. include:: /pages/install-guide/0000-intro/0200-deploy-modes.rst
|
||||
.. include:: /pages/install-guide/0000-intro/0300-nodetypes-intro.rst
|
||||
.. include:: /pages/install-guide/0000-intro/0500-install-summary.rst
|
||||
.. _install-guide-intro:
|
||||
|
||||
Introduction to the Installation Guide
|
||||
======================================
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
.. index:: Introduction
|
||||
|
||||
.. _Introduction:
|
||||
|
||||
Introduction
|
||||
============
|
||||
This section introduces Fuel for OpenStack and its components.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
Introducing Fuel for OpenStack
|
||||
------------------------------
|
||||
|
||||
Mirantis Fuel for OpenStack is a set of deployment tools that helps you to
|
||||
quickly deploy your cloud environment. Fuel includes the scripts that
|
||||
dramatically facilitate and speed up the process of cloud deployment.
|
||||
Typically, OpenStack installation requires you familiarize yourself
|
||||
with the processes of installation of OpenStack environment components.
|
||||
Fuel eliminates the need to study these processes. With Fuel, system
|
||||
administrators can provision an OpenStack single node, as well as
|
||||
clustered cloud in terms of minutes.
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
Deployment Modes
|
||||
----------------
|
||||
|
||||
You can use Fuel for OpenStack to create virtually any OpenStack
|
||||
configuration. However, Mirantis provides several pre-defined
|
||||
architectures for your convenience.
|
||||
The pre-defined architectures include:
|
||||
|
||||
* **Multi-node**
|
||||
The Multi-node environment provides an easy way
|
||||
to install an entire OpenStack environment without requiring the degree
|
||||
of increased hardware involved in ensuring high availability.
|
||||
Mirantis recommends that you use this architecture for testing
|
||||
purposes.
|
||||
|
||||
* **Multi-node HA**
|
||||
The Multi-node with HA environment is dedicated for highly available
|
||||
production deployments. Using Multi-node with HA you can deploy
|
||||
additional services, such as Cinder, Neutron, and Ceph.
|
||||
You can create the following multi-node environments:
|
||||
|
||||
With Fuel, you can create your own cloud environment that includes
|
||||
additional components.
|
||||
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
About Fuel and OpenStack Components
|
||||
-----------------------------------
|
||||
|
||||
You can use Fuel to quickly deploy and manage the OpenStack environment.
|
||||
|
||||
Fuel includes the following components:
|
||||
|
||||
* **Master Node**
|
||||
The Fuel Master Node is the lifecycle management application for
|
||||
deployment and managing OpenStack. It sits outside the OpenStack
|
||||
environment and services as a control plane for multiple OpenStack
|
||||
envionments.
|
||||
|
||||
* **Controller Node**
|
||||
A controller node that manages the OpenStack environment including
|
||||
deployment of additional controller and compute nodes, configuring
|
||||
network settings, and so on. For HA deployments, Mirantis recommends
|
||||
to deploy at least 3 controller nodes.
|
||||
|
||||
* **Compute Node(s)**
|
||||
A compute node is a server where you run virtual machines and
|
||||
applications.
|
||||
|
||||
* **Storage Node(s)**
|
||||
Optional component. You can deploy a separate Swift or Ceph storage
|
||||
node. Mirantis recommends to deploy standalone storage nodes for high
|
||||
availability environments.
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
Fuel Installation Procedures
|
||||
----------------------------
|
||||
You must complete the following tasks to use Fuel to deploy OpenStack
|
||||
clouds:
|
||||
|
||||
1. Install the Fuel Master Node on physical or virtual hardware using
|
||||
the Fuel installation image
|
||||
2. Set the other nodes to boot from the network and power them on
|
||||
to make them accessible for Fuel Master node
|
||||
3. Assign your desired roles to the discovered nodes using Fuel
|
||||
UI or CLI.
|
||||
|
||||
Fuel is designed to maintain the OpenStack environment while providing
|
||||
the flexibility to adapt it to your configuration.
|
||||
|
||||
.. image:: /_images/how-it-works.*
|
||||
:width: 80%
|
||||
:align: center
|
||||
|
||||
|
||||
|
|
@ -1,27 +1,67 @@
|
|||
|
||||
Introduction
|
||||
============
|
||||
.. _Planning-Introduction:
|
||||
|
||||
Fuel for OpenStack is designed to provide various options for setup. This
|
||||
document provides instructions on how to set up your OpenStack environment,
|
||||
including hardware, cabling, and networking infrastructure.
|
||||
Introduction to Mirantis OpenStack and Fuel
|
||||
===========================================
|
||||
|
||||
Installing Fuel for OpenStack includes the following tasks:
|
||||
OpenStack is an extensible, versatile, and flexible
|
||||
cloud management platform.
|
||||
It is a portfolio of cloud infrastructure services –
|
||||
compute, storage, networking and other core resources —
|
||||
that are exposed through ReST APIs.
|
||||
It enables a wide range of control over these services,
|
||||
both from the perspective of
|
||||
an Integrated Infrastructure as a Service (IaaS)
|
||||
controlled by applications
|
||||
and as a set of tools that enable
|
||||
automated manipulation of the infrastructure itself.
|
||||
|
||||
#. Verify system requirements of your Fuel server and Node servers.
|
||||
Mirantis OpenStack is a productized snapshot
|
||||
of the open source technologies.
|
||||
It includes Fuel, a graphical web tool
|
||||
that helps you to quickly deploy your cloud environment.
|
||||
Fuel includes scripts
|
||||
that dramatically facilitate and speed up the process of cloud deployment,
|
||||
without requiring you to completely familiarize yourself
|
||||
with the intricate processes required
|
||||
to install the OpenStack environment components.
|
||||
|
||||
#. Determine which networking setup to use, based on available hardware,
|
||||
specific requirements for your environment, and which features are
|
||||
suitable for your deployment.
|
||||
You can run Fuel to deploy a Mirantis OpenStack Environment
|
||||
on Oracle VirtualBox.
|
||||
VirtualBox deployment is useful for demonstrations
|
||||
and is a good way to begin your exploration of the tools and technologies
|
||||
and is discussed in :ref:`Running Fuel on VirtualBox<virtualbox-top>`.
|
||||
However, it is worth noting that deployments on top of VirtualBox
|
||||
generally do not meet the performance and robustness requirements
|
||||
of most production environments.
|
||||
|
||||
#. Complete the pre-installation checklist.
|
||||
This guide provides details
|
||||
to get you started with Mirantis OpenStack and Fuel
|
||||
on a set of physical servers ("bare-metal installation")
|
||||
See the :ref:`User Guide<User-Guide>` for detailed instructions about
|
||||
how to download and install Fuel on the Fuel Master Node
|
||||
and then how to use the Fuel interface
|
||||
to deploy your OpenStack environment.
|
||||
|
||||
#. Assemble the networking configuration from your network plan.
|
||||
Other documents in the guide provide additional information:
|
||||
|
||||
#. Install Fuel server.
|
||||
- :ref:`Terminology Reference<terminology-ref>` is an alphabetical listing
|
||||
of technologies and concepts
|
||||
that serves as both a glossary and a master index
|
||||
of information in the Mirantis docs and the open source documentation.
|
||||
- :ref:`Operations Guide<operations-guide>` gives information about advanced tasks
|
||||
required to maintain the OpenStack environment after it is deployed.
|
||||
Most of these tasks are done in the shell
|
||||
using text editors and command line tools.
|
||||
- :ref:`Reference Architecture<ref-arch>` provides background information
|
||||
about how Mirantis OpenStack and its supporting HA architecture
|
||||
is implemented.
|
||||
|
||||
#. Configure Fuel for your environment.
|
||||
|
||||
#. Install Node servers.
|
||||
|
||||
#. Verify your successful deployment.
|
||||
For community members or partners looking to take Fuel even further,
|
||||
see the `developer documentation <http://docs.mirantis.com/fuel-dev/develop.html>`_
|
||||
for information about the internal architecture of Fuel,
|
||||
instructions for building the project,
|
||||
information about interacting with the REST API
|
||||
and other topics of interest to more advanced developers.
|
||||
You can also visit the `Fuel project <https://launchpad.net/fuel>`_
|
||||
for more detailed information and become a contributor.
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ Some general guiding principles:
|
|||
and to avoid performance bottlenecks.
|
||||
- For demonstration and study purposes,
|
||||
you can deploy OpenStack on VirtualBox;
|
||||
see :ref:`virtualbox` for more information.
|
||||
see :ref:`virtualbox-top` for more information.
|
||||
This option has the lowest hardware requirements
|
||||
- OpenStack can be deployed on smaller hardware configurations
|
||||
by combining multiple roles on the nodes
|
||||
|
|
|
|||
|
|
@ -17,8 +17,8 @@ Fuel places different types of traffic into separate logical networks.
|
|||
This section describes how to distribute
|
||||
the network traffic in an OpenStack cluster.
|
||||
|
||||
Refer to :ref:`User_Guide` for instructions on how to configure network for
|
||||
your OpenStack environment.
|
||||
Refer to :ref:`User-Guide` for instructions on how to configure
|
||||
the network for your OpenStack environment.
|
||||
|
||||
.. index:: Admin (PXE) Network
|
||||
|
||||
|
|
|
|||
|
|
@ -1,48 +1,38 @@
|
|||
|
||||
.. index:: Introduction
|
||||
|
||||
.. _User_Introduction:
|
||||
.. _User-Introduction:
|
||||
|
||||
Introducing Fuel for OpenStack
|
||||
===============================
|
||||
Introduction to the User Guide
|
||||
==============================
|
||||
|
||||
OpenStack is an extensible, versatile, and flexible cloud management
|
||||
platform. By exposing its portfolio of cloud infrastructure services –
|
||||
compute, storage, networking and other core resources — through ReST APIs,
|
||||
OpenStack enables a wide range of control over these services, both from the
|
||||
perspective of an integrated Infrastructure as a Service (IaaS) controlled
|
||||
by applications, as well as automated manipulation of the infrastructure
|
||||
itself.
|
||||
This guide gives instructions for using
|
||||
the Fuel Master node and the graphical Fuel screens
|
||||
to deploy a Mirantis OpenStack environment.
|
||||
Before you do the procedures in this document,
|
||||
you should work through the information and procedures in the
|
||||
:ref:`Planning Guide<planning-guide>`.
|
||||
That document discusses the planning decisions
|
||||
required before you install and deploy Mirantis OpenStack.
|
||||
|
||||
This architectural flexibility doesn’t set itself up magically. It asks you,
|
||||
the user and cloud administrator, to organize and manage an extensive array
|
||||
of configuration options. Consequently, getting the most out of your
|
||||
OpenStack cloud over time – in terms of flexibility, scalability, and
|
||||
manageability – requires a thoughtful combination of complex configuration
|
||||
choices. This can be very time consuming and requires that you become
|
||||
familiar with much of the documentation from the number of different projects.
|
||||
Further reading is available in the following documents:
|
||||
|
||||
Mirantis Fuel for OpenStack was created to eliminate exactly these problems.
|
||||
This step-by-step guide takes you through this process of:
|
||||
- :ref:`Terminology Reference<Terminology-ref>` is an alphabetical listing
|
||||
of technologies and concepts
|
||||
that serves as both a glossary and a master index
|
||||
of information in the Mirantis docs and other sources of information.
|
||||
- :ref:`Operations Guide<operations-guide>` gives information about advanced tasks
|
||||
required to maintain the OpenStack environment after it is deployed.
|
||||
Most of these tasks are done in the shell
|
||||
using text editors and command line tools.
|
||||
- :ref:`Reference Architecture<ref-arch>` provides background information
|
||||
about how OpenStack works.
|
||||
|
||||
* Configuring OpenStack and its supporting components into a robust cloud
|
||||
architecture
|
||||
* Deploying that architecture through an effective, well-integrated automation
|
||||
package that sets up and maintains the components and their configurations
|
||||
* Providing access to a tested, integrated, and up-to-date set of components
|
||||
proven to work together
|
||||
|
||||
Fuel for OpenStack can be used to create and support many popular OpenStack
|
||||
configurations. To make the process easier, the installation includes several
|
||||
pre-defined architectures. For the sake of simplicity, this guide emphasizes
|
||||
a single, common reference architecture; the multi-node, high-availability
|
||||
configuration. We begin with an explanation of this architecture, then move
|
||||
on to the details of creating the configuration in a test environment using
|
||||
VirtualBox. Finally, we provide you the information you need to know to create
|
||||
this and other OpenStack architectures in a production environment.
|
||||
|
||||
For community members or partners looking to take Fuel even further, we’ve
|
||||
supplied `developer documentation <http://docs.mirantis.com/fuel-dev/develop.html>`_
|
||||
on the internal architecture of Fuel, instructions on building the project,
|
||||
information on interacting with the REST API and other topics of interest to
|
||||
more advanced developers. You can also visit the `Fuel project <https://launchpad.net/fuel>`_
|
||||
for more detailed information and become a contributor.
|
||||
For community members and partners looking to take Fuel even further,
|
||||
see the `developer documentation <http://docs.mirantis.com/fuel-dev/develop.html>`_
|
||||
for information about the internal architecture of Fuel,
|
||||
instructions for building the project,
|
||||
information about interacting with the REST API
|
||||
and other topics of interest to more advanced developers.
|
||||
You can also visit the `Fuel project <https://launchpad.net/fuel>`_
|
||||
for more detailed information and become a contributor.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,6 @@ exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide', '
|
|||
|
||||
pdf_documents = [
|
||||
('pdf/pdf_preinstall', u'Mirantis-OpenStack-5.0-PlanningGuide', u'Planning Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_install', u'Mirantis-OpenStack-5.0-InstallGuide', u'Installation 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.'),
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
.. index:: Release Notes
|
||||
|
||||
.. _release-notes:
|
||||
|
||||
=============
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
.. _terminology:
|
||||
|
||||
.. _terminology-ref:
|
||||
|
||||
=====================
|
||||
Terminology Reference
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
|
||||
.. index:: User Guide
|
||||
.. _User_Guide:
|
||||
|
||||
.. _User-Guide:
|
||||
|
||||
=====================
|
||||
User Guide
|
||||
|
|
|
|||
|
|
@ -1,10 +1,9 @@
|
|||
.. index:: VirtualBox Installation
|
||||
|
||||
.. _virtualbox:
|
||||
.. _virtualbox-top:
|
||||
|
||||
==========================
|
||||
Running Fuel on VirtualBox
|
||||
==========================
|
||||
=======================
|
||||
VirtualBox Installation
|
||||
=======================
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 2
|
||||
|
|
|
|||
Loading…
Reference in New Issue