Merge "Replaced virtualbox guide with QuickStart Guide"

This commit is contained in:
Jenkins 2015-09-09 09:13:46 +00:00 committed by Gerrit Code Review
commit f63eb03441
42 changed files with 685 additions and 486 deletions

BIN
_images/qsg/d_workflow1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

BIN
_images/qsg/d_workflow2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

View File

@ -8,11 +8,11 @@ Documentation
.. toctree::
quickstart-guide
planning-guide
user-guide
operations
monitoring-guide
virtualbox
reference-architecture
terminology
plugin-dev

View File

@ -0,0 +1,16 @@
.. include:: /pages/quickstart-guide/0300-qs-intro.rst
.. include:: /pages/quickstart-guide/0310-qs-prereq.rst
.. include:: /pages/quickstart-guide/0320-qs-download.rst
.. include:: /pages/quickstart-guide/0330-qs-install-scripts.rst
.. include:: /pages/quickstart-guide/0331-qs-modify-params.rst
.. include:: /pages/quickstart-guide/0332-qs-run-scripts-win.rst
.. include:: /pages/quickstart-guide/0333-qs-supported-os.rst
.. include:: /pages/quickstart-guide/0334-qs-install-scripts-procedure.rst
.. include:: /pages/quickstart-guide/0340-qs-install-manual.rst
.. include:: /pages/quickstart-guide/0341-qs-config-vm.rst
.. include:: /pages/quickstart-guide/0342-qs-vm-prereq-vm.rst
.. include:: /pages/quickstart-guide/0343-qs-config-network.rst
.. include:: /pages/quickstart-guide/0344-qs-create-vm.rst
.. include:: /pages/quickstart-guide/0345-qs-mount-iso.rst
.. include:: /pages/quickstart-guide/0346-qs-install-fuel.rst
.. include:: /pages/quickstart-guide/0350-qs-issues.rst

View File

@ -1,9 +0,0 @@
.. include:: /pages/virtualbox/0300-install-virtualbox.rst
.. include:: /pages/virtualbox/0330-install-automatic-virtualbox.rst
.. include:: /pages/virtualbox/0340-install-manual-virtualbox.rst
.. include:: /pages/virtualbox/0350-manual-master.rst
.. include:: /pages/virtualbox/0360-manual-slave.rst
.. include:: /pages/virtualbox/0500-network-virtualbox.rst
.. include:: /pages/virtualbox/0550-access-to-public-net.rst
.. include:: /pages/virtualbox/0800-notes.rst

View File

@ -7,6 +7,7 @@
PDF
~~~
`QuickStart Guide PDF <pdf/Mirantis-OpenStack-6.1-QcuikStartGuide.pdf>`_
`Planning Guide PDF <pdf/Mirantis-OpenStack-6.1-PlanningGuide.pdf>`_
`User Guide PDF <pdf/Mirantis-OpenStack-6.1-UserGuide.pdf>`_
`Operations Guide PDF <pdf/Mirantis-OpenStack-6.1-OperationsGuide.pdf>`_
@ -21,6 +22,10 @@ PDF
Guides
~~~~~~
`QuickStart Guide <quickstart-guide.html#quickstart-guide>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn how to install Mirantis OpenStack on VirtualBox.
`Planning Guide <planning-guide.html#planning-guide>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Explains how to plan Mirantis OpenStack deployment before installing

View File

@ -64,5 +64,3 @@ access the Public network for Nova API. The reason is because Keystone returns
the list of OpenStack services URLs, and for production-grade deployments it
is required to access services over public network.
.. seealso:: :ref:`access_to_public_net` if you want to configure the
installation on VirtualBox and fix issues like the one above.

View File

@ -52,16 +52,16 @@ You have ways to use Mirantis OpenStack and Fuel
other than the bare-metal installation:
- You can install Fuel and use it
to deploy a Mirantis OpenStack Environment on Oracle VirtualBox.
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.
See `0 to OpenStack in 60 Minutes or less
<https://software.mirantis.com/quick-start/>`_
to get started,
with additional information in :ref:`Running Fuel on VirtualBox<virtualbox>`.
Note that deployments on top of VirtualBox
do not generally meet the performance and robustness requirements
of most production environments.
See :ref:`0 to OpenStack in 60 Minutes or less<quickstart-guide>`
.. note::
The environments you deploy on VirtualBox are for testing purposes only.
Typically, a production environment requires extensive resources and
network planning.
- You can :ref:`install Fuel master node on vSphere<fuel-on-vsphere-ug>`
and deploy a Mirantis OpenStack Environment

View File

@ -38,7 +38,7 @@ Some general guiding principles:
and to avoid performance bottlenecks.
- For demonstration and study purposes,
you can deploy OpenStack on VirtualBox;
see :ref:`Running Fuel on VirtualBox<virtualbox>` for more information.
see :ref:`QuickStart Guide<qs_intro>` 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

View File

@ -99,8 +99,8 @@ its support still might be absent on compute nodes if they are themselves
running as virtual machines. In that case hypervisor running compute
nodes must support passing through hardware-assisted virtualization to
nested VMs and have it enabled. VirtualBox does not have that feature,
and as a result environments deployed by :ref:`virtualbox` will have
Sahara working poorly.
and as a result environments deployed as described in the :ref:`QuickStart
Guide <quickstart-guide>` will have Sahara working poorly.
**Communication between virtual machines**

View File

