diff --git a/_images/Cygwin_setup_select_packages.png b/_images/Cygwin_setup_select_packages.png new file mode 100644 index 000000000..334db4931 Binary files /dev/null and b/_images/Cygwin_setup_select_packages.png differ diff --git a/_images/fuel_master_install.png b/_images/fuel_master_install.png new file mode 100644 index 000000000..dc97def54 Binary files /dev/null and b/_images/fuel_master_install.png differ diff --git a/pages/virtualbox/0300-install-virtualbox.rst b/pages/virtualbox/0300-install-virtualbox.rst index c328e93c2..05af2292e 100644 --- a/pages/virtualbox/0300-install-virtualbox.rst +++ b/pages/virtualbox/0300-install-virtualbox.rst @@ -1,54 +1,64 @@ 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 `_ -for links and instructions. +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 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 ``_. - -.. note:: - - To run these scripts on Windows directly, - you must first install Cygwin on your system; - see the `Cygwin installation page `_. - You can also manually create the VMs to use for Fuel and the Slave nodes. - - You need to install the **expect**, **openssh**, - **ping** and **procps** packages, - which do not install by default. - Use the "-P expect,openssh,ping,procps" option to install these; for example: - - :: - - setup-x86_64.exe -a x86_64 -P expect,openssh,ping,procps --quiet-mode \ - --site http://box-soft.com/ +This guide provides information on how to run Fuel and Mirantis OpenStack +on VirtualBox. -8 GB+ of RAM - Supports 4 VMs for Multi-node OpenStack installation +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, Fedora 19, OpenSUSE 12.2/12.3, + and Windows 7 x64 + Cygwin_x64. + +#. Download and install + `VirtualBox `__ 4.2.16 or later. + +#. Download and install + `VirtualBox extensions `_. + +#. Download and extract + `Mirantis VirtualBox scripts `_ + +#. Download the `Mirantis OpenStack package `_ + in either IMG or ISO format. + +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/Cygwin_setup_select_packages.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 +or - Supports 5 VMs for Multi-node with HA OpenStack installation +* 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 @@ -81,11 +91,16 @@ To avoid the problem, follow these steps: :: [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 + -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. diff --git a/pages/virtualbox/0330-install-automatic-virtualbox.rst b/pages/virtualbox/0330-install-automatic-virtualbox.rst index d9f176d12..5be45de8e 100644 --- a/pages/virtualbox/0330-install-automatic-virtualbox.rst +++ b/pages/virtualbox/0330-install-automatic-virtualbox.rst @@ -1,33 +1,61 @@ .. _Install_Automatic: -Installing using automated scripts +Installing Using Automated Scripts ================================== -When you unpack VirtualBox scripts, -you will see the following important files and folders: +#. Extract Mirantis VirtualBox scripts. The package should include the + following: -`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. + `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. + `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. + `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. diff --git a/pages/virtualbox/0350-manual-master.rst b/pages/virtualbox/0350-manual-master.rst index a8d2a065f..f3167df18 100644 --- a/pages/virtualbox/0350-manual-master.rst +++ b/pages/virtualbox/0350-manual-master.rst @@ -3,31 +3,31 @@ Deploying the Master Node Manually First, create the Master node VM. -1. Configure the host-only interface vboxnet0 in VirtualBox by going to +#. 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. + 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 -* IP address: 10.20.0.1 -* Network mask: 255.255.255.0 -* DHCP Server: disabled +#. Create a VM for the Fuel Master node with the following parameters: -2. 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 -* OS Type: Linux -* Version: Ubuntu (64bit) -* RAM: 1536+ MB (2048+ MB recommended) -* HDD: 50 GB with dynamic disk expansion +#. Modify your VM settings: -3. Modify your VM settings: + * Network: Attach *Adapter 1* to *Host-only adapter* *vboxnet0* -* Network: Attach *Adapter 1* to *Host-only adapter* *vboxnet0* - -4. Power on the VM in order to start the installation. Choose your Fuel ISO +#. 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 +#. Wait for the Welcome message with all information needed to login into the UI of Fuel. diff --git a/pages/virtualbox/0360-manual-slave.rst b/pages/virtualbox/0360-manual-slave.rst index eac2d00d1..043a48540 100644 --- a/pages/virtualbox/0360-manual-slave.rst +++ b/pages/virtualbox/0360-manual-slave.rst @@ -1,51 +1,53 @@ Adding Slave Nodes Manually --------------------------- -Configure the host-only interfaces: +Configure the host-only interfaces. - * In the VirtualBox main window, go to *File -> Preferences -> Network*. - On the *Host-only Networks* tab, click the screwdriver icon. +#. 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.1 - Network mask: 255.255.255.0 - DHCP Server: disabled + * Create network *vboxnet1*: - .. image:: /_images/host-only-networks-vboxnet1.png + - IP address: 172.16.0.1 + - Network mask: 255.255.255.0 + - DHCP Server: disabled - * Сreate network *vboxnet2* - IP address: 172.16.1.1 - Network mask: 255.255.255.0 - DHCP Server: disabled + .. image:: /_images/host-only-networks-vboxnet1.png - .. image:: /_images/host-only-networks-vboxnet2.png + * Сreate network *vboxnet2*: + + - IP address: 172.16.1.1 + - Network mask: 255.255.255.0 + - DHCP Server: disabled + + .. image:: /_images/host-only-networks-vboxnet2.png Next, create Slave nodes where OpenStack needs to be installed. -1. Create 3 or 4 additional VMs - with the following parameters: +#. 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, PCnet-FAST III device + * 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, PCnet-FAST III device -2. Set Network as first in the boot order: +#. Set Network as first in the boot order: -.. image:: /_images/vbox-image1.jpg - :align: center - :width: 75% + .. 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): +#. 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.jpg - :align: center - :width: 75% + .. image:: /_images/vbox-image2.jpg + :align: center + :width: 75% -4. Open "advanced" collapse, and check following options: +#. Open :guilabel:`Advanced` collapse, and set the following options: -* Set Promiscuous mode to "Allow All" -* Set Adapter type to "PCnet-FAST III" -* Set Cable connected to On + * Set :guilabel:`Promiscuous mode` to :guilabel:`Allow All` + * Set :guilabel:`Adapter Type` to :guilabel:`PCnet-FAST III` + * Check :guilabel:`Cable connected` diff --git a/pages/virtualbox/0550-access-to-public-net.rst b/pages/virtualbox/0550-access-to-public-net.rst index da2dbb18a..0a7288465 100644 --- a/pages/virtualbox/0550-access-to-public-net.rst +++ b/pages/virtualbox/0550-access-to-public-net.rst @@ -67,7 +67,8 @@ 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 + 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. diff --git a/pages/virtualbox/0800-notes.rst b/pages/virtualbox/0800-notes.rst index adaa2b17b..c6cfa0c54 100644 --- a/pages/virtualbox/0800-notes.rst +++ b/pages/virtualbox/0800-notes.rst @@ -7,9 +7,9 @@ Additional Notes 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: + The following command adds the "myname" user to the vboxusers group:: - sudo useradd -G vboxusers myname + sudo useradd -G vboxusers myname - If the target server where you run VirtualBox is not running X11,