Moved information from install to separate vbox doc

I did a wee bit of wordsmithing but the content is unchanged.

A section that used to be in the FAQ duplicated instructions to select
promiscuous mode, which is in the main instructions, so I deleted it.

Change-Id: I1d8e10f7c2ef37069d1c55c7b2b18368b39a8c31
This commit is contained in:
Meg McRoberts 2014-04-22 23:29:05 -07:00 committed by Dmitry Borodaenko
parent 18850814d1
commit b528ecfa9a
19 changed files with 298 additions and 102 deletions

View File

@ -16,7 +16,8 @@ Documentation
install-guide
user-guide
operations
virtualbox
reference-architecture
release-notes
terminology
release-notes
eula

View File

@ -0,0 +1,10 @@
.. 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

@ -12,31 +12,37 @@ This page contains the most recent Mirantis OpenStack documentation.
Select a document from the left menu and navigate through the topics.
PDFs
---------
----
The following Mirantis OpenStack documentation is available in PDF:
* `Pre-Installation Guide <pdf/Mirantis-OpenStack-5.0-Pre-InstallationGuide.pdf>`_
Prerequisites and pre-installation steps that you must execute before
installing Fuel.
installing Fuel and deploying Mirantis OpenStack.
* `Installation Guide <pdf/Mirantis-OpenStack-5.0-InstallGuide.pdf>`_
This document describes how to pre-configure your
OpenStack environment and install the Fuel Master Node.
* `User Guide <pdf/Mirantis-OpenStack-5.0-UserGuide.pdf>`_
This document describes how to deploy compute nodes for Fuel.
This document describes how to deploy Mirantis OpenStack environments
using Fuel.
* `Operations Guide <pdf/Mirantis-OpenStack-5.0-OperationsGuide.pdf>`_
A collection of useful procedures for using and managing
your Mirantis OpenStack environment.
* `Running Mirantis OpenStack on VirtualBox <pdf/Mirantis-OpenStack-5.0-Running-Mirantis-OpenStack-on-VirtualBox.pdf>`_
This document provides information about running Mirantis OpenStack on VirtualBox
for demonstration and evaluation purposes.
* `Reference Architecture <pdf/Mirantis-OpenStack-5.0-ReferenceArchitecture.pdf>`_
A deep dive into the structure of the Fuel OpenStack environment,
A deep dive into the structure of the Mirantis OpenStack environment,
network considerations, and deployment options.
* `Terminology Reference <pdf/Mirantis-OpenStack-5.0-Terminology-Reference.pdf>`_
@ -45,7 +51,7 @@ The following Mirantis OpenStack documentation is available in PDF:
with references to other documentation and other useful information.
* `Release Notes 5.0 <pdf/Mirantis-OpenStack-5.0-RelNotes.pdf>`_
The Release Notes provide general information about new features,
fixed issues, and known limitations in Mirantis OpenStack |version|.
@ -57,7 +63,7 @@ You can download the Mirantis OpenStack ISO, IMG, and VirtualBox scripts at http
If you do not have an account, sign up for a free account now.
Demos and tutorials:
--------------------------
--------------------
Watch the Mirantis OpenStack demos:
http://www.youtube.com/watch?feature=player_embedded&v=oHE9OC6OibE

View File

@ -7,4 +7,3 @@
.. include:: /pages/install-guide/0070-networks/0220-map-logical-to-physical-nic.rst
.. include:: /pages/install-guide/0070-networks/0300-switch-config.rst
.. include:: /pages/install-guide/0070-networks/0350-router.rst
.. include:: /pages/install-guide/0070-networks/0400-access-to-public-net.rst

View File