@ -0,0 +1,41 @@
.. _qs_intro:
Introduction
============
Fuel is a deployment tool that simplifies installation of Mirantis
OpenStack (MOS).
For testing, install Fuel on VirtualBox and use it to deploy the
Mirantis OpenStack environment.
You have the following options to deploy Fuel and the Mirantis OpenStack:
* **Automated installation using the Mirantis VirtualBox scripts**
When you install Mirantis OpenStack using the Mirantis VirtualBox
scripts, you do not need to configure the virtual machine network
and hardware settings. The script provisions the virtual machines
with all required settings automatically. However, you must place
the latest Mirantis OpenStack ISO image in the ``iso`` directory.
You may also modify the number of Fuel Slave Nodes using the
``config.sh`` script.
`Automated Installation Workflow`
.. image:: /_images/qsg/d_workflow1.png
:width: 60%
:align: center
* **Manual Installation**
When installing manually, you need to configure the virtual machine
settings according to the hardware and network prerequisites.
Use manual installation only if you cannot run the Mirantis
VirtualBox scripts for some technical or business reasons.
`Manual Installation Workflow`
.. image:: /_images/qsg/d_workflow2.png
:width: 70%
:align: center
.. seealso::
- :ref:`Prerequisites<qs_prereq>`

View File

@ -0,0 +1,29 @@
.. _qs_prereq:
Prerequisites
=============
Your environment must meet the following software prerequisites:
- A 64-bit host operating system with at least 8 GB RAM and
300 GB of free space
Virtualization must be enabled in BIOS.
If you use Microsoft Windows, use Cygwin.
- `VirtualBox <https://www.virtualbox.org/>`_ 4.2.16 or later
- `Oracle VM VirtualBox Extension Pack <https://www.virtualbox.org/>`_ for your version of VirtualBox
- `Mirantis OpenStack ISO <https://docs.mirantis.com/openstack/fuel/fuel-master/#downloads>`_
- `Mirantis VirtualBox scripts <https://docs.mirantis.com/openstack/fuel/fuel-master/#downloads>`_ (recommended)
The Mirantis VirtualBox scripts version must match the version of
Mirantis OpenStack.
.. note::
Mirantis recommends that you install the latest version of Mirantis
OpenStack.
.. seealso::
- :ref:`Downloading the Mirantis Openstack Image <qs_download>`

View File

@ -0,0 +1,18 @@
.. _qs_download:
Downloading the Mirantis OpenStack Image
========================================
Before downloading the Mirantis OpenStack image, verify that your
environment meets :ref:`qs_prereq`.
**Procedure:**
#. Go to `Mirantis web-site <http://mirantis.com>`_.
#. Download the latest version of Mirantis OpenStack.
#. If you want to install Mirantis OpenStack using scripts, download
the `Mirantis VirtualBox scripts <https://docs.mirantis.com/openstack/fuel/fuel-master/#downloads>`_.
#. Depending on how you want to install Mirantis OpenStack, proceed to:
* :ref:`Installing Mirantis OpenStack Using the Mirantis VirtualBox Scripts<qs_install_vbox_scripts>`
* :ref:`Installing Mirantis OpenStack Manually<qs_install_manually>`

View File

@ -0,0 +1,52 @@
.. _qs_install_vbox_scripts:
Installing Mirantis OpenStack Using the Mirantis VirtualBox Scripts
===================================================================
To simplify the installation of Mirantis OpenStack and Fuel, Mirantis
provides a set of automated scripts. You can run the scripts in Linux,
in Mac OS, or in Windows using Cygwin.
Before running the installation script, execute the following actions
to the files and folders as needed:
* **iso**
Place the Fuel ISO image into this directory. If the directory
contains more than one ISO file, the installation script uses the
most recent one.
* **config.sh**
Use this configuration file to specify parameters that automate the
Fuel installation. For example, you can select how many virtual nodes
to create, as well as how much memory, storage, and CPU to allocate
to each machine.
* Depending on the amount of memory on your computer, run one of the
following deployment scripts:
* launch.sh
Use this script if you have at least 8 GB of RAM on your computer.
The script deploys the following configuration:
- 1 Fuel Master node
- 3 Fuel Slave nodes: 1 node - 2048 MB RAM, 2 nodes - 1024 MB RAM
* launch_8GB.sh
Use this script if you have at least 8 GB RAM on your computer.
This script deploys the following configuration:
- 1 Fuel Master node
- 3 Slave nodes: 1536 MB RAM
* launch_16GB.sh
Use this script if you have at least 16 GB RAM on your computer.
This script deploys the following configuration:
- 1 Fuel Master node
- 5 Slave nodes: 2048 MB RAM
.. seealso::
- :ref:`qs_prereq`

View File

