manuals/install-guide/section_install_virtualbox.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE section [
   3  <!-- Some useful entities borrowed from HTML -->
   4 <!ENTITY ndash  "&#x2013;">
   5 <!ENTITY mdash  "&#x2014;">
   6 <!ENTITY hellip "&#x2026;">
   7 ]>
   8 <section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
   9     xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="install_from_vbox">
  10     <title>Installing using the VirtualBox Image</title>
  11     <para>You can find the OpenDaylight Hydrogen Release VirtualBox Image on the download page <link
  12             xlink:href="http://www.opendaylight.org/software/downloads/hydrogen-base-10"
  13         >here</link></para>
  14     <section xml:id="install_from_vbox_virtualbox_vm_desc">
  15         <title>VM description</title>
  16         <para>
  17             <itemizedlist>
  18                 <listitem>
  19                     <para>Installed SW: <itemizedlist>
  20                             <listitem>
  21                                 <para><link xlink:href="http://openjdk.java.net/">Java 1.7
  22                                         OpenJDK</link></para>
  23                             </listitem>
  24                             <listitem>
  25                                 <para><link xlink:href="http://www.opendaylight.org/software"
  26                                         >OpenDaylight release distributions</link></para>
  27                             </listitem>
  28                             <listitem>
  29                                 <para><link xlink:href="http://mininet.org/">mininet
  30                                     2.1.0</link></para>
  31                             </listitem>
  32                             <listitem>
  33                                 <para><link xlink:href="http://openvswitch.org/">Open vSwitch
  34                                         2.0.0</link></para>
  35                             </listitem>
  36                             <listitem><para><link xlink:href="https://github.com/CPqD/ofsoftswitch13">CPqD
  37                                 ofsoftswitch13</link></para></listitem>
  38                             <listitem><para><link xlink:href="https://code.google.com/p/robotframework/"
  39                                     >Robot framework 2.8.3</link></para></listitem>
  40                             <listitem><para><link
  41                                     xlink:href="https://git.opendaylight.org/gerrit/gitweb?p=integration.git;a=tree"
  42                                     >integration test scripts</link></para></listitem>
  43                             <listitem><para><link
  44                                     xlink:href="https://wiki.opendaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):VTN_Coordinator"
  45                                     >VTN coordinator</link></para></listitem>
  46                             <listitem>
  47                                <para><link xlink:href="http://www.wireshark.org/">Wireshark</link></para>
  48                             </listitem>
  49                         </itemizedlist></para>
  50                 </listitem>
  51                 <listitem>
  52                     <para>VM configuration:<itemizedlist>
  53                             <listitem>
  54                                 <para>odl_server: Ubuntu 13.04 server, 8GB HDD, ova file
  55                                     size=2GB</para>
  56                             </listitem>
  57                             <listitem>
  58                                 <para>odl_desktop: Ubuntu 13.04 desktop (GUI), 20GB HDD, ova file
  59                                     size=3GB</para>
  60                             </listitem>
  61                         </itemizedlist></para>
  62                 </listitem>
  63             </itemizedlist>
  64         </para>
  65     </section>
  66     <section xml:id="install_from_vbox_vbox_install_procedure">
  67         <title>Installation Procedure</title>
  68         <para>If you have directly downloaded the RPM artifacts you can install OpenDaylight </para>
  69         <section xml:id="install_from_vbox_vbox_install_proc_prereq">
  70             <title>Prerequisites</title>
  71             <itemizedlist>
  72                 <listitem>
  73                     <para>
  74                         <itemizedlist>
  75                             <listitem>
  76                                 <para><link xlink:href="https://www.virtualbox.org/"
  77                                         >Virtualbox</link> (if you use <link
  78                                         xlink:href="http://wiki.qemu.org/Main_Page">QEMU</link> or
  79                                     VMware you can find instructions online on how to convert ova
  80                                     file to these)</para>
  81                             </listitem>
  82                         </itemizedlist>
  83                     </para>
  84                 </listitem>
  85             </itemizedlist>
  86         </section>
  87         <section xml:id="install_from_vbox_vbox_install_steps">
  88             <title>Installation Steps</title>
  89             <para>
  90                 <orderedlist>
  91                     <listitem>
  92                         <para>Download the VM ova file from link above</para>
  93                     </listitem>
  94                     <listitem>
  95                         <para>Open VirtualBox and do import appliance</para>
  96                     </listitem>
  97                     <listitem>
  98                         <para>Configure the VM with the following recommended settings</para>
  99                         <para>
 100                             <itemizedlist>
 101                                 <listitem>
 102                                     <para><emphasis role="italic">Processor</emphasis>: 4x CPU if
 103                                         you plan to run the controller in the VM, just 1 if you
 104                                         don't</para>
 105                                 </listitem>
 106                                 <listitem>
 107                                     <para><emphasis role="italic">RAM</emphasis>: 4GB if you plan to
 108                                         run the controller in the VM, or just 1GB if you
 109                                         don't</para>
 110                                 </listitem>
 111                                 <listitem>
 112                                     <para><emphasis role="italic">Network</emphasis>: 1x NIC, bridge
 113                                         mode is recommended, otherwise NAT (to share your Internet
 114                                         connection) or host-only (creates internal network)</para>
 115                                 </listitem>
 116                             </itemizedlist>
 117                         </para>
 118                     </listitem>
 119                     <listitem>
 120                         <para>Start the VM</para>
 121                     </listitem>
 122                     <listitem>
 123                         <para>Login</para>
 124                         <para>
 125                             <itemizedlist>
 126                                 <listitem>
 127                                     <para>for Ubuntu VM, Login with mininet/mininet</para>
 128                                 </listitem>
 129                                 <listitem>
 130                                     <para>for Fedora (where available), Login with odl/odl ; The
 131                                         root password is "password"</para>
 132                                 </listitem>
 133                             </itemizedlist>
 134                         </para>
 135                     </listitem>
 136                     <listitem>
 137                         <para>Open README.txt</para>
 138                     </listitem>
 139                 </orderedlist>
 140             </para>
 141         </section>
 142     </section>
 143     <section xml:id="install_from_vbox_using_the_vm">
 144         <title>Using the VM</title>
 145         <para>This VM can be used in two scenarios:</para>
 146         <para>
 147             <itemizedlist>
 148                 <listitem>
 149                     <para>Self contained: Both OpenDaylight and the mininet network emulator will
 150                         run in the this VM</para>
 151                 </listitem>
 152                 <listitem>
 153                     <para>Network Emulator: The mininet network emulator will run in this VM, and
 154                         OpenDaylight can be run on an external machine or another VM</para>
 155                 </listitem>
 156             </itemizedlist>
 157         </para>
 158     </section>
 159 </section>