@ -1,10 +1,5 @@
.. include:: /pages/install-guide/install/0100-install-master-header.rst
.. include:: /pages/install-guide/install/0200-install-bare-metal.rst
.. include:: /pages/install-guide/install/0300-install-virtualbox.rst
.. include:: /pages/install-guide/install/0330-install-automatic-virtualbox.rst
.. include:: /pages/install-guide/install/0340-install-manual-virtualbox.rst
.. include:: /pages/install-guide/install/0350-manual-master.rst
.. include:: /pages/install-guide/install/0360-manual-slave.rst
.. include:: /pages/install-guide/install/0400-network-install.rst
.. include:: /pages/install-guide/install/0420-change-net-params.rst
.. include:: /pages/install-guide/install/0500-pxe.rst

View File

@ -1,35 +0,0 @@
VirtualBox
----------
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
itself. It is a simple, single-click installation.
.. note::
These scripts are not supported on Windows directly, but you can still test on
Windows VirtualBox by running scripts on Cygwin or by creating the VMs by yourself.
See :ref:`Install_Manual` for more details.
The requirements for running Fuel on VirtualBox are:
A host machine with Linux, Windows or Mac OS. 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, Fedora 19, OpenSUSE 12.2/12.3, and Windows 7 x64 + Cygwin_x64.
VirtualBox 4.2.16 (or later) is required, along with the extension pack.
Both can be downloaded from `<http://www.virtualbox.org/>`_.
8 GB+ of RAM
Will support 4 VMs for Multi-node OpenStack installation (1 Master node,
1 Controller node, 1 Compute node, 1 Cinder node) with reduced to 1536 MB VM RAM.
For dedicated Cinder node 768 MB of RAM is enough.
or
Will support 5 VMs for Multi-node with HA OpenStack installation (1 Master
node, 3 combined Controller + Cinder nodes, 1 Compute node) with reduced
to 1280 MB RAM amount per VM.
Such RAM amount per node is below the recommended requirements for HA
configurations (2048+ MB per controller) and may lead to unwanted issues.

View File

@ -1,24 +0,0 @@
.. _Install_Automatic:
Automatic Mode
++++++++++++++
When you unpack VirtualBox scripts, you will see the following
important files and folders:
`iso`
This folder needs to contain a single ISO image for Fuel. Once you have
downloaded the ISO from the portal, copy or move it into this directory.
`config.sh`
This file allows you to specify parameters used for automating 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`
Once executed, this script will use the ISO image from the ``iso`` directory,
create a VM, mount the image, and automatically install the Fuel Master node.
After installation of the Master node, the script will create Slave nodes for
OpenStack and boot them via PXE from the Master node.
Finally, the script will give you the link to access the Web-based UI for the
Master node so you can start installation of an OpenStack environment.

View File

@ -0,0 +1,51 @@
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.
See the `Quick Start Guide <http://software.mirantis.com/quick-start/>`_
for links and instructions.
This guide provides additional information
about running Fuel and Mirantis OpenStack on VirtualBox.
The requirements for running Fuel on VirtualBox are:
A host machine with Linux, Windows or Mac OS. 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, Fedora 19, OpenSUSE 12.2/12.3, and Windows 7 x64 + Cygwin_x64.
VirtualBox 4.2.16 (or later) is required, along with the extension pack.
Both can be downloaded from `<http://www.virtualbox.org/>`_.
.. note::
To run these scripts on Windows directly,
you must first install Cygwin on your system;
see the `Cygwin installation page <http://www.cygwin.com/install.html>`_.
You can also manually create the VMs to use for Fuel and the Slave nodes.
You need to install **expect** and **openssh**,
which do not install by default.
Use the "-P expect,openssh" option to install these; for example:
setup-x86_64.exe -a x86_64 -P expect,openssh --quiet-mode --site http://box-soft.com/
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.

View File

@ -0,0 +1,33 @@
.. _Install_Automatic:
Installing using automated scripts
==================================
When you unpack VirtualBox scripts,
you will see the following important files and folders:
`iso`
Contains 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.

View File

