openstack
/
fuel-docs
Code Issues Proposed changes

Partial update to documentation 

This update includes the pages in the Introduction section.
This commit is contained in:
Tyler Regas 2013-07-10 12:40:22 -07:00
parent fc0e811547
commit cc39810f81
5 changed files with 26 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,17 +1,18 @@
FUEL™ for OpenStack Documentation
===
This repository contains the FUEL™ for OpenStack user and administrator guides.
This repository contains the FUEL™ for OpenStack user and administrator guides. For more details, see the [FUEL™ for OpenStack portal](http://fuel.mirantis.com "FUEL™ for OpenStack portal").
For more details, see the [FUEL™ for OpenStack portal](http://fuel.mirantis.com
"FUEL™ for OpenStack portal").
Contributing
============
We welcome all people who are interested in helping our Documentation team to improve our documentation. There are no formal membership requirements, so feel free to hop in. The best way to contibute is to fork our repository, do your changes and send us a Pull Request. You are invited to contribute any type of contribution like new ideas, testing, and even deployment scripts.
We also have an IRC channel at ``#openstack-fuel`` on ``irc.freenode.net`` where you can ask questions and give feedback.
Prerequisites
=============
[Sphinx Documentation Generator](http://sphinx-doc.org/ "Sphinx Documentation
Generator") must be installed to build the documentation.
[Sphinx Documentation Generator](http://sphinx-doc.org/ "Sphinx Documentation Generator") must be installed to build the documentation. Please note that easy_install is a component of Python's Setup Tools package, which is commonly an optional install on most distributions.
To get started, you need to install Sphinx and necessary extensions:
@ -22,21 +23,18 @@ To get started, you need to install Sphinx and necessary extensions:
sudo easy_install -U sphinxcontrib-seqdiag
sudo easy_install -U sphinxcontrib-nwdiag
Plus you will need to install [PlantUML](http://plantuml.sourceforge.net/
"PlantUML") and [ImageMagick](http://www.imagemagick.org/ "ImageMagick").
Plus you will need to install [PlantUML](http://plantuml.sourceforge.net/ "PlantUML") and [ImageMagick](http://www.imagemagick.org/ "ImageMagick").
To edit SVG images we use [Inkscape](http://inkscape.org/ "Inkscape") but you
can use any other tool you want.
To edit SVG images we use [Inkscape](http://inkscape.org/ "Inkscape") but you may use any other SVG-capable tool you like. We're not picky.
Building
========
To build a guide in HTML format, go to its directory and then run the ``make``
command in that directory. For example:
To build a guide in HTML format, go to its directory and then run the ``make`` command in that directory, like so:
make html
To generate the PDF file you shall do:
To generate the PDF file run this:
make pdf
@ -44,15 +42,3 @@ You will find generated HTML documentation at:
_build/html
Contributing
============
We are welcome all people interested in helping our team to improve our
documentation, and there are no formal membership requirements. The best way to
contibute is to fork our repository, do your changes and send us Pull Request.
There is also an IRC at ``#openstack-fuel`` on ``irc.freenode.net`` where you
can ask your questions and give your feedback.
We welcome all types of contributions, from new ideas to documentation
to testing to deployment scripts.

16
pages/introduction/0030-how-it-works.rst
View File

@ -1,13 +1,8 @@
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.
Fuel works on the premise that rather than installing each of the
myriad components that make up OpenStack directly, you can instead use
a configuration management system such as Puppet to create scripts
that can provide a configurable, repeatable, sharable installation
process.
In practice, that means that the process of using Fuel looks like this:
In practice, that means that the process of using Fuel Library looks like this:
#. 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.
@ -16,7 +11,10 @@ In practice, that means that the process of using Fuel looks like this:
#. 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.
.. image:: https://docs.google.com/drawings/pub?id=15vTTG2_575M7-kOzwsYyDmQrMgCPT2joLF2Cgiyzv7Q&w=678&h=617
:align: center
Fuel comes with several pre-defined deployment configurations, some of which include
additional options from which you can choose.
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, Fuel Web is included as part of the package. Fuel Web is a simplified way to deploy production-grade OpenStack clouds. Fuel Web 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.
Fuel Web 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.

22
pages/introduction/0040-reference-topologies.rst
View File

@ -1,16 +1,11 @@
Deployment Configurations Provided By Fuel
------------------------------------------
One of the advantages of Fuel is that it comes with several pre-built
deployment configurations that you can use to immediately build your own
OpenStack cloud infrastructure. These are well-specified configurations of OpenStack and its constituent components
tailored to one or more cloud use cases. As of version 2.1, 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 basic 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 or virtual machine.
**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 such as Cinder, 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, 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.
@ -18,15 +13,10 @@ requiring extensive customization:
**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, Quantum, and Swift, Fuel provides the following variations of the Multi-node (HA) configuration:
**Compact Swift**: When you choose this variation, 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 variation 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 Quantum**: If you don't need the flexibility of a separate Quantum node, Fuel provides the option to combine your Quantum node with one of your controllers.
In addition to these configurations, Fuel is designed to be completely
customizable. Upcoming editions of this guide discuss techniques for
creating additional OpenStack deployment configurations.
To configure Fuel immediately for more extensive variations on these
use cases, 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/>`_.

7
pages/introduction/0060-download-fuel.rst
View File

@ -1,13 +1,10 @@
Download Fuel
-------------
The first step in installing Fuel is to download the version
appropriate for your environment.
The first step in installing Fuel is to download the version appropriate for your environment.
Fuel is available for Essex, Folsom and Grizzly OpenStack installations, and will be available for Havana shortly after Havana's release.
To make your installation easier, we also offer a pre-built ISO for installing the master node with Puppet Master and Cobbler. You can mount this ISO in a physical or VirtualBox machine in order to
easily create your master node. (Instructions for performing this step
without the ISO are given in :ref:`Appendix A <Create-PM>`.)
To make your installation easier, we also offer a pre-built ISO for installing the master node with Puppet Master and Cobbler. You can mount this ISO on a physical machine or in VirtualBox in order to easily create your master node. (Instructions for performing this step without the ISO are given in :ref:`Appendix A <Create-PM>`.)
The master node ISO, along with other Fuel releases, is available in the `Downloads <http://fuel.mirantis.com/your-downloads/>`_ section of the Fuel portal.

1
pages/introduction/0070-release-notes.rst
View File

@ -1,6 +1,7 @@
Release Notes
-------------
.. include:: /pages/introduction/release-notes/v3-1-grizzly.rst
.. include:: /pages/introduction/release-notes/v3-0-grizzly.rst
.. include:: /pages/introduction/release-notes/v2-1-folsom.rst
.. include:: /pages/introduction/release-notes/v2-0-folsom.rst