Changed: Fuel Web -> Fuel UI, Fuel Library -> Fuel CLI

This commit is contained in:
Pavel Lechenko 2013-07-31 19:39:46 +04:00
parent 44fe67642c
commit ea2a9efcf6
41 changed files with 184 additions and 123 deletions

3
.gitignore vendored
View File

@ -1,2 +1,3 @@
/_build
/_images/*_svg.png
/_images/*_svg.png
/.idea

View File

@ -1,3 +1,8 @@
.. index: Table of Contents
.. _ToC:
=================
Table of Contents
=================
@ -9,8 +14,8 @@ Table of Contents
pages/0020-about-fuel
pages/0030-release-notes
pages/0040-reference-architecture
pages/0045-installation-fuel-web
pages/0050-installation-instructions
pages/0045-installation-fuel-ui
pages/0050-installation-fuel-cli
pages/0055-production-considerations
pages/0060-frequently-asked-questions
copyright

View File

@ -1,5 +1,6 @@
.. index:: license
.. index:: License
============
Fuel License
============

View File

@ -1,5 +1,10 @@
Introduction to Fuel for OpenStack
==================================
.. index: Introduction
.. _Introduction:
===================================
Introduction to Fuel™ for OpenStack
===================================
OpenStack is an extensible, versatile, and flexible cloud management platform.
By exposing its portfolio of cloud infrastructure services compute, storage,
@ -16,7 +21,7 @@ requires a thoughtful combination of complex configuration choices. This can be
very time consuming and requires a significant amount of studious documentation
to comprehend.
Mirantis Fuel for OpenStack was created to eliminate exactly these problems.
Mirantis Fuel for OpenStack was created to eliminate exactly these problems.
This step-by-step guide takes you through this process of:
* Configuring OpenStack and its supporting components into a robust cloud
@ -48,11 +53,11 @@ The Fuel User Guide is organized as follows:
* :ref:`Reference Architecture <Reference-Architecture>`, provides a
general look at the components that make up OpenStack.
* :ref:`Create a multi-node OpenStack cluster using Fuel Web <Fuel-Web-Cluster>`,
* :ref:`Create a multi-node OpenStack cluster using Fuel UI <Create-Cluster-UI>`,
takes you step-by-step through the process of creating a high-availability
OpenStack cluster using Fuel Web.
* :ref:`Create a multi-node OpenStack cluster using Fuel <Create-Cluster>`,
* :ref:`Deploy an OpenStack cluster using Fuel CLI <Deploy-Cluster-CLI>`,
takes you step-by-step through the more advanced process of creating a
high-availability OpenStack cluster using the standard Fuel tools.
@ -62,12 +67,13 @@ The Fuel User Guide is organized as follows:
requirements, and provide tips and tricks for creating a cluster of up to 100
nodes.
* With the current (3.1) release Fuel and FuelWeb has been integrated. We encourage all
users to use the Fuel Web process for installation and configuration. However,
the standard Fuel installation process is still available for those of you who
* With the current (3.1) release Fuel UI (aka FuelWeb) and Fuel CLI
(aka Fuel Library) has been integrated. We encourage all users to use the Fuel
UI for installation and configuration. However,
the standard Fuel CLI installation process is still available for those who
prefer a more detailed approach to deployment. Even with a utility as powerful
as Fuel, creating an OpenStack cluster can be complex, and
:ref:`Frequently Asked Questions <FAQ>`, covers many of the issues that tend
:ref:`Frequently Asked Questions <FAQ>` covers many of the issues that tend
to arise during the process.
Lets start off by taking a look at Fuel itself. We'll start by explaining what

View File

@ -1,9 +1,37 @@
.. index: Introduction
==================================
Introduction to Fuel for OpenStack
==================================
.. This guide explains how to use Fuel to easily create and maintain an OpenStack
cloud infrastructure.
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 architectural flexibility doesnt 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 a significant amount of studious documentation
to comprehend.
Mirantis Fuel™ for OpenStack was created to eliminate exactly these problems.
This step-by-step guide takes you through this process of:
* 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 well-integrated, up-to-date set of components known to
work together
Fuel™ for OpenStack can be used to create virtually any OpenStack configuration.
To make things easier, the installation includes several pre-defined
architectures. For the sake of simplicity, this guide emphasises a single,
@ -26,11 +54,11 @@ The Fuel User Guide is organized as follows:
* :ref:`Reference Architecture <Reference-Architecture>`, provides a
general look at the components that make up OpenStack.
* :ref:`Create a multi-node OpenStack cluster using Fuel Web <Fuel-Web-Cluster>`,
* :ref:`Create a multi-node OpenStack cluster using Fuel UI <Create-Cluster-UI>`,
takes you step-by-step through the process of creating a high-availability
OpenStack cluster using Fuel Web.
* :ref:`Create a multi-node OpenStack cluster using Fuel <Create-Cluster>`,
* :ref:`Deploy an OpenStack cluster using Fuel CLI <Deploy-Cluster-CLI>`,
takes you step-by-step through the more advanced process of creating a
high-availability OpenStack cluster using the standard Fuel tools.
@ -40,12 +68,13 @@ The Fuel User Guide is organized as follows:
requirements, and provide tips and tricks for creating a cluster of up to 100
nodes.
* With the current (3.1) release Fuel and FuelWeb has been integrated. We encourage all
users to use the Fuel Web process for installation and configuration. However,
the standard Fuel installation process is still available for those of you who
* With the current (3.1) release Fuel UI (aka FuelWeb) and Fuel CLI
(aka Fuel Library) has been integrated. We encourage all users to use the Fuel
UI for installation and configuration. However,
the standard Fuel CLI installation process is still available for those who
prefer a more detailed approach to deployment. Even with a utility as powerful
as Fuel, creating an OpenStack cluster can be complex, and
:ref:`Frequently Asked Questions <FAQ>`, covers many of the issues that tend
:ref:`Frequently Asked Questions <FAQ>` covers many of the issues that tend
to arise during the process.
Lets start off by taking a look at Fuel itself. We'll start by explaining what

View File

@ -1,27 +0,0 @@
Preface
=======
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 architectural flexibility doesnt 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 a significant amount of studious documentation
to comprehend.
Mirantis Fuel for OpenStack was created to eliminate exactly these problems.
This step-by-step guide takes you through this process of:
* 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 well-integrated, up-to-date set of components known to
work together

View File

@ -1,5 +1,6 @@
.. _About_Fuel:
============
About Fuel
============

View File

@ -1,5 +1,10 @@
.. index: Release Notes
.. _Release_Notes:
=============
Release Notes
-------------
=============
.. include:: /pages/release-notes/v3-1-grizzly.rst
.. include:: /pages/release-notes/v3-0-grizzly.rst

View File

@ -1,5 +1,6 @@
.. _Reference-Architecture:
======================
Reference Architecture
======================

View File

@ -0,0 +1,11 @@
.. index: Deploy using UI
.. _Create-Cluster-UI:
============================================
Create an OpenStack cluster using Fuel UI
============================================
.. include:: /pages/installation-fuel-ui/install.rst
.. include:: /pages/installation-fuel-ui/networks.rst
.. include:: /pages/installation-fuel-ui/network-issues.rst

View File

@ -1,8 +0,0 @@
.. _Fuel-Web-Cluster:
Create a multi-node OpenStack cluster using FuelWeb
====================================================
.. include:: /pages/installation-fuel-web/install.rst
.. include:: /pages/installation-fuel-web/networks.rst
.. include:: /pages/installation-fuel-web/network-issues.rst

View File

@ -0,0 +1,18 @@
.. index: Deploy using CLI
.. _Deploy-Cluster-CLI:
==========================================
Deploy an OpenStack cluster using Fuel CLI
==========================================
.. _contents:: :local:
.. _include:: /pages/installation-fuel-cli/0000-preamble.rst
.. _include:: /pages/installation-fuel-cli/0010-introduction.rst
.. _include:: /pages/installation-fuel-cli/0015-before-you-start.rst
.. _include:: /pages/installation-fuel-cli/0020-machines.rst
.. _include:: /pages/installation-fuel-cli/0057-prepare-for-deployment.rst
.. include:: /pages/installation-fuel-cli/0060-understand-the-manifest.rst
.. include:: /pages/installation-fuel-cli/0070-orchestration.rst
.. include:: /pages/installation-fuel-cli/0080-testing-openstack.rst

View File

@ -1,15 +0,0 @@
.. _Create-Cluster:
Create a multi-node OpenStack cluster using Fuel
================================================
.. _contents:: :local:
.. _include:: /pages/installation-instructions/0000-preamble.rst
.. _include:: /pages/installation-instructions/0010-introduction.rst
.. _include:: /pages/installation-instructions/0015-before-you-start.rst
.. _include:: /pages/installation-instructions/0020-machines.rst
.. _include:: /pages/installation-instructions/0057-prepare-for-deployment.rst
.. include:: /pages/installation-instructions/0060-understand-the-manifest.rst
.. include:: /pages/installation-instructions/0070-orchestration.rst
.. include:: /pages/installation-instructions/0080-testing-openstack.rst

View File

@ -1,5 +1,8 @@
.. index: Production Considerations
.. _Production:
=========================
Production Considerations
=========================

View File

@ -1,5 +1,8 @@
.. _Production:
.. index: Advanced Topics
.. _Advanced:
=============================
Advanced Configuration Topics
=============================

View File

@ -1,5 +1,8 @@
.. index: FAQ (Frequently Asked Questions)
.. _FAQ:
================================
FAQ (Frequently Asked Questions)
================================

View File

@ -1,11 +0,0 @@
.. _Create-PM:
Appendix A: Creating Fuel-pm from scratch
==========================================
.. contents:: :local:
.. include:: /pages/creating-fuel-pm/0010-creating-fuel-pm-from-scratch.rst
.. include:: /pages/creating-fuel-pm/0045-configuring-fuel-pm.rst
.. include:: /pages/creating-fuel-pm/0050-installing-configuring-cobbler.rst
.. include:: /pages/creating-fuel-pm/0060-register-with-fuel.rst

View File

@ -1,5 +1,5 @@
What is Fuel?
-----------------
=============
Fuel is a ready-to-install collection of the packages and scripts you need to
create a robust, configurable, vendor-independant OpenStack cloud in your own
@ -18,3 +18,4 @@ OpenStack-based infrastructure in your own environment.
.. fancybox:: /_images/FuelSimpleDiagramv.png
:width: 300px
:height: 300px

View File

@ -1,42 +1,36 @@
.. index: How Fuel Works
.. _How-Fuel-Works:
How Fuel Works
--------------
==============
Fuel works on a simple premise. Rather than installing each of the myriad
components that make up OpenStack directly, you instead use a configuration
management system like Puppet to create scripts that can provide a configurable,
reproducible, sharable installation process.
In practice, that means that the process of using Fuel Library looks like this:
In practice, that means that the process of using Fuel looks like 1-2-3:
#. First, use Fuel's automation tools and instructions to set up a master
node with Puppet Master and Cobbler. This process only needs to be
completed once per installation.
1. First, set up Fuel Admin Node using the ISO. This process only needs to be
completed once per installation.
#. Next, use Fuel's snippets, kickstart files, and preseed files for Cobbler
to boot the appropriate servers from bare metal and automatically install
the appropriate operating systems. These virtual or physical servers boot
up already prepared to call on the Puppet Master to receive their
respective OpenStack components.
2. Next, discover your virtual or phisical nodes and configure your OpenStack
cluster using the Fuel UI.
#. Finally, to complete the basic OpenStack install, use Fuel's puppet
manifests to install OpenStack on the newly created servers. These
manifests are completely customizable, enabling you to start with one of
the included OpenStack architectures and adapt to your own situation as
necessary.
3. Finally, deploy your OpenStack cluster on discovered nodes. Fuel will do all
deployment magic for you by applying completely customizable Puppet manifests,
enabling you to maintain your cluster and adapt to your own configuration as
necessary.
.. image:: /_images/010-how-it-works_svg.png
.. fancybox:: /_images/010-how-it-works_svg.png
:width: 300px
:height: 300px
Fuel comes with several pre-defined deployment configurations, some of which
include additional options from which you can choose.
As of the 3.1 release of Fuel for OpenStack, FuelWeb is included as part of the
package. FuelWeb is a simplified way to deploy production-grade OpenStack
clouds. FuelWeb provides a streamlined, graphical console experience using the
underlying scripts from Fuel Library, including proven deployment configurations
and a well-organized workflow for deploying and managing OpenStack environments.
FuelWeb integrates all of the components of Fuel Library into a unified,
web-based graphical user interface that walks administrators through the process
of installing and configuring a fully functional OpenStack environment.
..
FuelWeb integrates all of the components of Fuel Library into a unified,
web-based graphical user interface that walks administrators through the
process of installing and configuring a fully functional OpenStack environment.

View File

@ -1,22 +1,54 @@
.. index: Deployment Configurations; Reference Architectures
.. _Deployment_Configurations:
Deployment Configurations Provided By Fuel
------------------------------------------
==========================================
One of the advantages of Fuel is that it comes with a number of pre-built deployment configurations that you can use to quickly build your own OpenStack cloud infrastructure. These are well-specified configurations of OpenStack and its constituent components are tailored to one or more common cloud use cases. Fuel provides the ability to create the following cluster types without requiring extensive customization:
One of the advantages of Fuel is that it comes with a number of pre-built
deployment configurations that you can use to quickly build your own OpenStack
cloud infrastructure. These are well-specified configurations of OpenStack and
its constituent components are tailored to one or more common cloud use cases.
Fuel provides the ability to create the following cluster types without requiring
extensive customization:
**Single node**: Perfect for getting a feel for how OpenStack works, the Single-node installation is the simplest way to get OpenStack up and running. The Single-node installation provides an easy way to install an entire OpenStack cluster on a single physical server system or in a virtual machine environment.
**Single node**: Perfect for getting a feel for how OpenStack works, the
Single-node installation is the simplest way to get OpenStack up and running.
The Single-node installation provides an easy way to install an entire OpenStack
cluster on a single physical server system or in a virtual machine environment.
**Multi-node (non-HA)**: The Multi-node (non-HA) installation enables you to try out additional OpenStack services like Cinder, Neutron (formerly Quantum), and Swift without requiring the degree of increased hardware involved in ensuring high availability. In addition to the ability to independently specify which services to activate, you also have the following options:
**Multi-node (non-HA)**: The Multi-node (non-HA) installation enables you to try
out additional OpenStack services like Cinder, Neutron (formerly Quantum), and
Swift without requiring the degree of increased hardware involved in ensuring
high availability. In addition to the ability to independently specify which
services to activate, you also have the following options:
**Compact Swift**: When you choose this option, Swift will be installed on your controllers, reducing your hardware requirements by eliminating the need for additional Swift servers.
**Compact Swift**: When you choose this option, Swift will be installed on
your controllers, reducing your hardware requirements by eliminating the need
for additional Swift servers.
**Standalone Swift**: This option enables you to install independant Swift nodes, so that you can separate their operation from your controller nodes.
**Standalone Swift**: This option enables you to install independant Swift
nodes, so that you can separate their operation from your controller nodes.
**Multi-node (HA)**: When you're ready to begin your move to production, the Multi-node (HA) configuration is a straightforward way to create an OpenStack cluster that provides high availability. With three controller nodes and the ability to individually specify services such as Cinder, Neutron, and Swift, Fuel provides the following variations of the Multi-node (HA) configuration:
**Multi-node (HA)**: When you're ready to begin your move to production, the
Multi-node (HA) configuration is a straightforward way to create an OpenStack
cluster that provides high availability. With three controller nodes and the
ability to individually specify services such as Cinder, Neutron, and Swift,
Fuel provides the following variations of the Multi-node (HA) configuration:
**Compact Swift**: When you choose this option, Swift will be installed on your controllers, reducing your hardware requirements by eliminating the need for additional Swift servers while still addressing high availability requirements.
**Compact Swift**: When you choose this option, Swift will be installed on
your controllers, reducing your hardware requirements by eliminating the need
for additional Swift servers while still addressing high availability
requirements.
**Standalone Swift**: This option enables you to install independant Swift nodes, so that you can separate their operation from your controller nodes.
**Standalone Swift**: This option enables you to install independant Swift
nodes, so that you can separate their operation from your controller nodes.
**Compact Neutron**: If you don't need the flexibility of a separate Neutron node, Fuel provides the option to combine your Neutron node with one of your controllers.
**Compact Neutron**: If you don't need the flexibility of a separate Neutron
node, Fuel provides the option to combine your Neutron node with one of your
controllers.
In addition to these configurations, Fuel is designed to be completely customizable. For assistance on deeper customization options based on the included configurations you can `contact Mirantis for further assistance <http://www.mirantis.com/contact/>`_.
In addition to these configurations, Fuel is designed to be completely
customizable. For assistance on deeper customization options based on the
included configurations you can
`contact Mirantis for further assistance <http://www.mirantis.com/contact/>`_.

View File

@ -1,5 +1,7 @@
.. index: Supported Software; Components
Supported Software
------------------
==================
Fuel has been tested and is guaranteed to work with the following software components:

View File

@ -1,5 +1,7 @@
.. index: Download Fuel
Download Fuel
-------------
=============
The first step in installing Fuel is to download the version appropriate for
your environment.
@ -7,5 +9,5 @@ your environment.
Fuel is available for Essex, Folsom and Grizzly OpenStack installations, and
will be available for Havana shortly after Havana's release.
The master node ISO, along with other Fuel releases, is available in the
The Admin Node ISO, along with other Fuel releases, is available in the
`Downloads <http://fuel.mirantis.com/your-downloads/>`_ section of the Fuel portal.

View File

Before

Width:  |  Height:  |  Size: 6.3 KiB

After

Width:  |  Height:  |  Size: 6.3 KiB

View File

Before

Width:  |  Height:  |  Size: 7.7 KiB

After

Width:  |  Height:  |  Size: 7.7 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

@ -1,5 +1,9 @@
.. index:: Release Notes, v3.1-grizzly
.. _RelNotes_3.1:
v3.1-grizzly
^^^^^^^^^^^^
============
**New Features in Fuel and FuelWeb 3.1**