[Docs restructuring]Fixed links and TOC

Created TOC for the Fuel Installation Guide
Fixed links

Change-Id: Ifa0252ba5aa1db17b49dbec6a4b51cfcd9551021
Partial-bug: #1504699
This commit is contained in:
Svetlana Karslioglu
2015-11-23 09:42:14 -08:00
parent 595c02f616
commit ff4ff632d5
49 changed files with 345 additions and 277 deletions

View File

@@ -1,2 +1,49 @@
.. include:: pages/draft/fuel-install-guide/intro_planning_your_environment.rst
.. include:: pages/draft/fuel-install-guide/sysreq_storage_reqs.rst
.. include:: /pages/draft/fuel-install-guide/intro_fuel_install_intro.rst
.. include:: /pages/draft/fuel-install-guide/intro_fuel_intro.rst
.. include:: /pages/draft/fuel-install-guide/intro_install_overview.rst
.. include:: /pages/draft/fuel-install-guide/intro_planning_your_environment.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_intro.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_hw_intro.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_fuel_master_node_hw_requirements.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_fuel_slave_node_hw_recs.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_network_requirements.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_fuel_master_node_network_reqs.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_storage_reqs.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_sample_configuration.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_sample_configuration_controllers.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_sample_configuration_compute.rst
.. include:: /pages/draft/fuel-install-guide/sysreq_sample_configuration_storage.rst
.. include:: /pages/draft/fuel-install-guide/install_intro.rst
.. include:: /pages/draft/fuel-install-guide/install_before_you_install_fuel.rst
.. include:: /pages/draft/fuel-install-guide/install_download_iso.rst
.. include:: /pages/draft/fuel-install-guide/install_prepare_install_media.rst
.. include:: /pages/draft/fuel-install-guide/install_install_fuel_master_node.rst
.. include:: /pages/draft/fuel-install-guide/install_set_up_fuel.rst
.. include:: /pages/draft/fuel-install-guide/install_change_network_interface.rst
.. include:: /pages/draft/fuel-install-guide/install_login_fuel_master_node.rst
.. include:: /pages/draft/fuel-install-guide/install_login_fuel_master_node_multiple_nics.rst
.. include:: /pages/draft/fuel-install-guide/install_boot_slave_nodes.rst
.. include:: /pages/draft/fuel-install-guide/plugins_intro.rst
.. include:: /pages/draft/fuel-install-guide/plugins_overview.rst
.. include:: /pages/draft/fuel-install-guide/plugins_prerequisites.rst
.. include:: /pages/draft/fuel-install-guide/plugins_install_plugins.rst
.. include:: /pages/draft/fuel-install-guide/plugins_view_plugins.rst
.. include:: /pages/draft/fuel-install-guide/plugins_uninstall_upgrade.rst
.. include:: /pages/draft/fuel-install-guide/vsphere-intro.rst
.. include:: /pages/draft/fuel-install-guide/vsphere-upload-iso.rst
.. include:: /pages/draft/fuel-install-guide/vsphere-configure-network.rst
.. include:: /pages/draft/fuel-install-guide/vsphere-create-vm.rst
.. include:: /pages/draft/fuel-install-guide/vsphere-mount-iso.rst
.. include:: /pages/draft/fuel-install-guide/vsphere-install-master.rst
.. include:: /pages/draft/fuel-install-guide/vsphere-boot-master.rst
.. include:: /pages/draft/fuel-install-guide/vsphere-verify-master.rst
.. include:: /pages/draft/fuel-install-guide/upgrade-intro.rst
.. include:: /pages/draft/fuel-install-guide/upgrade-internals.rst
.. include:: /pages/draft/fuel-install-guide/upgrade-table.rst
.. include:: /pages/draft/fuel-install-guide/upgrade-fuel-master.rst
.. include:: /pages/draft/fuel-install-guide/upgrade-local-repo.rst
.. include:: /pages/draft/fuel-install-guide/upgrade-major-versions.rst
.. include:: /pages/draft/fuel-install-guide/upgrade-apply-patches.rst
.. include:: /pages/draft/fuel-install-guide/preinstall_intro.rst
.. include:: /pages/draft/fuel-install-guide/preinstall_hardware_checklist.rst

View File

@@ -1 +0,0 @@
This directory contains the files for the Fuel Installation Guide.

View File

@@ -1,16 +0,0 @@
.. _fuel-plugins:
============
Fuel Plugins
============
You can extend Fuel functionality by installing the plugins
that companies and individual contributors develop for Fuel.
This section includes the following sections:
:ref:`Fuel plugins overview`
:ref:`Prerequisites`
:ref:`Install a Fuel plugin`
:ref:`View Fuel plugins`

View File

