]> git.evergreen-ils.org Git - working/Evergreen.git/blob - 1.6/admin/ServersideInstallationVirtual.xml
expand section 'Installing in Virtualized Linux Environments';
[working/Evergreen.git] / 1.6 / admin / ServersideInstallationVirtual.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
3         <title>Installing In Virtualized Linux Environments</title>
4         <section xml:id="serversideinstallation-virtual">
5                 <title>Overview</title>
6                 <para>This section describes the installation of Evergreen software in so-called "virtualized" software environments. Evergreen software currently runs as a native application on any of several well-known x86 (32-bit) and x86-64 (64-bit) <systemitem class="osname">Linux</systemitem> distributions including <systemitem class="osname">Ubuntu</systemitem> and <systemitem class="osname">Debian</systemitem>, but it does not run as a native application on the <systemitem class="osname">Microsoft Windows</systemitem> operating system. However, it is possible to execute Evergreen on a <systemitem class="osname">Windows</systemitem> host system by running it within a virtual Linux-guest installation, which itself executes on the <systemitem class="osname">Windows</systemitem> system. The Linux environment is fully emulated and acts (with some limits) just as if it were executing on a real standalone system.</para>
7                 <para>This technique of emulating a Linux environment on a <systemitem class="osname">Windows</systemitem> host is a practical way to install and run an Evergreen system if it is not possible to dedicate a physical machine solely as a Linux host for Evergreen.
8 There are some performance limitations to running Evergreen in a virtualized environment, so this architecture is not recommended for large scale systems. However, this is a reasonable architecture for simple experiments, as a proof of concept, or as a conference-room pilot.</para>
9                 <section>
10                         <title>Installing Virtualization Software</title>
11                         <para>The Linux environment is controlled by one of several popular virtualization software applications such as <application>"VirtualBox"</application>, <application>"VMware"</application> or <application>"VirtualPC"</application> which must first be installed on the <systemitem class="osname">Windows</systemitem> system. This section contains step-by-step examples of installing each of the popular virtualization applications on a <systemitem class="osname">Windows</systemitem> host system. Following this section are further descriptions of installing Linux systems on the virtualization software, then of installing and running Evergreen within those Linux systems.</para>
12                         <section>
13                                 <title>Installing <application>"VirtualBox"</application> Virtualization Software</title>
14                                 <para>This section reviews the procedure for installing the <application>"VirtualBox"</application> application on <systemitem class="osname">WindowsXP Professional (SP2)</systemitem>.</para>
15                                 <procedure>
16                                         <step>
17                                                 <para>Download <application>VirtualBox</application> from here: <ulink url="http://download.virtualbox.org/virtualbox/3.2.8/VirtualBox-3.2.8-64453-Win.exe">http://download.virtualbox.org/virtualbox/3.2.8/VirtualBox-3.2.8-64453-Win.exe</ulink>, then run the executable file. Continue with the steps shown in the first five figures until the software has been successfully installed:</para>
18                                                 <figure>
19                                                         <title>Starting the Windows installation file</title>
20                                                         <mediaobject>
21                                                                 <imageobject>
22                                                                         <imagedata fileref="../media/serversideinstallation-virtual-1.png" scalefit="1" width="70%"/>
23                                                                 </imageobject>
24                                                         </mediaobject>
25                                                 </figure>
26                                                 <figure>
27                                                         <title>Welcome to <application>VirtualBox</application> setup wizard</title>
28                                                         <mediaobject>
29                                                                 <imageobject>
30                                                                         <imagedata fileref="../media/serversideinstallation-virtual-2.png" scalefit="1" width="70%"/>
31                                                                 </imageobject>
32                                                         </mediaobject>
33                                                 </figure>
34                                                 <figure>
35                                                         <title>Accept the license agreement</title>
36                                                         <mediaobject>
37                                                                 <imageobject>
38                                                                         <imagedata fileref="../media/serversideinstallation-virtual-3.png" scalefit="1" width="70%"/>
39                                                                 </imageobject>
40                                                         </mediaobject>
41                                                 </figure>
42                                                 <figure>
43                                                         <title>Waiting for files to be copied</title>
44                                                         <mediaobject>
45                                                                 <imageobject>
46                                                                         <imagedata fileref="../media/serversideinstallation-virtual-6.png" scalefit="1" width="70%"/>
47                                                                 </imageobject>
48                                                         </mediaobject>
49                                                 </figure>
50                                                 <figure>
51                                                         <title>Installation is complete</title>
52                                                         <mediaobject>
53                                                                 <imageobject>
54                                                                         <imagedata fileref="../media/serversideinstallation-virtual-7.png" scalefit="1" width="70%"/>
55                                                                 </imageobject>
56                                                         </mediaobject>
57                                                 </figure>
58                                         </step>
59                                         <step>
60                                                 <para>After successfully installating <application>VirtualBox</application>, start it for the first time and click <guibutton>"New"</guibutton> to begin defining a new virtual machine (VM). You must specify a name and operating system type for the new VM; in this example we decided to install <systemitem class="osname">Debian Lenny</systemitem>. You must set a reasonable memory size (we chose the default value of 384Mb). You must define a name and size for a virtual hard disk (we chose a name, and set the size to 4.0Gb). The next six figures illlustrate the steps in starting <application>VirtualBox</application> and defining the new VM:</para>
61                                                 <figure>
62                                                         <title>Starting <application>VirtualBox</application> for the first time</title>
63                                                         <mediaobject>
64                                                                 <imageobject>
65                                                                         <imagedata fileref="../media/serversideinstallation-virtual-8.png" scalefit="1" width="60%"/>
66                                                                 </imageobject>
67                                                         </mediaobject>
68                                                 </figure>
69                                                 <figure>
70                                                         <title>Setting VM name and OS type</title>
71                                                         <mediaobject>
72                                                                 <imageobject>
73                                                                         <imagedata fileref="../media/serversideinstallation-virtual-10.png" scalefit="1" width="70%"/>
74                                                                 </imageobject>
75                                                         </mediaobject>
76                                                 </figure>
77                                                 <figure>
78                                                         <title>Setting memory size</title>
79                                                         <mediaobject>
80                                                                 <imageobject>
81                                                                         <imagedata fileref="../media/serversideinstallation-virtual-11.png" scalefit="1" width="70%"/>
82                                                                 </imageobject>
83                                                         </mediaobject>
84                                                 </figure>
85                                                 <figure>
86                                                         <title>Setting disk type</title>
87                                                         <mediaobject>
88                                                                 <imageobject>
89                                                                         <imagedata fileref="../media/serversideinstallation-virtual-12.png" scalefit="1" width="70%"/>
90                                                                 </imageobject>
91                                                         </mediaobject>
92                                                 </figure>
93                                                 <figure>
94                                                         <title>Setting disk size</title>
95                                                         <mediaobject>
96                                                                 <imageobject>
97                                                                         <imagedata fileref="../media/serversideinstallation-virtual-15.png" scalefit="1" width="70%"/>
98                                                                 </imageobject>
99                                                         </mediaobject>
100                                                 </figure>
101                                                 <figure>
102                                                         <title>Finished defining the VM</title>
103                                                         <mediaobject>
104                                                                 <imageobject>
105                                                                         <imagedata fileref="../media/serversideinstallation-virtual-18.png" scalefit="1" width="70%"/>
106                                                                 </imageobject>
107                                                         </mediaobject>
108                                                 </figure>
109                                         </step>
110                                 </procedure>
111                                 <para>At this point, <application>VirtualBox</application> has been installed, started for the first time, and a new virtual machine (VM) has been created. This VM is the environment in which the Linux / Evergreen installation will execute. Please continue in <xref linkend="serversideinstallation-virtual-install-linux-ev"/> with the installation of the Linux / Evergreen distribution.</para>
112                         </section>
113                         <section>
114                                 <title>Installing <application>"VMware"</application> Virtualization Software</title>
115                                 <para>This section reviews the procedure for installing the <application>"VMware"</application> application on <systemitem class="osname">WindowsXP Professional (SP2)</systemitem>.</para>
116                                 <procedure>
117                                         <step>
118                                                 <para>Download <application>VMware</application> from here: <ulink url="">link</ulink>, then run the executable file. Continue with the steps shown in the first ??? figures until the software has been successfully installed:</para>
119                                                 <figure>
120                                                         <title>Starting the Windows installation file</title>
121                                                         <mediaobject>
122                                                                 <imageobject>
123                                                                         <imagedata fileref="../media/serversideinstallation-virtual-1.png" scalefit="1" width="70%"/>
124                                                                 </imageobject>
125                                                         </mediaobject>
126                                                 </figure>
127                                         </step>
128                                         <step>
129                                                 <para>After successfully installating <application>VMware</application>, start it for the first time and click <guibutton>"New"</guibutton> to begin defining a new virtual machine (VM). You must specify a name and operating system type for the new VM; in this example we decided to install <systemitem class="osname">Debian Lenny</systemitem>. You must set a reasonable memory size (we chose the default value of 384Mb). You must define a name and size for a virtual hard disk (we chose a name, and set the size to 4.0Gb). The next six figures illlustrate the steps in starting <application>VirtualBox</application> and defining the new VM:</para>
130                                         </step>
131                                 </procedure>
132                                 <para>At this point, <application>VirtualBox</application> has been installed, started for the first time, and a new virtual machine (VM) has been created. This VM is the environment in which the Linux / Evergreen installation will execute. Please continue in <xref linkend="serversideinstallation-virtual-install-linux-ev"/> with the installation of the Linux / Evergreen distribution.</para>
133                                 <indexterm>
134                                         <primary>ZZZ-REVIEW</primary>
135                                         <secondary>ADD INFO ON VMWARE</secondary>
136                                 </indexterm>
137                                 <caution>ADD INFO ON VMWARE</caution>
138                         </section>
139                         <section>
140                                 <title>Installing <application>"VirtualPC"</application> Virtualization Software</title>
141                                 <para>This section reviews the procedure for installing the <application>"VirtualPC"</application> application on <systemitem class="osname">WindowsXP Professional (SP2)</systemitem>.</para>
142                                 <procedure>
143                                         <step>
144                                                 <para>Download <application>VMware</application> from here: <ulink url="">link</ulink>, then run the executable file. Continue with the steps shown in the first ??? figures until the software has been successfully installed:</para>
145                                                 <figure>
146                                                         <title>Starting the Windows installation file</title>
147                                                         <mediaobject>
148                                                                 <imageobject>
149                                                                         <imagedata fileref="../media/serversideinstallation-virtual-1.png" scalefit="1" width="70%"/>
150                                                                 </imageobject>
151                                                         </mediaobject>
152                                                 </figure>
153                                         </step>
154                                         <step>
155                                                 <para>After successfully installating <application>VMware</application>, start it for the first time and click <guibutton>"New"</guibutton> to begin defining a new virtual machine (VM). You must specify a name and operating system type for the new VM; in this example we decided to install <systemitem class="osname">Debian Lenny</systemitem>. You must set a reasonable memory size (we chose the default value of 384Mb). You must define a name and size for a virtual hard disk (we chose a name, and set the size to 4.0Gb). The next six figures illlustrate the steps in starting <application>VirtualBox</application> and defining the new VM:</para>
156                                         </step>
157                                 </procedure>
158                                 <para>At this point, <application>VirtualBox</application> has been installed, started for the first time, and a new virtual machine (VM) has been created. This VM is the environment in which the Linux / Evergreen installation will execute. Please continue in <xref linkend="serversideinstallation-virtual-install-linux-ev"/> with the installation of the Linux / Evergreen distribution.</para>
159                                 <indexterm>
160                                         <primary>ZZZ-REVIEW</primary>
161                                         <secondary>ADD INFO ON VIRTUALPC</secondary>
162                                 </indexterm>
163                                 <caution>ADD INFO ON VIRTUALPC</caution>
164                         </section>
165                 </section>
166                 <section xml:id="serversideinstallation-virtual-install-linux-ev">
167                         <title>Installing Linux / Evergreen on Virtualization Software</title>
168                         <para>After the virtualization software is installed and running and a new virtual machine (VM) has been created, there are two ways to continue with installing software in this virtualized environment:</para>
169                         <orderedlist>
170                                 <listitem>
171                                         <para>Download a prebuilt software image file containing a working Linux / Evergreen system.</para>
172                                 </listitem>
173                                 <listitem>
174                                         <para>Manually install a Linux guest system, then manually install Evergreen on it.</para>
175                                 </listitem>
176                         </orderedlist>
177                         <para>See the following two sections for a review of each method.</para>
178                         <section>
179                                 <title>Download a prebuilt software image file</title>
180                                 <para>Download a prebuilt software image that, when installed in <application>"VirtualBox"</application>, <application>"VMware"</application> or <application>"VirtualPC"</application>, will emulate a Linux guest system containing a running Evergreen distribution. The image is essentially a snapshot of a hard disk from a fully configured, functional Linux system with Evergreen already installed.</para>
181                                 <para>We recommend this approach if you wish to get Evergreen running quickly with minimal attention to configuration. After reviewing only a few configuration details you can have a working Evergreen system that integrates smoothly with the rest of your network. See <xref linkend="serversideinstall-virtual-versions"/> for a list of prebuilt software images that are currently available to download and execute:</para>
182                                 <table xml:id="serversideinstall-virtual-versions">
183                                         <title>Linux / Evergreen Virtual Images</title>
184                                         <tgroup align="left" cols="4" colsep="1" rowsep="1">
185                                                 <thead>
186                                                         <row>
187                                                                 <entry>Linux Version</entry>
188                                                                 <entry>Evergreen Version</entry>
189                                                                 <entry>OpenSRF Version</entry>
190                                                                 <entry>VirtualBox Image</entry>
191                                                         </row>
192                                                 </thead>
193                                                 <tbody>
194                                                         <row>
195                                                                 <entry>Debin lenny (5.0)</entry>
196                                                                 <entry>1.6.0.1</entry>
197                                                                 <entry>1.4.x</entry>
198                                                                 <entry>
199                                                                         <ulink url="http://www.open-ils.org/~denials/Evergreen1601_DebianLenny.zip"> download </ulink>
200                                                                 </entry>
201                                                         </row>
202                                                 </tbody>
203                                         </tgroup>
204                                 </table>
205                                 <para>In the remainder of this section, we assume that the application <application>"VirtualBox"</application> has already been installed and started.</para>
206                                 <procedure>
207                                         <step>Download the prebuilt Linux/Evergreen system</step>
208                                         <step>Start the system</step>
209                                         <step>Configure the system</step>
210                                 </procedure>
211                         </section>
212                         <section>
213                                 <title>Manually install Linux and Evergreen</title>
214                                 <para>Manually install a Linux guest system, then manually install Evergreen.</para>
215                                 <para>We recommend this approach if you need to configure the Linux system in any special way, or if you require Evergreen to target some specific chores. This will require a detailed review of both Linux and Evergreen configuration details. You are essentially doing a normal Evergreen installation on a Linux system; it just happens that Linux is running within a virtualized environment. Refer to <xref linkend="serversideinstallation-ubuntudebian"/> for information on the normal Evergreen installation, then continue with this section.</para>
216                                 <para>In this example, we assume that the application <application>"VirtualBox"</application> has already been installed and started:</para>
217                                 <procedure>
218                                         <step>A standard <systemitem class="osname">Ubuntu</systemitem> distribution, the so-called "Guest" operating system, is installed in the running <application>"VirtualBox"</application> environment.</step>
219                                         <step>The <systemitem class="osname">Ubuntu</systemitem> distribution is started ("booted") just as if it existed on a real, physical system.</step>
220                                         <step>Evergreen is installed on the running <systemitem class="osname">Ubuntu</systemitem> distribution, just as if installing on a standalone system.</step>
221                                 </procedure>
222                                 <para>At this point, the <systemitem class="osname">Windows</systemitem> system is hosting an <systemitem class="osname">Ubuntu</systemitem> system, which itself is hosting the Evergreen distribution. So far as Evergreen is concerned, it is happily executing in a standard <systemitem class="osname">Ubuntu</systemitem> environment and behaves exactly as if it were executing on a standalone <systemitem class="osname">Ubuntu</systemitem> system.</para>
223                                 <para>Of course, there are limitations to how well a virtualized <systemitem class="osname">Ubuntu</systemitem> system emulates a real one. The <application>"VirtualBox"</application> application itself consumes memory, and it contributes to the CPU load on the <systemitem class="osname">Windows</systemitem> host system. The emulated <systemitem class="osname">Ubuntu</systemitem> system will have less available memory and will execute more slowly than if it were a standalone system, therefore Evergreen itself will inherit some limitations from this overall environment.</para>
224                                 <para>However, this technique of using a <systemitem class="osname">Windows</systemitem> host to emulate a Linux environment is a practical way to install and run an Evergreen system even if it isn't possible to dedicate a real machine solely as a Linux host for testing. This is a reasonable architecture for simple experiments, or as a proof of concept, or as a conference-room pilot.</para>
225                         </section>
226                 </section>
227         </section>
228         <index/>
229 </chapter>