@ -1,12 +1,12 @@
.. _Install_Manual:
Manual Installation
+++++++++++++++++++
===================
.. note::
The following steps are only suitable for setting up a vanilla OpenStack
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
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,9 +1,9 @@
Master Node Deployment
^^^^^^^^^^^^^^^^^^^^^^
Deploying the Master Node Manually
----------------------------------
First, create the Master node VM.
1. Configure the host-only interface vboxnet0 in VirtualBox by going to
1. Configure the host-only interface vboxnet0 in VirtualBox by going to
`File -> Preferences -> Network` and clicking the screwdriver icon.
* IP address: 10.20.0.1
@ -21,8 +21,8 @@ First, create the Master node VM.
* Network: Attach `Adapter 1` to `Host-only adapter` ``vboxnet0``
4. Power on the VM in order to start the installation. Choose your Fuel ISO
4. Power on the VM in order to start the installation. Choose your Fuel ISO
when prompted to select start-up disk.
5. Wait for the Welcome message with all information needed to login into the UI
5. Wait for the Welcome message with all information needed to login into the UI
of Fuel.

View File

@ -1,9 +1,10 @@
Adding Slave Nodes
^^^^^^^^^^^^^^^^^^
Adding Slave Nodes Manually
---------------------------
Next, create Slave nodes where OpenStack needs to be installed.
1. Create 3 or 4 additional VMs depending on your wish with the following parameters:
1. Create 3 or 4 additional VMs
with the following parameters:
* OS Type: Linux, Version: Ubuntu (64bit)
* RAM: 1536+ MB (2048+ MB recommended)
@ -14,15 +15,18 @@ Next, create Slave nodes where OpenStack needs to be installed.
.. image:: /_images/vbox-image1.jpg
:align: center
:width: 75%
3. Configure two or more network adapters on each VM (in order to use single network
adapter for each VM you should choose "Use VLAN Tagging" later in the Fuel UI):
.. image:: /_images/vbox-image2.jpg
:align: center
:width: 75%
4. Open "advanced" collapse, and check following options:
* Promiscuous mode is a "Allow All"
* Adapter type is a "PCnet-FAST III"
* Cable connected is a On
* Set Promiscuous mode to "Allow All"
* Set Adapter type to "PCnet-FAST III"
* Set Cable connected to On

View File

@ -1,17 +1,17 @@
.. _access_to_public_net:
Deployment configuration to access OpenStack API and VMs from host machine
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
==========================================================================
Helper scripts for VirtualBox create network adapters `eth0`, `eth1`, `eth2`
which are represented on host machine as `vboxnet0`, `vboxnet1`, `vboxnet2`
correspondingly, and assign IP addresses for adapters:
correspondingly, and assign IP addresses for adapters:
vboxnet0 - 10.20.0.1/24,
vboxnet1 - 172.16.1.1/24,
vboxnet0 - 10.20.0.1/24,
vboxnet1 - 172.16.1.1/24,
vboxnet2 - 172.16.0.1/24.
For the demo environment on VirtualBox, the first network adapter is used to run Fuel
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 Public network from the host machine,
@ -45,7 +45,7 @@ For Ubuntu, the following command, executed on the host, can make 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 it is needed to provide IP addresses from
To access VMs managed by OpenStack it is needed to provide IP addresses from
Floating IP range. When OpenStack environment is deployed and VM is provisioned there,
you have to associate one of the Floating IP addresses from the pool to this VM,
whether in Horizon or via Nova CLI. By default, OpenStack blocks all the traffic to the VM.
@ -56,6 +56,6 @@ It can be done in Horizon, or from OpenStack Controller using the following comm
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 ``config.sh``
IP ranges for Public and Management networks (172.16.*.*) are defined in ``config.sh``
script. If default values don't fit your needs, you are free to change them, but before
the installation of Fuel Master node.

View File

@ -0,0 +1,19 @@
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