@@ -7,14 +7,12 @@ Before you install Fuel, verify that you have completed the following tasks:
#. Read and complete the tasks described in the following sections:
* : ref: `intro_install_overview`
* : ref: `sysreq_intro`
* :ref:`intro_install_overview`
* :ref:`sysreq_intro`
#. If you use bare-metal hardware, set up and connect all hardware.
#. If you use virtual hardware, configure all required virtual machines,
network, and storage parameters.
#. Select a workflow:
* If you install Fuel on a server with an Internet connection, follow this

View File

@@ -1,5 +1,6 @@
.. _install_boot_nodes:
Boot the Fuel Slave nodes
~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -46,11 +46,11 @@ Fuel Master node.
#. In Menu, select **PXE Setup**.
#. Set the DHCP pool range and gateway.
#. Verify your configuration by clicking **Check**.
#. Proceed to :ref : `install_boot_fuel_master_node`
#. Proceed to :ref:`install_login_fuel_master_node`.
.. seealso::
- :ref : `install_configure_a_network_interface_for_fuel_web_ui`
- :ref:`install_configure_a_network_interface_for_fuel_web_ui`
.. _install_configure_a_network_interface_for_fuel_web_ui:
@@ -72,8 +72,8 @@ the Fuel web UI.
Fuel now uses the selected interface for the Fuel web UI.
#. Proceed to :ref : `install_boot_fuel_master_node`
#. Proceed to :ref:`install_login_fuel_master_node`.
.. seealso::
- :ref : ` install_change_admin_network_interface`
- :ref:`install_login_fuel_master_node_multiple_nics`

View File

@@ -16,5 +16,5 @@ repository.
#. Go to the `Fuel project page <https://www.fuel-infra.org>`_.
#. Download the ISO to your computer.
#. Proceed to : ref:`install_prepare_install_media`.
#. Proceed to :ref:`install_prepare_install_media`.

View File

@@ -24,9 +24,9 @@ Before you install the Fuel Master node, complete the steps described in
line, configure the IP address, default gateway, and DNS server settings of
the Fuel Master node.
#. Proceed to :ref:`install_configure_network_parameters`.
#. Proceed to :ref:`Configure network parameters <install_set_up_fuel>`.
.. note::
You can install the Fuel Master node on VMware vSphere. For more information,
see: :ref:`Before you install Fuel on VMware vSphere <vsphere_intro>`.
see: :ref:`Before you install Fuel on VMware vSphere <vsphere_intro>`.

View File

@@ -0,0 +1,19 @@
.. _install_intro:
Install Fuel
============
You can install Fuel on bare-metal or virtual hardware. For information about
specific virtual machine and network configurations on VMware vSphere, see:
:ref:`Install Fuel on VMware vSphere <vsphere_intro>`.
This section includes the following topics:
* :ref:`Before you install Fuel <install_before_you_install_fuel>`
* :ref:`Download the ISO image <install_download_iso>`
* :ref:`Prepare an installation media <install_prepare_install_media>`
* :ref:`Install the Fuel Master node <install_install_fuel_master_node>`
* :ref:`Set up Fuel <install_set_up_fuel>`
* :ref:`Log in to the Fuel Master node <install_login_fuel_master_node>`
* :ref:`Log in to the Fuel Master node with multiple NICs <install_login_fuel_master_node_multiple_nics>`
* :ref:`Boot the Fuel Slave nodes <install_boot_nodes>`

View File

@@ -29,12 +29,12 @@ initial configuration.
**To log in to the Fuel web UI:**
#. In a web browser, type the IP address and port number that you have
assigned for the Fuel web UI in :ref:`install_set_up_fuel`.
assigned for the Fuel web UI in :ref:`Set up Fuel <install_set_up_fuel>`.
Fuel prompts you for the login credentials.
#. In a web browser, enter the Fuel UI login and password that you have
set for the Fuel web UI in :ref:`install_set_up_fuel`
set for the Fuel web UI in :ref:`Set up Fuel <install_set_up_fuel>`.
If you use the default network settings, use the following values:
@@ -54,12 +54,12 @@ initial configuration.
The Fuel web UI initial screen displays.
#. Proceed to :ref:`install_boot_the_fuel_slave_nodes`.
#. Proceed to :ref:`Boot the Fuel Slave nodes <install_boot_nodes>`.
**To log in to the Fuel CLI:**
#. In the Fuel Master node console, type the root login and password that you
have assigned in :ref:`install_set_up_fuel`.
have assigned in :ref:`Set up Fuel <install_set_up_fuel>`.
If you use the default settings, type the following login credentials:
@@ -76,10 +76,8 @@ initial configuration.
#. Alternatively, connect to the Fuel Master node :ref:`using SSH <shell-ops>`.
#. Proceed to :ref:`install_boot_the_fuel_slave_nodes`.
#. Proceed to :ref:`Boot the Fuel Slave nodes <install_boot_nodes>`.
.. seealso::
- :ref:`install_login_fuel_master_node_multiple_nics`
- :ref:`ug_create_new_env`
- :ref:`Log in to the Fuel Master node with multiple NICs <install_login_fuel_master_node_multiple_nics>`