@ -0,0 +1,65 @@
.. _qs_modify_params:
Modifying the Deployment Parameters
-----------------------------------
You can modify the default configuration as needed by editing the
``config.sh`` file.
.. warning:: If you are not familiar with scripting, do not modify
the scripts. Use the default configuration for testing.
**Procedure:**
1. Open the ``config.sh`` file.
2. Modify the required parameters:
**Table 1. Deployment Paramters**
+-------------------------+-------------------------------------------+
|**Parameters** |**Description** |
+=========================+===========================================+
|``vm_master_memory_mb`` |Amount of RAM allocated to the Fuel Master |
| |node in MB. Default value is 1536. |
+-------------------------+-------------------------------------------+
|``vm_master_disk_mb`` |Size of the hard disk drive on the Fuel |
| |Master node in MB. Default value is 65 GB. |
+-------------------------+-------------------------------------------+
|``vm_master_nat_network``|Network allocated to the Fuel Master node |
| |through the NAT adapter. Default value is |
| |192.168.200.0/24. |
+-------------------------+-------------------------------------------+
|``vm_master_nat_gateway``|Default gateway on the Fuel Master node. |
| |Default value is 192.168.200.2. |
+-------------------------+-------------------------------------------+
|``vm_master_ip`` |The Fuel Master node IP address. Default |
| |value is 10.20.0.2. You can modify the |
| |default IP address either in this script or|
| |during the boot time. |
+-------------------------+-------------------------------------------+
|``vm_master_username`` |The Fuel Master node super user. Default |
| |value is root. |
+-------------------------+-------------------------------------------+
|``vm_master_password`` |The password for the Fuel Master node |
| |super user. Default value is r00tme. |
+-------------------------+-------------------------------------------+
|``cluster_size`` |The number of the Fuel Slave nodes to |
| |deploy. |
+-------------------------+-------------------------------------------+
|``vm_slave_cpu`` |The number of CPUs on each Fuel Slave node.|
| |Default value is 1. |
+-------------------------+-------------------------------------------+
|``vm_slave_memory_mb`` |Amount of RAM on a slave node in MB. |
| |If your host system has 8 GB, default value|
| |is 1536 MB. |
| |If your host system has 16 GB, default |
| |value is 1024 MB. |
+-------------------------+-------------------------------------------+
3. Save the ``config.sh`` file.
4. Proceed to :ref:`Installing Mirantis OpenStack Using Scripts<qs_install_scripts>`.
.. seealso::
- :ref:`qs_supported_os`
- :ref:`qs_scripts_run_windows`

View File

@ -0,0 +1,44 @@
.. _qs_scripts_run_windows:
Running the Mirantis VirtualBox Scripts on Microsoft Windows
------------------------------------------------------------
If you run the Mirantis VirtualBox scripts in Microsoft Windows,
use Cygwin.
Install the following Cygwin packages:
* expect
* openssh
* procps
**Procedure:**
#. Go to `Cygwin web-site <https://www.cygwin.com>`_.
#. Download Cygwin for Windows 64-bit (setup-x86_64.exe).
#. Launch Cygwin and follow the installation wizard.
#. When prompted, in the **Select Packages** screen, select the
required packages to install.
#. Type the package name in the **Search** bar.
#. Click on the search result.
#. Click **Skip**.
The **Skip** status changes to the version of the package.
#. Repeat **Step 1** **Step 3** for all packages.
#. Click **Next**.
Cygwin installs on your computer.
#. Verify that you install the required packages by typing:
::
cygcheck --check-setup --dump-only
#. Proceed to :ref:`qs_install_scripts`.
.. seealso::
- :ref:`qs_supported_os`

View File

@ -0,0 +1,18 @@
.. _qs_supported_os:
Supported Host Operating Systems for Scripted Installation
----------------------------------------------------------
Mirantis OpenStack supports scripted installation on the
following operating systems:
* Mac OS 10.7.5
* Ubuntu 12.04, 12.10, 14.04
* Fedora 19
* OpenSUSE 12.2, 12.3
* Microsoft Windows 7 x64 bit with Cygwin x64
* Microsoft Windows 8 x64 bit with Cygwin x64
.. seealso::
- :ref:`qs_scripts_run_windows`

View File

@ -0,0 +1,55 @@
.. _qs_install_scripts:
Installing Mirantis OpenStack Using Scripts
-------------------------------------------
The Mirantis VirtualBox scripts significantly simplify deployment of
the OpenStack environment. The scripts install the Fuel Master node
and Fuel Slave nodes, which create a platform for the OpenStack
components. You can install Mirantis OpenStack using the automated
scripts on Microsoft Windows, Mac OS, or Linux.
If you are installing Mirantis OpenStack on Microsoft Windows,
verify the following:
* Virtualization is enabled in BIOS
* You completed the steps described in :ref:`qs_scripts_run_windows`.
**Procedure:**
1. On your computer, extract the Mirantis VirtualBox scripts in a
directory.
2. Copy the Mirantis OpenStack ISO image to the iso folder.
3. Run the ``launch.sh``, ``launch_8GB``, or ``launch_16GB script``.
* If you use Microsoft Windows:
1. Run Cygwin.
2. In the Cygwin prompt, navigate to the directory where you
extracted the ``launch.sh`` file.
**Example:**
::
cd /cygdrive/c/Users/{name}/Desktop/virtualbox
3. Run the ``launch.sh``, ``launch_8GB``, or ``launch_16GB``
script in Cygwin.
**Example:**
::
sh launch.sh
The script installs the Fuel Master node on VirtualBox.
The installation may take up to 30 minutes. Do not turn
off your computer or interrupt the installation.
4. Proceed to :ref:`start-create-env-ug`.
.. seealso::
- :ref:`qs_issues_linux`
- :ref:`qs_supported_os`

View File

@ -0,0 +1,10 @@
.. _qs_install_manually:
Installing Mirantis OpenStack Manually
======================================
If you do not want to use the Mirantis VirtualBox scripts, you can
install Mirantis OpenStack on VirtualBox manually.
.. warning:: Do not use a manually configured environment for
production or customized deployments.

View File

