diff --git a/contents-install.rst b/contents-install.rst deleted file mode 100644 index 4e19f78e9..000000000 --- a/contents-install.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. index Table of Contents - -.. _ToC: - -.. toctree:: Table of Contents - :maxdepth: 2 - - preface -.. include:: /pages/install-guide/0000-intro.rst -.. include:: /pages/install-guide/0060-download-fuel.rst -.. include:: /pages/install-guide/0015-sizing-hardware.rst -.. include:: /pages/install-guide/install.rst -.. include:: /pages/install-guide/networks.rst -.. include:: /pages/install-guide/0000-preamble.rst -.. include:: /pages/install-guide/0010-introduction.rst -.. include:: /pages/install-guide/0015-before-you-start.rst -.. include:: /pages/install-guide/0020-machines.rst diff --git a/contents.rst b/contents.rst index e8caf3469..c02a68a3c 100644 --- a/contents.rst +++ b/contents.rst @@ -8,7 +8,7 @@ Documentation ============================= .. toctree:: Documentation - :maxdepth: 2 + :maxdepth: 3 install-guide user-guide diff --git a/contents/contents-install.rst b/contents/contents-install.rst index d968135a7..f6c2c13df 100644 --- a/contents/contents-install.rst +++ b/contents/contents-install.rst @@ -5,7 +5,7 @@ .. toctree:: Table of Contents :maxdepth: 2 - preface +.. include:: /pages/preface/preface.rst .. include:: /pages/install-guide/0000-intro.rst .. include:: /pages/install-guide/0010-prerequisites.rst .. include:: /pages/install-guide/0060-download-fuel.rst diff --git a/contents/contents-refarch.rst b/contents/contents-refarch.rst index 3d61a22bf..07e6dea0c 100644 --- a/contents/contents-refarch.rst +++ b/contents/contents-refarch.rst @@ -1,11 +1,11 @@ .. index Table of Contents -.. _ToC: +.. _ReferenceArchitecture: .. toctree:: Table of Contents :maxdepth: 2 - preface +.. include:: /pages/preface/preface.rst .. include:: /pages/reference-architecture/0010-overview.rst .. include:: /pages/reference-architecture/0012-simple.rst .. include:: /pages/reference-architecture/0014-compact.rst diff --git a/contents/contents-user.rst b/contents/contents-user.rst index a785a3159..960325bf4 100644 --- a/contents/contents-user.rst +++ b/contents/contents-user.rst @@ -5,7 +5,7 @@ .. toctree:: Table of Contents :maxdepth: 2 - preface +.. include:: /pages/preface/preface.rst .. include:: /pages/user-guide/0070-introduction.rst .. include:: /pages/user-guide/red_hat_openstack.rst .. include:: /pages/user-guide/post-install-healthchecks.rst diff --git a/install-guide.rst b/install-guide.rst index 948407bf7..ac699ae5f 100644 --- a/install-guide.rst +++ b/install-guide.rst @@ -7,7 +7,7 @@ Installation Guide .. contents:: :local: :depth: 2 - + .. include:: /pages/install-guide/0000-intro.rst .. include:: /pages/install-guide/0010-prerequisites.rst .. include:: /pages/install-guide/0060-download-fuel.rst diff --git a/pages/install-guide/0000-intro.rst b/pages/install-guide/0000-intro.rst index e979f00c5..b2b134424 100644 --- a/pages/install-guide/0000-intro.rst +++ b/pages/install-guide/0000-intro.rst @@ -21,9 +21,6 @@ clustered cloud in terms of minutes. The following diagram describes how Fuel functions: -.. image:: /_images/how-it-works_svg.jpg - :align: center - Deployment Modes ----------------------------- You can use Fuel™ for OpenStack to create virtually any OpenStack @@ -59,11 +56,36 @@ The pre-defined architectures include: Ceph and Cinder servers, you can isolate their operations from the controller nodes. + With Fuel, you can create your own cloud environment that include additional components. + For more information, contact `Mirantis `_. -.. seealso:: `Reference Architecture <../html/reference-architecture.html>`_ +.. seealso:: `Reference Architecture` + +About Fuel Components +----------------------- + +You can use Fuel to quickly deploy and manage the OpenStack environment. + +Fuel includes the following components: + +* **Master 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 storage node + Mirantis recommends to deploy standalone storage nodes for high + availability environments. + Fuel Installation Procedures ---------------------------- @@ -74,6 +96,12 @@ You must complete the following tasks to install Fuel: # Power on the other nodes to make them accessible for Fuel Master node # Deploy the OpenStack environment on the discovered nodes using Fuel UI or CLI. +1. Install the Fuel Master Node on physical or virtual hardware using + the Fuel installation image +2. Power on the other nodes to make them accessible for Fuel Master node +3. Deploy the OpenStack environment on 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. diff --git a/pages/install-guide/0010-prerequisites.rst b/pages/install-guide/0010-prerequisites.rst index f6d828d5b..31752dc81 100644 --- a/pages/install-guide/0010-prerequisites.rst +++ b/pages/install-guide/0010-prerequisites.rst @@ -1,4 +1,4 @@ -..index:: Prerequisites +.. index:: Prerequisites .. _Prerequisites: @@ -43,6 +43,8 @@ has the following prerequisites: * 16 x Amazon EC2 compute units 16 GHz maximum +.. seealso:: `Fuel Hardware Calculator `_ + Calculating CPU ---------------- diff --git a/pages/install-guide/install.rst b/pages/install-guide/install.rst index e1b5fa948..5512fccd2 100644 --- a/pages/install-guide/install.rst +++ b/pages/install-guide/install.rst @@ -9,7 +9,7 @@ Installing Fuel Master Node .. contents :local: -Fuel is distributed via both ISO and IMG images. Eac contains an installer for +Fuel is distributed via both ISO and IMG images. Each contains an installer for Fuel Master node. The ISO image is used for CD media devices, iLO (HP) or similar remote access systems. The IMG file is used for USB memory stick-based installation. @@ -60,6 +60,8 @@ installing OpenStack. VirtualBox ---------- +.. OpenStack-3.2-ReferenceArchitecture: + If you would like to evaluate Fuel on VirtualBox, you can take advantage of the included set of scripts that create and configure all the required VMs for a test environment, including the Master node and Slave nodes for OpenStack diff --git a/pages/preface/preface.rst b/pages/preface/preface.rst index ee8a36901..32d736be0 100644 --- a/pages/preface/preface.rst +++ b/pages/preface/preface.rst @@ -26,5 +26,5 @@ The following table lists the released revisions of this documentation: +--------------------+----------------------------+ |Revision Date |Description | +====================+============================+ -|September, 2013 |Testing Preface | +|October, 2013 |3.2 GA | +--------------------+----------------------------+ diff --git a/pdf_install.rst b/pdf_install.rst index 4df2c8968..bd696dae3 100644 --- a/pdf_install.rst +++ b/pdf_install.rst @@ -4,7 +4,7 @@ .. cssclass:: header-table +-------------------------------------+-----------------------------------+ - | Fuel™ for Openstack v3.1 | .. cssclass:: right| + | Fuel™ for Openstack v3.2 | .. cssclass:: right| | | | | Installation Guide | ###Section### | +-------------------------------------+-----------------------------------+ diff --git a/pdf_reference.rst b/pdf_reference.rst index b991ed436..46afcf7a2 100644 --- a/pdf_reference.rst +++ b/pdf_reference.rst @@ -4,7 +4,7 @@ .. cssclass:: header-table +-------------------------------------+-----------------------------------+ - | Fuel™ for Openstack v3.1 | .. cssclass:: right| + | Fuel™ for Openstack v3.2 | .. cssclass:: right| | | | | Reference Architecture | ###Section### | +-------------------------------------+-----------------------------------+ diff --git a/pdf_user.rst b/pdf_user.rst index 231b90aa2..bbcb943a7 100644 --- a/pdf_user.rst +++ b/pdf_user.rst @@ -4,7 +4,7 @@ .. cssclass:: header-table +-------------------------------------+-----------------------------------+ - | Fuel™ for Openstack v3.1 | .. cssclass:: right| + | Fuel™ for Openstack v3.2 | .. cssclass:: right| | | | | User Guide | ###Section### | +-------------------------------------+-----------------------------------+