View File

@@ -1,59 +0,0 @@
.. _install_plugins:
Install a Fuel plugin
~~~~~~~~~~~~~~~~~~~~~
The installation procedure is common for all plugins.
For more details about the plugin installation and its requirements,
see the corresponding plugin documentation.
**To install a Fuel plugin:**
#. Install the Fuel Master node as described in `Install the Fuel Master node`.
#. Boot the Fuel Master node as described in `Boot the Fuel Master node`.
#. Download a plugin from `Fuel Plugins сatalog`_.
#. Read a Plugin Guide to learn about prerequisites and limitations.
#. Define variables with values suitable for your environment to be used
during the plugin installation process or replace them in your command
line when appropriate.
.. code-block:: console
export FUEL_PLUGIN_FILE=fuel-plugin.rpm
export FUEL_MASTER_NODE=10.20.0.2
#. Copy the plugin to the Fuel Master node.
.. code-block:: console
scp ${FUEL_PLUGIN_FILE} root@:${FUEL_MASTER_NODE}:/tmp
#. Install the plugin by typing:
.. code-block:: console
ssh root@:${FUEL_MASTER_NODE} "fuel plugins --install /tmp/${FUEL_PLUGIN_FILE}"
#. Create an OpenStack environment as described in `Create a new OpenStack environment`
in the `Fuel User Guide`.
#. After completing the Create a new OpenStack environment wizard, click *Settings* in the Fuel web UI.
#. Enable plugin in the Fuel web UI as described in the plugin documentation.
#. Configure and deploy your environment as described in `Configure a new environment`
in the `Fuel User Guide`.
.. seealso::
- `Fuel plugins CLI <fuel-plugins-cli>`
- `Fuel plugins catalog`_
.. links
.. _`Fuel plugins catalog`: http://stackalytics.com/report/driverlog?project_id=openstack%2Ffuel

View File

@@ -1,12 +1,15 @@
.. _install_prepare_install_media:
Preparing an installation media
Prepare an installation media
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After downloading the :ref:`Fuel ISO image <install_download_iso>`, you must
prepare the installation media by mounting the ISO or burning a DVD/USB
drive.
.. _install_create_dvd:
Create a DVD drive
------------------
@@ -45,6 +48,9 @@ bare-metal hardware.
#. Proceed to the
:ref:`Fuel Master node installation <install_install_fuel_master_node>`.
.. _install_create_usb:
Create a USB drive with the Fuel ISO on a UNIX system
-----------------------------------------------------
@@ -65,7 +71,7 @@ install Fuel on your machine.
# dd if=/path-to-your-ISO of=/path-to-your-USB
Example:
**Example:**
.. code-block:: console
@@ -75,5 +81,5 @@ install Fuel on your machine.
on the USB drive and places a bootable Fuel ISO
on it.
#. Proceed to the
:ref:`Fuel Master node installation <install_install_fuel_master_node>`.
#. Proceed to
:ref:`Install the Fuel Master node <install_install_fuel_master_node>`.

View File

@@ -1,4 +1,4 @@
.. _install_configure_network_parameters:
.. _install_set_up_fuel:
Set up Fuel
~~~~~~~~~~~
@@ -22,7 +22,7 @@ finalize network configuration before you install the Fuel Master node.
OpentStack environments.
If you are installing Fuel for testing purposes, you can keep the default
settings and proceed to :ref :`install_boot_fuel_master_node`.
settings and proceed to :ref:`install_install_fuel_master_node`.
**To set up Fuel:**
@@ -116,9 +116,10 @@ settings and proceed to :ref :`install_boot_fuel_master_node`.
| | configurations. |
+--------------------------------------+----------------------------------+
2. Proceed to :ref : `install_boot_fuel_master_node`.
2. Proceed to :ref:`install_install_fuel_master_node`.
.. seealso::
- :ref : `install_configure_a_network_interface_for_fuel_web_ui`
- :ref : `install_change_admin_network_interface`
- :ref:`Configure a network interface for the Fuel web UI
<install_configure_a_network_interface_for_fuel_web_ui>`
- :ref:`Change the Admin (PXE) network interface <install_change_admin_network_interface>`

View File

@@ -1,8 +1,7 @@
.. _intro_fuel_install:
=====================================
Introduction to the Fuel Installation
=====================================
Introduction to Fuel Installation
=================================
This section provides an overview of the Fuel installation
process. You can install Fuel on a server with an Internet connection or
@@ -11,9 +10,9 @@ on your choice, the workflow differs.
This section includes the following topics:
* : ref :intro_fuel
* : ref :intro_install_overview
* : ref :intro_planning
* :ref:`intro_fuel`
* :ref:`intro_install_overview`
* :ref:`intro_planning`

View File