@ -0,0 +1,12 @@
.. _qs_config_vm:
Configuring Virtual Machines
----------------------------
Before installing Fuel, you must configure the Fuel Master node
and Fuel Slave nodes virtual machines.
The virtual machine configuration includes:
* :ref:`qs_config_network`
* :ref:`qs_create_vms`
* :ref:`qs_mount_iso`

View File

@ -0,0 +1,26 @@
.. _qs_vm_requirements:
Virtual Machine Requirements
----------------------------
Your virtual machines must meet the following hardware requirements:
**Fuel Master Node:**
* OS Type: Linux
* Version: Ubuntu (64bit)
* RAM: 1536+ MB (2048+ MB recommended)
* HDD (VDI): 50 GB dynamically allocated
* Network: 2 Host-Only Adapters Intel PRO/1000 MT desktop
driver, 1 NAT Adapter Intel PRO/1000 MT desktop driver
**Fuel Slave Nodes:**
* OS Type: Linux, Version: Ubuntu (64bit)
* RAM: 1536+ MB (2048+ MB recommended)
* HDD (VDI): 50+ GB, with dynamic disk expansion
* Network: 3 Host-Only Adapters Intel PRO/1000 MT desktop driver
.. seealso::
- :ref:`qs_config_network`

View File

@ -0,0 +1,41 @@
.. _qs_config_network:
Configuring the Network
-----------------------
Configure the VirtualBox Host-Only Ethernet Adapters for the Fuel
Master node and Fuel Slave nodes.
**Procedure:**
1. In VirtualBox, click **File > Preferences > Network**.
2. Select **Host-only Networks**.
3. Create three VirtualBox Host-Only Ethernet Adapters by clicking
the **Create** icon.
VirtualBox creates new Ethernet adapters.
For the purpose of example, Ethernet adapters names are:
* vboxnet0
* vboxnet1
* vboxnet2
4. Modify the settings of the vboxnet0 adapter:
* IPv4 Address: 10.20.0.1
* IPv4 Network mask: 255.255.255.0
* DHCP Server: disabled
5. Modify the settings of the vboxnet1 adapter:
* IPv4 Address: 172.16.0.254
* IPv4 Network mask: 255.255.255.0
* DHCP Server: disabled
6. Modify the settings for the vboxnet2 adapter:
* IPv4 Address: 172.16.1.1
* IPv4 Network mask: 255.255.255.0
* DHCP Server: disabled
7. Proceed to :ref:`qs_create_vms`.

View File

@ -0,0 +1,40 @@
.. _qs_create_vms:
Creating Virtual Machines
-------------------------
You must manually configure virtual machines for the Fuel installation.
Create one virtual machine for the Fuel Master node and at least
three virtual machines for Fuel Slave Nodes.
**Procedure:**
1. In VirtualBox, configure the Fuel Master node virtual machine
according to the :ref:`qs_vm_requirements`.
2. In the Fuel Master node network settings, configure the following
network adapters:
- **Adapter 1:** Host-only adapter vboxnet0
- **Adapter 2:** Host-only adapter vboxnet1
- **Adapter 3:** NAT
3. Configure at least three Fuel Slave nodes virtual machines
according to the :ref:`qs_vm_requirements`.
4. Right-click on a Fuel Slave node VM and select **System**.
5. In **Boot Order**, select **Network**.
6. Click **OK**.
7. Right-click on the Fuel Slave node VM and select **Network**.
8. Configure the following network adapters:
- **Adapter 1:** Host-only adapter vboxnet0
- **Adapter 2:** Host-only adapter vboxnet1
- **Adapter 3:** Host-only adapter vboxnet2
9. Specify the following parameters to the Fuel Slave node network adapters:
- Promiscuous mode: **Allow All**
- Adapter Type: **Intel PRO/1000 MT Desktop**
- Select the **Cable Connected** checkbox
11. Repeat **Step 5** - **Step 9** for each Fuel Slave node.
12. Proceed to :ref:`qs_mount_iso`.

View File

@ -0,0 +1,20 @@
.. _qs_mount_iso:
Mounting the Mirantis OpenStack ISO Image
-----------------------------------------
To install Fuel, mount the Mirantis OpenStack ISO image in the virtual
machine settings.
**Procedure:**
1. Right-click the Fuel Master node.
2. Select **Storage**.
3. Select the empty optical drive.
4. Click the optical drive icon.
5. Select **Choose Virtual Optical Disk File**.
6. Open the Fuel ISO image.
7. Proceed to :ref:`qs_install_fuel`.
.. seealso::
- :ref:`qs_download`

View File

@ -0,0 +1,74 @@
.. _qs_install_fuel:
Installing Fuel
---------------
After you complete the steps described in Configuring Virtual Machines,
install Fuel.
**Procedure:**
#. Power on the Fuel Master node VM to start the installation.
#. When prompted, select **DVD Fuel Install**.
Fuel installs on the virtual machine. It may take some time.
The network configuration screen displays:
.. image:: /_images/qsg/src_network_setup.png
:width: 60%
#. Press F8.
**System response:**
::
Loading docker images. (This may take a while)
When Fuel completes the installation, the following message displays:
::
Welcome to the Fuel server
...
fuel login:
#. After the Fuel Master node installs, power on the Fuel Slave nodes.
When the Fuel Slave nodes boot, the Fuel Master node automatically discovers them.
#. Log in to the Fuel Master Node CLI using the default credentials.
#. Verify the eth1 configuration:
1. Type:
::
vi /etc/sysconfig/network-scripts/ifcfg-eth1
2. Verify that the lines listed below have the following values:
::
DEVICE=eth1
TYPE=Ethernet
ONBOOT=yes
NM_CONTROLLED=no
BOOTPROTO=static
IPADDR=172.16.0.1
NETMASK=255.255.255.0
3. Modify if needed.
4. Save changes and quit:
::
:qw!
7. Configure the IP tables rerouting:
::
iptables -t nat -A POSTROUTING -s 172.16.0.0/24 \! -d 172.16.0.0/24 -j MASQUERADE
8. Log in to the Fuel UI by pointing your browser to the URL specified in the command prompt.
Use the default login and password.
9. Proceed to :ref:`start-create-env-ug`.