@ -0,0 +1,80 @@
.. _access_to_public_net:
Deployment configuration to access OpenStack API and VMs from host machine
==========================================================================
Helper scripts for VirtualBox create 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.1.1/24
vboxnet2 - 172.16.0.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 network from the host machine,
you must have a route from your host
to the Public IP address on the OpenStack Controller.
Also, if access to Floating IP of VM is required,
you must also have a route to the Floating IP on Compute host,
which is bind'ed to the Public interface there.
To make this configuration possible on VirtualBox demo environment,
the user 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: 100%
By default, Public and Floating networks
run on the first network interface.
This must be changed, as you can see on this image below.
Make sure you change it on every node.
.. image:: /_images/vbox_node_settings.jpg
:align: center
:width: 100%
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 on provisioned VMs 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 security groups.
This can be done in Horizon,
or from the OpenStack Controller using the following commands::
. /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

@ -0,0 +1,17 @@
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:
"VBoxManage startvm ... --type headless"

View File

@ -17,12 +17,12 @@ execfile('../common_conf.py')
exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide', '*.rst']
pdf_documents = [
('pdf/pdf_user', u'Mirantis-OpenStack-5.0-UserGuide', u'User Guide',
u'2014, Mirantis Inc.'),
('pdf/pdf_install', u'Mirantis-OpenStack-5.0-InstallGuide', u'Installation Guide', u'2014, Mirantis Inc.'),
('pdf/pdf_operations', u'Mirantis-OpenStack-5.0-OperationsGuide', u'Operations Guide', u'2014, Mirantis Inc.'),
('pdf/pdf_reference', u'Mirantis-OpenStack-5.0-ReferenceArchitecture', u'Reference Architecture', u'2014, Mirantis Inc.'),
('pdf/pdf_preinstall', u'Mirantis-OpenStack-5.0-Pre-InstallationGuide', u'Pre-Installation Guide', u'2014, Mirantis Inc.'),
('pdf/pdf_install', u'Mirantis-OpenStack-5.0-InstallGuide', u'Installation Guide', u'2014, Mirantis Inc.'),
('pdf/pdf_user', u'Mirantis-OpenStack-5.0-UserGuide', u'User Guide', u'2014, Mirantis Inc.'),
('pdf/pdf_operations', u'Mirantis-OpenStack-5.0-OperationsGuide', u'Operations Guide', u'2014, Mirantis Inc.'),
('pdf/pdf_virtualbox', u'Mirantis-OpenStack-5.0-Running-Mirantis-OpenStack-on-VirtualBox', u'Running Mirantis OpenStack on VirtualBox', u'2014, Mirantis Inc.'),
('pdf/pdf_reference', u'Mirantis-OpenStack-5.0-ReferenceArchitecture', u'Reference Architecture', u'2014, Mirantis Inc.'),
('pdf/pdf_terminology', u'Mirantis-OpenStack-5.0-Terminology-Reference', u'Terminology Reference', u'2014, Mirantis Inc.'),
# (master_doc, project, project, copyright),
]

28
pdf/pdf_virtualbox.rst Normal file
View File

@ -0,0 +1,28 @@
.. header::
.. cssclass:: header-table
+------------------------------------------+-----------------------------------+
| Mirantis OpenStack v5.0 | .. cssclass:: right|
| | |
| Running Mirantis OpenStack on VirtualBox | ###Section### |
+------------------------------------------+-----------------------------------+
.. footer::
.. cssclass:: footer-table
+--------------------------+----------------------+
| | .. cssclass:: right|
| | |
| ©2014, Mirantis Inc. | Page ###Page### |
+--------------------------+----------------------+
.. raw:: pdf
PageBreak oneColumn
.. toctree::
:maxdepth: 2
.. include:: ../contents/contents-virtualbox.rst

12
virtualbox.rst Normal file
View File

@ -0,0 +1,12 @@
.. index:: VirtualBox Installation
.. _virtualbox:
==========================
Running Fuel on VirtualBox
==========================
.. contents:: :local:
:depth: 2
.. include:: /contents/contents-virtualbox.rst