@@ -8,27 +8,28 @@ To ensure a successful deployment, review and understand the following
requirements and sequence of tasks that you must complete.
#. Plan your OpenStack environment according to the official OpenStack
guidelines and : ref : intro_planning.
guidelines and :ref:`Planning your environment <intro_planning>`.
#. Verify that your environment meets the recommendations in
: ref : sysreq_intro.
:ref:`System requirements <sysreq_intro>`.
#. Verify your hardware using the : ref : Hardware checklist.
#. Verify your hardware using the
:ref:`Hardware checklist <preinstall_chklist_hardware_checklist>`.
#. Determine whether the server on which you plan to install the Fuel
Master node is connected to the Internet.
* If the server does not have an Internet
connection, then you must configure a local repository. For more
information, see: : ref : Set up a local repository .
* If the server does not have an Internet
connection, then you must configure a local repository. For more
information, see: :ref:`Set up a local repository <install_set_up_fuel>`.
#. If you plan to install Fuel on VMware vSphere, verify that your environment
meets the : ref : VMware vSphere prerequisites.
meets the :ref:`VMware vSphere prerequisites <vsphere_intro>`
#. Download and install Fuel as described in : ref : Install OpenStack using
Fuel or if you are installing on VMware vSphere in : ref : Install Fuel
on VMware vSphere.
#. Download and install Fuel as described in :ref:`Install Fuel <install_intro>`
or if you are installing on VMware vSphere in
:ref:`Install Fuel on VMware vSphere <vsphere_intro>`.
#. Install the Fuel plug-ins, if needed. See: : ref : Plug-ins.
#. Install the Fuel plug-ins, if needed. See: :ref:`Plug-ins <fuel-plugins>`.

View File

@@ -1,4 +1,3 @@
.. _intro_planning:
Planning your environment
@@ -24,9 +23,11 @@ production environment, you must decide on the following:
This guide explains what OpenStack configurations you can deploy using Fuel,
as well as briefly describes guidelines and examples on how to plan resources
for your environment. However, we recommend that you read `OpenStack
Architecture Design Guide <http://docs.openstack.org/arch-design/content/>`_,
Architecture Design Guide <http://docs.openstack.org/arch-design/content/>`__,
so you can better estimate your network, storage, and compute requirements.
.. seealso::
- : ref: `sysreq_intro`
- :ref:`System requirements <sysreq_intro>`

View File

@@ -0,0 +1,61 @@
.. _plugins_install_plugins:
Install a Fuel plugin
~~~~~~~~~~~~~~~~~~~~~
The installation procedure is common for all plugins.
For more details about the plugin installation and its requirements,
see the corresponding plugin documentation.
**To install a Fuel plugin:**
#. Install the Fuel Master node as described in
:ref:`Install the Fuel Master node <install_install_fuel_master_node>`.
#. Boot the Fuel Master node as described in
:ref:`Log in to the Fuel Master node <install_login_fuel_master_node>`.
#. Download a plugin from `Fuel Plugins
сatalog <http://stackalytics.com/report/driverlog?project_id=openstack%2Ffuel>`_.
#. Read a Plugin Guide to learn about prerequisites and limitations.
#. Define variables with values suitable for your environment to be used
during the plugin installation process or replace them in your command
line when appropriate.
.. code-block:: console
export FUEL_PLUGIN_FILE=fuel-plugin.rpm
export FUEL_MASTER_NODE=10.20.0.2
#. Copy the plugin to the Fuel Master node.
.. code-block:: console
scp ${FUEL_PLUGIN_FILE} root@:${FUEL_MASTER_NODE}:/tmp
#. Install the plugin by typing:
.. code-block:: console
ssh root@:${FUEL_MASTER_NODE} "fuel plugins --install /tmp/${FUEL_PLUGIN_FILE}"
#. Create an OpenStack environment as described in
`Create a new OpenStack environment` in the `Fuel User Guide`.
#. After completing the Create a new OpenStack environment wizard, click
:guilabel:`Settings` in the Fuel web UI.
#. Enable plugin in the Fuel web UI as described in the plugin documentation.
#. Configure and deploy your environment as described in
`Configure a new environment` in the `Fuel User Guide`.
.. seealso::
- Fuel plugins CLI
- `Fuel plugins catalog
<http://stackalytics.com/report/driverlog?project_id=openstack%2Ffuel>`__

View File

@@ -0,0 +1,15 @@
.. _fuel-plugins:
Fuel Plugins
============
You can extend Fuel functionality by installing the plugins
that companies and individual contributors develop for Fuel.
This section includes the following topics:
* :ref:`Fuel plugins overview <plugins_overview>`
* :ref:`Prerequisites <plugins_prerequisites>`
* :ref:`Install a Fuel plugin <plugins_install_plugins>`
* :ref:`View Fuel plugins <plugins_view_plugins>`
* :ref:`Uninstall a plugin <plugins_upgrade_uninstall_plugin>`

View File