View File

@ -0,0 +1,57 @@
.. _qs_issues_linux:
Resolving the Network Issues on Some Linux Distributions
========================================================
In some Linux distributions, for example in Fedora 20, you may encounter an issue
when the NetworkManager service interfering with the VirtualBox host-only network
adapters.
The NetworkManager service may interfere with the VirtualBox IP addresses assigned
for host-only adapters and remove the IP addresses after the DHCP timeout.
This may result in issues with an HA environment deployment.
**Procedure:**
#. Verify the Fuel installation is completed.
#. Open the VirtualBox network configuration file for editing.
#. In the beginning of the configuration file, add the following line:
::
NM_CONTROLLED=no
#. Save the file.
#. Repeat **Step 2** to **Step 5** for all network interface configuration files.
Depending on how you configure your environment and your Linux distribution,
the network configuration files may have different names.
**Example:**
::
[user@system]$ ls -l /etc/sysconfig/network-scripts/ifcfg-*
-rw-r--r--. 1 root root 254 Jan 14 2014 /etc/sysconfig/network-scripts/\
ifcfg-lo
-rw-r--r--. 1 root root 178 Feb 13 12:01 /etc/sysconfig/network-scripts/\
ifcfg-p2p1
-rw-r--r--. 1 root root 242 Feb 16 12:14 /etc/sysconfig/network-scripts/\
ifcfg-Wired_connection_1
-rw-r--r--. 1 root root 242 Feb 16 12:14 /etc/sysconfig/network-scripts/\
ifcfg-Wired_connection_2
-rw-r--r--. 1 root root 242 Feb 16 12:14 /etc/sysconfig/network-scripts/\
ifcfg-Wired_connection_3
In the example above, the ``NM_CONTROLLED=no`` line must be added to the following
files:
* ``Wired_connection_1``
* ``Wired_connection_2``
* ``Wired_connection_3``
#. In VirtualBox, stop all VMs.
#. Reboot the host operating system.
#. Start all VMs.
.. seealso::
- `LP1421723 <https://bugs.launchpad.net/fuel/+bug/1421723>`_

View File

@ -7,5 +7,7 @@ How to Obtain the Product
Mirantis OpenStack is distributed as
a self-contained ISO.
You can download the ISO in
`the Mirantis OpenStack download section <https://software.mirantis.com/openstack-download-form/>`_ of the Mirantis Portal.
We have also created Oracle VirtualBox scripts to enable quick and easy deployment of a multi-node OpenStack cloud for evaluation purposes; see :ref:`Running Mirantis OpenStack on VirtualBox <virtualbox>`.
`the Mirantis OpenStack download section <https://software.mirantis.com/openstack-download-form/>`_
on the Mirantis Portal. We have also created the Oracle VirtualBox
scripts to enable quick and easy deployment of a multi-node OpenStack
cloud for evaluation purposes; see :ref:`QuickStart Guide <quickstart-guide>`.

View File

@ -32,7 +32,7 @@ then use that media to install the software.
in VirtualBox.
In that case, copy the ISO file to the appropriate directory
and boot directly from that disk file.
See :ref:`virtualbox`.
See :ref:`QuickStart Guide <quickstart-guide>`.
Use any standard software to burn the ISO to a writable DVD.

View File