@@ -1,6 +1,5 @@
.. _plugins_overview:
Fuel plugins overview
~~~~~~~~~~~~~~~~~~~~~
@@ -37,14 +36,11 @@ Fuel currently has the following plugins:
environment before you deploy your environment. You will not be able to
add plugins after deployment.
`Fuel Plugins SDK`_ enables you to develop virtually any plugin that you
need to meet your environment prerequisites.
`Fuel Plugins SDK <https://wiki.openstack.org/wiki/Fuel/Plugins>`__ enables
you to develop virtually any plugin that you need to meet your environment
prerequisites.
.. seealso::
- `Fuel Plugins catalog`_
.. links
.. _`Fuel Plugins SDK`: https://wiki.openstack.org/wiki/Fuel/Plugins
.. _`Fuel Plugins catalog`: https://www.fuel-infra.org/plugins/catalog.html
- `Fuel Plugins catalog <http://stackalytics.com/report/driverlog?project_id=openstack%2Ffuel>`__

View File

@@ -14,8 +14,5 @@ following recommendations:
.. seealso::
- `Fuel plugins catalog`_
.. links
.. _`Fuel plugins catalog`: http://stackalytics.com/report/driverlog?project_id=openstack%2Ffuel
- `Fuel plugins catalog
<http://stackalytics.com/report/driverlog?project_id=openstack%2Ffuel¬>`__

View File

@@ -1,4 +1,5 @@
.. _upgrade_uninstall_plugin:
.. _plugins_upgrade_uninstall_plugin:
Uninstall a plugin
~~~~~~~~~~~~~~~~~~
@@ -16,7 +17,7 @@ uninstall the Fuel plugins before upgrading Fuel.
set -eux
echo uninstall > /tmp/myplugin_uninstall
where ``myplugin`` is the name of your plugin.
where ``myplugin`` is the name of your plugin.
#. Put the ``uninstall.sh`` script in your plugin folder.
#. Type::

View File

@@ -1,15 +1,17 @@
.. _view_plugins:
.. _plugins_view_plugins:
View Fuel plugins
~~~~~~~~~~~~~~~~~
You can view the list of installed plugins in the Fuel Web UI, as well as in the Fuel CLI.
You can view the list of installed plugins in the Fuel Web UI, as well as in
the Fuel CLI.
To view the list of installed plugins via the Fuel Web UI, click the :guilabel:`Plugins` button.
It is located at top of the screen at the Fuel level.
To view the list of installed plugins using the Fuel Web UI, click the
:guilabel:`Plugins` button. It is located at the top of the screen at the
Fuel level.
You can find the following information for every plugin:
* version
* description
* homepage

View File

@@ -1,6 +1,5 @@
.. _preinstall_intro:
===========================
Pre-installation checklists
===========================

View File

@@ -1,7 +1,7 @@
.. _sysreq_master_node_hardware_recs:
Fuel Master node hardware requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------------------
When planning hardware for the Fuel Master node, verify that your hardware
meets the following minimum requirements:

View File

@@ -18,4 +18,4 @@ node.
.. seealso::
- : ref: upgrade_local_repo
- :ref:`upgrade_local_repo`

View File

@@ -39,7 +39,7 @@ General guidelines for the Fuel Salve nodes:
.. seealso::
- `OpenStack Architecture Design Guide
<http://docs.openstack.org/arch-design/content/technical-considerations-general-purpose.html>`_
<http://docs.openstack.org/arch-design/content/technical-considerations-general-purpose.html>`__
- `OpenStack Operations Guide
<http://docs.openstack.org/openstack-ops/content/>`_
- : ref: `sysreqs_sample_target_node_config`
- :ref:`sysreqs_sample_target_node_config`

View File

@@ -12,5 +12,5 @@ deployments.
.. seealso::
- : ref: `sysreq_master_node_hardware_recs`
- : ref: `sysreq_target_node_hardware_recs`
- :ref:`sysreq_master_node_hardware_recs`
- :ref:`sysreq_fuel_slave_node_hw_recs`

View File

@@ -1,6 +1,5 @@
.. _sysreq_intro:
===================
System requirements
===================
@@ -9,12 +8,12 @@ accommodate your OpenStack workloads. Since there are many possible use cases
for an OpenStack environment, the number and configurations of your servers
will also vary. While this section provides clear hardware requirements for the
Fuel Master node, it can only provide guidelines on how to configure the Fuel
Target nodes. For reference, a sample hardware configuration of
Slave nodes. For reference, a sample hardware configuration of
a medium-sized OpenStack environment is described at the end of this section.
This section includes the following topics:
* : ref:`sysreq_hw_intro`
* : ref:`sysreqs_network_reqs`
* : ref:`sysreq_storge_reqs`
* : ref:`sysreqs_sample_target_node_config`
* :ref:`Hardware requirements <sysreq_hw_intro>`
* :ref:`Network requirements <sysreqs_network_reqs>`
* :ref:`Storage requirements <sysreq_storge_reqs>`
* :ref:`Sample hardware architecture <sysreqs_sample_target_node_config>`

View File