@ -1,115 +0,0 @@
Introduction
============
You can install Fuel on VirtualBox and use that to deploy a Mirantis
OpenStack environment for demonstration and evaluation purposes.
Mirantis provides scripts that create and configure all the VMs required
for a test environment, including the Master node and Slave nodes.
This guide provides information on how to run Fuel and Mirantis OpenStack
on VirtualBox.
Prerequisites
-------------
Running Fuel and Mirantis OpenStack on VirtualBox has a number of prerequisites
and dependencies. Before proceding with the deployment steps, please
verify whether you meet these requirements:
#. Run VirtualBox on a stable host system; we recommend 64-bit host OS.
The scripts have been tested on Mac OS 10.7.5, Mac OS 10.8.3,
Ubuntu 12.04, Ubuntu 12.10, Ubuntu 14.04, Fedora 19, OpenSUSE 12.2/12.3,
Windows 7 x64 + Cygwin_x64, and Windows 8 x64 + Cygwin_x64.
#. Download and install
`VirtualBox <https://www.virtualbox.org/wiki/Downloads>`__ 4.2.16 or later.
#. Download and install
`VirtualBox extensions <https://www.virtualbox.org/wiki/Downloads>`_.
#. Download Mirantis VirtualBox scripts from the
`Downloads <https://docs.mirantis.com/openstack/fuel/fuel-master/#downloads>`_ tab.
#. Download the `Mirantis OpenStack ISO <https://software.mirantis.com/openstack-downloads/>`_.
If you want to run these scripts on Windows directly, you should also:
#. Download and install Cygwin for 64-bit version of Windows.
#. Select ``expect``, ``openssh``, and ``procps`` packages to install.
To do this, search by the names of the packages required
in the :guilabel:`Select Packages` dialog of the Cygwin install wizard:
.. image:: /_images/procps.png
:align: center
|
**Hardware Recommendations: 8 GB+ of RAM**
* Supports 4 VMs for Multi-node OpenStack installation
(1 Master node, 1 Controller node, 1 Compute node, 1 Cinder node).
The size of each VM should be reduced to 1536 MB RAM.
For dedicated Cinder node, 768 MB of RAM is enough.
or
* Supports 5 VMs for Multi-node with HA OpenStack installation
(1 Master node, 3 combined Controller + Cinder nodes, 1 Compute node).
The size of each VM should be reduced to 1280 MB RAM.
This is less that the recommended amount of RAM amount per node
for HA configurations (2048+ MB per controller)
and may lead to unwanted issues.
Issue with some Linux distributions
-----------------------------------
In some of Linux distributions (at least in Fedora 20), you may encounter
an issue with the NetworkManager service interfering with VirtualBox host-only
network functionality.
NetworkManager service may interfere with VirtualBox IP addresses assigned
for host-only adapters and remove the IP addresses after DHCP timeout. This
may lead to different problems: for example, it will be impossible
to deploy an HA environment.
To avoid the problem, follow these steps:
#. Make sure the the initial installation of Fuel is completed.
#. Add the **NM_CONTROLLED=no** line at the beginning of all
vboxnet interface configuration files.
These files may be called differently, depending on
your Linux distribution or configuration.
Example:
::
[user@system]$ ls -l /etc/sysconfig/network-scripts/ifcfg-*
-rw-r--r--. 1 root root 254 Jan 14 2014 /etc/sysconfig/network-scripts/\
ifcfg-lo
-rw-r--r--. 1 root root 178 Feb 13 12:01 /etc/sysconfig/network-scripts/\
ifcfg-p2p1
-rw-r--r--. 1 root root 242 Feb 16 12:14 /etc/sysconfig/network-scripts/\
ifcfg-Wired_connection_1
-rw-r--r--. 1 root root 242 Feb 16 12:14 /etc/sysconfig/network-scripts/\
ifcfg-Wired_connection_2
-rw-r--r--. 1 root root 242 Feb 16 12:14 /etc/sysconfig/network-scripts/\
ifcfg-Wired_connection_3
Here, files **Wired_connection_1** through **Wired_connection_3** are the files
that configure vboxnet interfaces and should be edited with the *NM_CONTROLLED=no** line.
#. Stop all VMs in VirtualBox.
#. Reboot the host.
#. Start the VMs.
#. Proceed with environment creation.
For more information, see `LP1421723 <https://bugs.launchpad.net/fuel/+bug/1421723>`_.

View File

@ -1,61 +0,0 @@
.. _Install_Automatic:
Installing Using Automated Scripts
==================================
#. Extract Mirantis VirtualBox scripts. The package should include the
following:
`iso`
The directory containing the ISO image used to install Fuel.
You should download the ISO from the portal to this directory
or copy it into this directory after it is downloaded.
If this directory contains more than one ISO file,
the installation script uses the most recent one.
`config.sh`
Configuration file that allows you to specify parameters
that automate the Fuel installation.
For example, you can select how many virtual nodes to launch,
as well as how much memory, disk, and processing to allocate for each.
`launch.sh`
This is the script you run to install Fuel.
It uses the ISO image from the ``iso`` directory,
creates a VM, mounts the image,
and automatically installs the Fuel Master node.
After installing the Master node,
the script creates Slave nodes for OpenStack
and boots them via PXE from the Master node.
When Fuel is installed,
the script gives you the IP address to use
to access the Web-based UI for Fuel.
Use this address to deploy your OpenStack environment.
#. Add Mirantis OpenStack ISO to the extracted VirtualBox ``iso`` folder.
#. Run the ``launch.sh`` script to install Fuel.
For the Windows users:
* Navigate to directory with the ``launch.sh`` file in Cygwin prompt,
for example: ``cd /cygdrive/c/Users/{name}/Desktop/virtualbox``
* Use the :command:`sh {shell script}` command to run a shell script in
Cygwin::
sh launch.sh
.. note:
Depending on your system resources, the Fuel installation process can take
up to an hour to complete.
The Fuel installation is complete when the VirtualBox fuel-master node shows
the following details about your environment:
.. image:: /_images/fuel_master_install.png
:align: center
#. See the :ref:`start-create-env-ug` for the instructions on how to log
in to the Fuel UI and set up your first environment.

View File

@ -1,12 +0,0 @@
.. _Install_Manual:
Manual Installation
===================
.. note::
The following steps are suitable only for setting up a vanilla OpenStack
environment for evaluation purposes only.
If you cannot or would rather not run our helper scripts, you can still run
Fuel on VirtualBox by following these steps.

View File

@ -1,33 +0,0 @@
Deploying the Master Node Manually
----------------------------------
First, create the Master node VM.
#. Configure the host-only interface vboxnet0 in VirtualBox by going to
*File -> Preferences -> Network*, then on the *Host-only Networks*
tab click the screwdriver icon:
* IP address: 10.20.0.1
* Network mask: 255.255.255.0
* DHCP Server: disabled
.. image:: /_images/host-only-networks-preferences.png
.. image:: /_images/host-only-networks-details.png
#. Create a VM for the Fuel Master node with the following parameters:
* OS Type: Linux
* Version: Ubuntu (64bit)
* RAM: 1536+ MB (2048+ MB recommended)
* HDD: 50 GB with dynamic disk expansion
#. Modify your VM settings:
* Network: Attach *Adapter 1* to *Host-only adapter* *vboxnet0*
#. Power on the VM in order to start the installation. Choose your Fuel ISO
when prompted to select start-up disk.
#. Wait for the Welcome message with all information needed to login into the UI
of Fuel.