@@ -17,20 +17,20 @@ The documentation for each patch item is available in the
Check each patch item and proceed with the instructions.
* To patch the Fuel Master node:
**To patch the Fuel Master node:**
#. Log in to the Fuel Master node.
#. Log in to the Fuel Master node.
* If you use a local repository, update it by typing::
* If you use a local repository, update it by typing::
fuel-createmirror -M
#. Run the command specified in the documentation to download and install the patch.
#. Run the command specified in the documentation to download and install the patch.
* To patch a Fuel Slave node:
**To patch a Fuel Slave node:**
#. Run the command specified in the documentation to download and
install the patch.
#. Run the command specified in the documentation to download and
install the patch.
**Apply all accumulated changes in one go:**

View File

@@ -1,28 +1,28 @@
.. _upgrade_intro:
Introduction
~~~~~~~~~~~~
Upgrade Fuel
============
If you are running Fuel 6.x, you can upgrade the Fuel Master node to
version 7.0.
the latest Fuel version.
There are two possible scenarios:
* With an Internet connection -- a regular Fuel upgrade process.
* With an Internet connection -- a regular Fuel upgrade process. See:
* See: :ref:`upgrade_prerequisites`.
* :ref:`upgrade_prerequisites`.
* Without an Internet connection -- first create a local repository,
then run a regular Fuel upgrade process from the created local
repository. See:
* :ref:`upgrade_local_repo`.
* :ref:`upgrade_prerequisites`.
* :ref:`upgrade_local_repo`.
* :ref:`upgrade_prerequisites`.
.. note:: Fuel does not support upgrades for plugins. The old plugin
versions may not be compatible with the new version of Fuel.
Therefore, you must uninstall the Fuel plugins before
upgrading Fuel. See :ref:`upgrade_uninstall_plugin`.
upgrading Fuel. See :ref:`plugins_upgrade_uninstall_plugin`.
.. seealso::

View File

@@ -23,47 +23,55 @@ or through Fuel CLI using the ``fuel-createmirror`` script.
#. Log in to the Fuel Master node CLI.
#. Run the ``fuel-createmirror`` script:
* If you use the default Fuel root password, type::
* If you use the default Fuel root password, type:
fuel-createmirror
::
* If you change the default Fuel root password, type::
fuel-createmirror
fuel-createmirror --password PASSWORD
* If you change the default Fuel root password, type:
#. Restart the the docker daemon::
::
service docker restart
fuel-createmirror --password PASSWORD
#. Restart the the docker daemon
::
service docker restart
Alternatively (recommended), reboot the Fuel Master node.
About ``fuel-createmirror``
---------------------------
About the fuel-createmirror script
----------------------------------
The ``fuel-createmirror`` is a built-in Fuel script that enables
you to modify the Fuel repository sources from the CLI.
``fuel-createmirror`` details:
* The script supports only RSYNC mirrors.
See the `the list of official upstream Ubuntu mirrors <https://launchpad.net/ubuntu/+archivemirrors>`_.
* The script supports only rsync mirrors.
See the `official upstream Ubuntu mirrors list <https://launchpad.net/ubuntu/+archivemirrors>`_.
* The script uses a Docker container with Ubuntu to support dependencies
resolution.
* The script uses a Docker container with Ubuntu to support dependencies
resolution.
* To view help information, type ``fuel-createmirror -h``.
* To view help information, type ``fuel-createmirror -h``.
* The script supports running behind an HTTP proxy configured to
Port 873 (rsync). The following environment variables can be set either
system-wide (via ~/.bashrc), or in the script configuration file:
* The script supports running behind an HTTP proxy configured to
Port 873 (rsync). The following environment variables can be set either
system-wide (via ~/.bashrc), or in the script configuration file::
::
http_proxy=http://username:password@host:port/
RSYNC_PROXY=username:password@host:port
You can also configure Docker to use the proxy to download the Ubuntu
image needed to resolve the packages dependencies. Add the environment
variables to the `/etc/sysconfig/docker` file, and export them::
* You can also configure Docker to use the proxy to download the Ubuntu
image needed to resolve the packages dependencies. Add the environment
variables to the `/etc/sysconfig/docker` file, and export them:
http_proxy=http://username:password@host:port/
RSYNC_PROXY=username:password@host:port
export http_proxy RYSNC_PROXY
::
http_proxy=http://username:password@host:port/
RSYNC_PROXY=username:password@host:port
export http_proxy RYSNC_PROXY

View File