View File

@ -1,51 +0,0 @@
Adding Slave Nodes Manually
---------------------------
Configure the host-only interfaces.
#. In the VirtualBox main window, go to *File -> Preferences -> Network*.
On the :guilabel:`Host-only Networks` tab, click the screwdriver icon.
* Create network *vboxnet1*:
- IP address: 172.16.0.254
- Network mask: 255.255.255.0
- DHCP Server: disabled
.. image:: /_images/vboxnet1.png
* Сreate network *vboxnet2*:
- IP address: 172.16.1.1
- Network mask: 255.255.255.0
- DHCP Server: disabled
.. image:: /_images/vboxnet2.png
Next, create Slave nodes where OpenStack needs to be installed.
#. Create 3 or 4 additional VMs with the following parameters:
* OS Type: Linux, Version: Ubuntu (64bit)
* RAM: 1536+ MB (2048+ MB recommended)
* HDD: 50+ GB, with dynamic disk expansion
* Network 1: host-only interface vboxnet0, Intel PRO/1000 MT desktop driver
#. Set Network as first in the boot order:
.. image:: /_images/vbox-image1.png
:align: center
#. Configure two or more network adapters on each VM (in order to use single network
adapter for each VM you should choose :guilabel:`Use VLAN Tagging` later in the
Fuel UI):
.. image:: /_images/vbox-image2.png
:align: center
#. Open :guilabel:`Advanced` collapse, and set the following options:
* Set :guilabel:`Promiscuous mode` to :guilabel:`Allow All`
* Set :guilabel:`Adapter Type` to :guilabel:`Intel PRO/1000 MT Desktop`
* Check :guilabel:`Cable connected`

View File

@ -1,19 +0,0 @@
Networking
==========
By default, the launch script for the VirtualBox deployment
creates three host-interface adapters.
Basically, networking works as if you have 3 switches,
one of which is connected to a VM network interface.
This means that you have L2 connectivity between VMs
on interfaces with the same name.
If, for example, you try to move
the management network to `eth1` on the Controller node,
and the same network to `eth2` on the Compute node,
then there will be no connectivity between OpenStack services,
despite being configured to exist on the same VLAN.
You can validate your network settings prior to deployment
by clicking the "Verify Networks" button.
If you need to access the OpenStack REST API over the Public network,
VNC console of VMs, Horizon in HA mode or VMs, refer to this section:
:ref:`access_to_public_net`.

View File

@ -1,97 +0,0 @@
.. _access_to_public_net:
Deployment configuration to access OpenStack API and VMs from host machine
==========================================================================
Follow the instructions
in :ref:`create-env-ug` and :ref:`configure-env-ug`
to create and configure your OpenStack environment.
Most of the steps are the same for a VirtualBox deployment
and the bare-metal deployment.
The one exception is networking,
where the VirtualBox deployment requires some different settings.
Helper scripts for VirtualBox
create the network adapters `eth0`, `eth1`, `eth2`
which are represented on the host machine
as `vboxnet0`, `vboxnet1`, `vboxnet2` correspondingly,
and assigned IP addresses for adapters::
vboxnet0 - 10.20.0.1/24
vboxnet1 - 172.16.0.254/24
vboxnet2 - 172.16.1.1/24
For the demo environment on VirtualBox,
the first network adapter is used to run Fuel network traffic,
including PXE discovery.
To access the Horizon and OpenStack RESTful API
via the Public :ref:`logical network<logical-networks-arch>`
from the host machine,
you must have a route from your host
to the Public IP address on the OpenStack Controller.
Also, if you need to access a VM's Floating IP,
you must also have a route to the Floating IP on the Compute node,
which is bound to the Public interface there.
To make this configuration possible
on the VirtualBox demo environment,
you must run the Public network untagged.
On the image below, you can see the configuration of
Public and Floating networks which allows this:
.. image:: /_images/vbox_public_settings.jpg
:align: center
:width: 80%
By default, Public and Floating networks
run on the first network interface.
This must be changed on each node,
to run these networks on eth1
by setting the configuration as shown here:
.. image:: /_images/vbox_node_settings.jpg
:align: center
:width: 80%
If you use the default configuration in VirtualBox scripts,
and use the settings shown on the images above,
you should be able to access OpenStack Horizon via
the Public network after the installation.
If you want to enable Internet access
on VMs that are provisioned by OpenStack,
you must configure NAT on the host machine.
When packets reach the `vboxnet1` interface,
according to the OpenStack settings tab,
they must know the way out of the host.
For Ubuntu, the following command, executed on the host,
makes this happen::
sudo iptables -t nat -A POSTROUTING -s 172.16.1.0/24 \! -d 172.16.1.0/24 -j \
MASQUERADE
To access VMs managed by OpenStack,
you must provide IP addresses from the Floating IP range.
When the OpenStack environment is deployed and VM is provisioned there,
you have to associate one of the Floating IP addresses
from the pool with this VM,
whether in Horizon or via Nova CLI.
By default, OpenStack blocks all the traffic to the VM.
To allow the connectivity to the VM,
you need to configure :ref:`security groups<security-groups-term>`.
This can be done in Horizon or from the OpenStack Controller.
For example, the following commands
issued from the OpenStack controller
allow ICMP and SSH traffic to pass on to the VM::
. /root/openrc
nova secgroup-add-rule default icmp -1 -1 0.0.0.0/0
nova secgroup-add-rule default tcp 22 22 0.0.0.0/0
IP ranges for Public and Management networks (172.16.*.*)
are defined in the ``config.sh`` script.
If default values do not fit your needs,
you are free to change them,
but you must make the modifications
before running the **launch.sh** command
to install the Fuel Master node.

View File

@ -1,29 +0,0 @@
Additional Notes
================
- Do not run VirtualBox as the root user
or as any user with superuser permissions.
You must run it as a normal user
and add this user name to the *vboxusers* security group,
which is automatically created as part of the VirtualBox installation.
The following command adds the "myname" user to the vboxusers group::
sudo useradd -G vboxusers myname
- If the target server where you run VirtualBox
is not running X11,
you must modify the scripts to use the headless option:
in config.sh use ``headless=1``. The default setting is
``headless=0`` starts the VMs with GUI. Using ``headless=1``
will start the VMs without GUI.
- As part of the improved networking configuration in Mirantis
OpenStack 6.1, the VirtualBox scripts now use
Intel e1000 Desktop as a virtual network adapter. This means that
starting with Mirantis OpenStack 6.1, you can deploy on VirtualBox
with Intel network cards only.
Mirantis OpenStack 6.0 and older use AMD PCNet 32 Fast III as
a virtual network adapter and cannot be deployed on VirtualBox
with Intel network cards.

View File

@ -18,11 +18,11 @@ exclude_patterns = ['_*', 'pages', 'contents', 'index', '*-guide', '*.rst']
pdf_documents = [
# (master_doc, project, project, copyright),
('pdf/pdf_quickstart-guide', u'Mirantis-OpenStack-6.1-QuickStartGuide', u'QuickStart Guide', u'2015, Mirantis Inc.'),
('pdf/pdf_planning-guide', u'Mirantis-OpenStack-6.1-PlanningGuide', u'Planning Guide', u'2015, Mirantis Inc.'),
('pdf/pdf_user', u'Mirantis-OpenStack-6.1-UserGuide', u'User Guide', u'2015, Mirantis Inc.'),
('pdf/pdf_operations', u'Mirantis-OpenStack-6.1-OperationsGuide', u'Operations Guide', u'2015, Mirantis Inc.'),
('pdf/pdf_monitoring-guide', u'Mirantis-OpenStack-6.1-MonitoringGuide', u'Monitoring Guide', u'2015, Mirantis Inc.'),
('pdf/pdf_virtualbox', u'Mirantis-OpenStack-6.1-Running-Mirantis-OpenStack-on-VirtualBox', u'Running Mirantis OpenStack on VirtualBox', u'2015, Mirantis Inc.'),
('pdf/pdf_reference', u'Mirantis-OpenStack-6.1-ReferenceArchitecture', u'Reference Architecture', u'2015, Mirantis Inc.'),
('pdf/pdf_plugin-dev', u'Mirantis-OpenStack-6.1-FuelPluginGuide', u'Fuel Plugin Guide', u'2015, Mirantis Inc.'),
('pdf/pdf_terminology', u'Mirantis-OpenStack-6.1-Terminology-Reference', u'Terminology Reference', u'2015, Mirantis Inc.'),

View File

@ -0,0 +1,32 @@
.. header::
.. cssclass:: header-table
+-------------------------------------+-----------------------------------+
| Mirantis OpenStack v6.1 | .. cssclass:: right|
| | |
| QuickStart Guide | ###Section### |
+-------------------------------------+-----------------------------------+
.. footer::
.. cssclass:: footer-table
+--------------------------+----------------------+
| | .. cssclass:: right|
| | |
| ©2015, Mirantis Inc. | Page ###Page### |
+--------------------------+----------------------+
.. raw:: pdf
PageBreak oneColumn
.. toctree::
.. include:: /pages/preface/preface.rst
.. _quickstart-guide:
.. include:: /contents/contents-quickstart-guide.rst

View File

@ -1,31 +0,0 @@
.. header::
.. cssclass:: header-table
+------------------------------------------+-----------------------------------+
| Mirantis OpenStack v6.1 | .. cssclass:: right|
| | |
| Running Mirantis OpenStack on VirtualBox | ###Section### |
+------------------------------------------+-----------------------------------+
.. footer::
.. cssclass:: footer-table
+--------------------------+----------------------+
| | .. cssclass:: right|
| | |
| ©2015, Mirantis Inc. | Page ###Page### |
+--------------------------+----------------------+
.. raw:: pdf
PageBreak oneColumn
.. toctree::
.. include:: /pages/preface/preface.rst
.. _virtualbox:
.. include:: /contents/contents-virtualbox.rst

12
quickstart-guide.rst Normal file
View File

@ -0,0 +1,12 @@
.. index:: QuickStart Guide
.. _quickstart-guide:
================
QuickStart Guide
================
.. contents:: :local:
.. include:: /contents/contents-quickstart-guide.rst

View File

@ -1,11 +0,0 @@
.. index:: VirtualBox Installation
.. _virtualbox:
========================================
Running Mirantis OpenStack on VirtualBox
========================================
.. contents:: :local:
.. include:: /contents/contents-virtualbox.rst