@@ -28,16 +28,21 @@ before running the actual upgrade:
#. Select the environment that complies with the above prerequisites
and assign its ID to the ``ORIG_ID`` variable:
#. On the Fuel Master node, type::
#. On the Fuel Master node, type:
fuel env
::
#. Select the environment ID from the list.
#. Assign the environment ID to the ``ORIG_ID`` variable::
fuel env
export ORIG_ID=<ENVIRONMENT_ID>
#. Select the environment ID from the list.
#. Assign the environment ID to the ``ORIG_ID`` variable:
#. Upgrade the Fuel Master node. See :ref:`upgrade_fuel_master`.
::
export ORIG_ID=<ENVIRONMENT_ID>
#. Upgrade the Fuel Master node.
See :ref:`Upgrade the Fuel Master node <upgrade_fuel_master>`.
#. Proceed to :ref:`upgrade_prepare_master`.
@@ -92,8 +97,8 @@ settings parameters to the new environment.
octane upgrade-env ${ORIG_ID}
where ORIG_ID is the ID of the environment that you assigned at the
:ref:`upgrade_prerequisites` step.
where ORIG_ID is the ID of the environment that you assigned at the
:ref:`upgrade_prerequisites` step.
#. Running the ``octane upgrade-env ${ORIG_ID}`` command will display
the ID of the new Fuel 7.0 environment.
@@ -126,13 +131,15 @@ You must deploy the Controller node with the following modifications:
Upgrade the databases
~~~~~~~~~~~~~~~~~~~~~
To upgrade the databases, put the environment :ref:`Maintenance Mode <db-backup-ops>`.
To upgrade the databases, put the environment in :ref:`Maintenance Mode <db-backup-ops>`.
**To upgrade the databases:**
#. Upgrade the state databases of the OpenStack services by typing::
#. Upgrade the state databases of the OpenStack services by typing:
octane upgrade-db ${ORIG_ID} ${SEED_ID}
::
octane upgrade-db ${ORIG_ID} ${SEED_ID}
Upgrade Ceph cluster
~~~~~~~~~~~~~~~~~~~~
@@ -146,19 +153,22 @@ that will complete the following:
**To upgrade the Ceph cluster:**
#. Run the following command::
#. Run the following command:
octane upgrade-ceph ${ORIG_ID} ${SEED_ID}
::
Upgrade Control Plane
~~~~~~~~~~~~~~~~~~~~~
octane upgrade-ceph ${ORIG_ID} ${SEED_ID}
Before upgrading the Control plane, verify that you have completed the following tasks:
Upgrade the Control Plane
~~~~~~~~~~~~~~~~~~~~~~~~~
- Clone the environment settings
- Deployed the Controller node in the new environment
- Upgraded the databases
- Upgraded the Ceph cluster
Before upgrading the Control plane, verify that you have completed the
following tasks:
- Clone the environment settings
- Deployed the Controller node in the new environment
- Upgraded the databases
- Upgraded the Ceph cluster
**To upgrade the Control Plane:**
@@ -166,7 +176,9 @@ Run the following command::
octane upgrade-control ${ORIG_ID} ${SEED_ID}
This command switches the services from the original environment to the new one and swaps the Controller connections to the Management and External networks.
This command switches the services from the original environment to the new
one and swaps the Controller connections to the Management and External
networks.
Upgrade hypervisor host
~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -1,15 +0,0 @@
.. index:: Upgrade Section
.. _upgrade-section:
===========================================
Upgrade Your Fuel and OpenStack Environment
===========================================
This section guides you through the upgrade process of Fuel
and your OpenStack environment managed by Fuel.
.. contents:: :local:
.. include:: /pages/draft/fuel-install-guide/contents-upgrade.rst

View File

@@ -1,7 +1,7 @@
.. _vsphere_boot_master:
Boot the Fuel Master node
=========================
~~~~~~~~~~~~~~~~~~~~~~~~~
#. When the Mirantis ISO boot menu appears, press the **Tab** key
on the keyboard and modify the last kernel parameter ``showmenu``

View File

@@ -1,21 +1,24 @@
.. _vsphere_configure_network:
Configure the networks
======================
Configure networks
~~~~~~~~~~~~~~~~~~
Configure network for Fuel Admin (PXE) traffic
----------------------------------------------
To enable inter-node communication, you must configure networks on
VMware vCenter.
Configure a network for Fuel Admin (PXE) traffic
------------------------------------------------
You must configure a network for the Fuel Admin (PXE) traffic
and enable Promiscuous mode.
**To configure a network for the Fuel Admin (PXE) traffic:**
#. Go to the vCenter screen.
#. Choose **Hosts**.
#. Select the host on which you want to run the Fuel Master node.
#. Click the **Networking** button.
#. Click the **Add Host Networking** icon.
#. Go to the vCenter screen.
#. Choose **Hosts**.
#. Select the host on which you want to run the Fuel Master node.
#. Click the **Networking** button.
#. Click the **Add Host Networking** icon.
Create a vCenter Port Group network
-----------------------------------

View File

@@ -1,7 +1,7 @@
.. _vsphere_create_vm:
Create the Fuel Master node virtual machine
===========================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You need to create a new virtual machine with a guest
operating system to run the Fuel Master node on it.

View File

@@ -1,12 +0,0 @@
.. index:: vSphere Guide
.. _vsphere-guide:
==============================
Install Fuel on VMware vSphere
==============================
.. contents:: :local:
.. include:: /pages/draft/fuel-install-guide/contents-vsphere.rst

View File

@@ -1,8 +1,7 @@
.. _vsphere_install_master:
Install the Fuel Master node on VMware vSphere
==============================================
Install the Fuel Master node on VMware vSphere
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You need to install the Fuel Master node on the created
virtual machine.

View File

@@ -1,7 +1,13 @@
.. _vsphere_intro:
Before you install Fuel on VMware vSphere
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install Fuel on VMware vSphere
==============================
This section describes how to configure your VMware vSphere environment
to install Fuel.
VMware vSphere prerequisites
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Before you install Fuel and use your Mirantis OpenStack environment
in intergration with vSphere, you must configure all components
@@ -19,7 +25,7 @@ Complete the following steps:
For more information, see the VMware vSphere documentation.
Configure ESXi host networking
------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To integrate Mirantis OpenStack with VMware vCenter,
you must configure the VMware ESXi host networking.
@@ -29,16 +35,16 @@ you must configure the VMware ESXi host networking.
#. In VMware vSphere web-client open the ESXi host page.
#. Select **Manage** > **Networking**.
#. Click **Add network**.
The **Add networking** wizard starts.
The **Add networking** wizard starts.
#. In the **Add Networking** wizard, select the Virtual Machine Port
group.
#. Select the **Virtual Machine Port Group** option
to ensure that the network is created in vSwitch0.
#. Create a network called **br100**.
.. note::
You must name the network ``br100``. Otherwise, Fuel will not
be able to communicate with VMware vSphere.
.. note::
You must name the network ``br100``. Otherwise, Fuel will not
be able to communicate with VMware vSphere.
#. In the VLAN ID field, type a VLAN Tag.
#. Proceed to :ref:`vsphere_upload_iso`.

View File

@@ -1,7 +1,7 @@
.. _vsphere_mount_iso:
Mount the Fuel ISO
==================
~~~~~~~~~~~~~~~~~~
You must mount the Fuel ISO to install the Fuel Master node
on the virtual machine.

View File

@@ -1,7 +1,7 @@
.. _vsphere_upload_iso:
Upload the Fuel ISO to the VMware vSphere datastore
===================================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You need to download the `Fuel ISO <https://www.fuel-infra.org/#fuelget>`_
and upload it do a vSphere datastore.

View File

@@ -1,7 +1,7 @@
.. _vsphere_verify_master:
Verify the Fuel Master node operation
=====================================
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You need to verify that the Fuel Master node operates correctly.

View File

@@ -10,10 +10,10 @@ to ensure the provided plugin can be used with Mirantis OpenStack.
- `Fuel Plugin validation`_
- `Fuel Plugins SDK`_
- `Fuel Plugins catalog`_
- `Fuel Plugins catalog
<http://stackalytics.com/report/driverlog?project_id=openstack%2Ffuel>`__
.. links
.. _`Fuel Plugins SDK`: https://wiki.openstack.org/wiki/Fuel/Plugins
.. _`Fuel Plugins catalog`: http://stackalytics.com/report/driverlog?project_id=openstack%2Ffuel
.. _`Fuel Plugin validation`: https://www.mirantis.com/partners/become-mirantis-unlocked-partner/fuel-plugin-development/fuel-plugin-validation/

View File

@@ -37,7 +37,8 @@ Plugin-specific instructions
Every plugin has its own prerequisites, limitations and use cases.
To learn about specific instructions and recommendations, enter
`Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.
`Fuel Plugins Catalog
<https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`__.
Validation
----------

View File

@@ -52,13 +52,14 @@ Zabbix is no longer supported as a core Fuel component
Zabbix is now only available as a plugin for Fuel.
For information on prerequisites, installation
and configuration instructions, see the `Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.
and configuration instructions, see the `Fuel Plugins Catalog
<https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`__.
New Plugins for Fuel are available
++++++++++++++++++++++++++++++++++
Using the
`Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_,
`Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`__,
you can download and install new Fuel Plugins.
Please, note that they will be available within
a few weeks of the Mirantis OpenStack 6.1 release:

View File

@@ -16,7 +16,7 @@ more simply, in Horizon, by adding a new set of tabs to Network.
You can download Fuel plugins, read
the documentation and perform required
installation steps using
`Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
`Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`__.
For common instructions on installation,
see :ref:`Install Fuel Plugins <install-plugin>`.

View File

@@ -17,6 +17,6 @@ You can get acquainted with the
prerequisites, installation
and configuration instructions for Zabbix
in
`Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_
`Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`__
and then download the plugin.

View File

@@ -48,7 +48,7 @@ Installation steps
Installation procedure is common for all plugins, but their requirements differ.
#. Download a plugin from
`Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
`Fuel Plugins Catalog <http://stackalytics.com/report/driverlog?project_id=openstack%2Ffuel>`__.
#. Get acquainted with the plugin documentation to learn about
prerequisites and limitations.