This document provides information on how to deploy, use and troubleshoot the ready-to-run, *[Sun GlassFish Web Space Server 10 | http://www.sun.com/software/products/webspace/get.jsp]* virtual machine (VM) template. This template can help you become familiar with a server-oriented deployment of Web Space Server, Sun's next generation Web 2.0 application aggregation and presentation platform.
{toc:style=disc|indent=20px}
h1. Content of the VM Template
{section}
{column:width=60%}
In addition to GlassFish Web Space Server, the following products are pre-installed and pre-configured in this image:
|!gf_logo.gif|thumbnail!|*GlassFish Enterprise Server v2.1*|The leading open-source and open community platform for building and deploying next-generation applications and services.
|!mysql_logo.gif|thumbnail!|*MySQL 5 Community Server*|The world's most popular open source database because of its fast performance, high reliability, ease of use, and dramatic cost savings.
|!opensolaris_logo.gif|thumbnail!|*OpenSolaris 2008.11*|Included here in a reduced footprint, Just enough Operating System (JeOS) form, OpenSolaris is a state-of-the-art, cutting-edge operating system that provides a rich, coherent platform for building and running applications. See the [OpenSolaris 2008.11 JeOS Prototype|http://wikis.sun.com/display/jeos/OpenSolaris++2008.11+JeOS+Prototype].
{column}
{column}
{column}
{section}
h1. Downloads
See [Downloads|https://cds.sun.com/is-bin/INTERSHOP.enfinity/WFS/CDS-CDS_SMI-Site/en_US/-/USD/ViewProductDetail-Start?ProductRef=GF_WebSpace-10-VMT-1.0-OTH-G-F@CDS-CDS_SMI]
h1. Supported Virtualization Platforms and Known Start Up Issues
||Platform||Format||Loading the Image||Known Start Up Issues||
|VirtualBox |OVF|Select "File -> Import Appliance..."| The image is configured to run in 32 bit execution mode by default. Users may re-configure it to 64 bits, if needed. VirtualBox 2.2.4 or later is a requirement for running in 64 bits. We encourage reading release notes accompanying the selected version to understand potential limitations.
|VirtualBox |VDI|Select "Machine -> New..."\\"Name" = "Web Space Server VM Template"\\"Operating System" = "Solaris"\\"Version" = "OpenSolaris"\\"Memory" = 1024 MB\\Select "Use existing hard disk", click folder icon, select "Add" and select the .vdi file from your download.\\ \\Once the machine has been created, click on "Network" and change the "Attached to" to "Bridged Adapter" if you want the machine to obtain an IP address on your host network. Select "Intel PRO/1000 MT Server (82545EM)" as your network adapter. | The suggested default configuration for the VM is "Operating System" = "Solaris", "Version" = "OpenSolaris" (32 bit execution) given that it is known to work on a wide range of VirtualBox versions (version 1.6.8 and later). Users may configure it to 64 bits too, if needed. VirtualBox 2.2.4 or later is a requirement for running in 64 bits. We encourage reading release notes accompanying the selected version to understand potential limitations.
|VMware Player, Workstation, Server, Fusion | VMDK| Open the VMX filed through "File -> Open..."|...
|VMware ESX |VMDK| Unpack your image into a VMWare ESX datastore and uncompress the VMDK. \\ Browse the datastore where you have unpacked the image from VMWare ESX and double-click on the VMX file to import it \\ Before booting the image, you need to have a configured DHCP server running |...
Also see [Other Known Issues|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template#WebSpaceServer10VMTemplate-OtherKnownIssues] that don't affect initial start up and basic operation of the VM template.
h1. Initial Network Configuration
*Bridged Networking and DHCP by Default:* Since the VM template is configured to use bridged networking and DHCP by default, the VM template will attempt to obtain an IP address on your host's network and it will display the IP address on the console during start up.
*Using Static IP Address:* If you'd prefer to use a static IP address, you can set an IP address from the console after start up by following these [instructions|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template+Advanced+Topics#WebSpaceServer10VMTemplateAdvancedTopics-DefiningaStaticIPAddressinOpenSolaris].
*Using NAT:* If you prefer to use NAT in VirtualBox, then follow these [instructions|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template+Advanced+Topics#WebSpaceServer10VMTemplateAdvancedTopics-ConfiguringNATinVirtualBox]. Use of NAT in VMware does not require extra set up steps.
h1. Quick Start
On a modern system with at least 1 GB of RAM available for the VM template, Web Space Server application start up should take approximately 5 minutes. On slower systems with less resources, start up could take 10 minutes or longer.
Once your VM has started, the command line interface displays the IP address to the VM by the DHCP server of your host's network. You can access the VM template's start page via your browser:
{code}
http://<IP Address>
{code}
You can access the Web Space Server application by clicking on the "Try Web Space Server" link. If this link fails to load, the application may still be in the process of starting. You may need to wait several more minutes before the application has completely started.
If the application fails to respond even after 10 minutes, see the [Troubleshooting|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template#WebSpaceServer10VMTemplate-Troubleshooting] section.
If you'd like to log into the VM template via the console, you can use the user name and password:
||Username||Password||
|template|template|
If you'd like to access the template using SSH, see the [Advanced Topics|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template+Advanced+Topics#WebSpaceServer10VMTemplateAdvancedTopics-UsingSSH]
h1. More Advanced Topics
Refer to the [Advanced Topics|Web Space Server 10 VM Template Advanced Topics] for more information on configuring and managing the template.
h1. Other Known Issues
||Issue||Description
|Warnings in log files| OpenSolaris and GlassFish warnings are visible in logs of OpenSolaris and GlassFish. Those warnings are product specific, not VM template specific. They shouldn't impact the functionality nor the performance of the VM template negatively. They are to be worked on in future releases of integrated products.
|WebMin doesn't work with MySQL on 32 bit OS instances|It tries to run as a 64 bit binary. This issue needs to be addressed in future releases of the image. Configuring the VM to run in 64 mode ("Operating System" = "Solaris"\\"Version" = "OpenSolaris64") works around this issue. VirtualBox 2.2.4 or later is a requirement for running in 64 bits. We encourage reading release notes accompanying the selected version to understand potential limitations.
|VMware ESX 3.5 U3 Restart Issue|If the VM template is deployed on VMWare ESX 3.5 U3 or earlier and it is restarted, the system time is set to an invalid value (to 1980). This is because of the following issue: [4788 | http://defect.opensolaris.org/bz/show_bug.cgi?id=4788]. This is impacting GlassFish and Web Space Server functionality too. Specifically, some of Web Space Server samples don't show up after the result or even GlassFish may fail to start at all. This issue is resolved in VMWare 3.5 U4. Resetting the time to the actual time works this issue around on older version of VMWare ESX.
|VM doesn't start on VirtualBox 2.2.0|The VM template doesn't run in a 64 bit mode on VirtualBox 2.2.0 and earlier versions, if nested paging is not enabled on the VM and the physical machine. Make sure, it is enabled, if you would like to run this configuration. If your hardware doesn't support nested paging, switch to 32 bits bode.
|VM system time out of sync with the host OS system time | Time Zone settings may cause the time to be out of sync. Click [here | http://forums.virtualbox.org/viewtopic.php?f=4&t=15034] for details.
|Invalid certificate warning|Invalid certificate warnings show up, when opening the WebMin interface for OpenSolaris or MySQL administration. Get and accept the self-signed certificate for evaluation purposes. For production purposes, it is strongly recommended-generating all your certificates associated with applications deplyed in the VM template.
h1. Troubleshooting
||Symptom||Recommended Action
|"Try Web Space Server" link does not respond| GlassFish domain (service domain2) has to be up and running, before the Web Space Server can start. On a modern system with at least 1 GB of RAM available for the VM template, the GlassFish domain and the Web Space Server application start up should take approximately 5 minutes. On slower systems with less resources, start up could take 10 minutes or longer. To check, if the service domain2 is online, executing the following command through the command line: {code}svcs domain2{code}.
| |Try another version (if possible, the latest version) of your virtualization software.
| |If you run your image in a 32 execution mode, try the 64 bit mode, if you run in 64 bit, try 32 bits. You may need to unpack the VM from the downloaded file again before you start in another execution mode to make sure that you start with a clear image.
h1. Additional Resources
Product documentation of integrated products:
* [Web Space Server 10 | http://docs.sun.com/app/docs/coll/1863.3]
* [GlassFish Enterprise Server v2.1 | http://docs.sun.com/app/docs/prod/gf.entsvr.v21?l=en&a=view]
* [MySQL 5 Community Server |http://docs.sun.com/source/mysql-refman-5.0/]
* [OpenSolaris 2008.11 | http://www.opensolaris.com/use/]
h1. Providing Feedback
Send an e-mail to the [vm-template-feedback AT sun.com | mailto:vm-template-feedback@sun.com] alias.
h1. Acknowledgment
Thanks to Rudolf Kutina and Nemanja Lukic for their technical contribution in creating this document!
{toc:style=disc|indent=20px}
h1. Content of the VM Template
{section}
{column:width=60%}
In addition to GlassFish Web Space Server, the following products are pre-installed and pre-configured in this image:
|!gf_logo.gif|thumbnail!|*GlassFish Enterprise Server v2.1*|The leading open-source and open community platform for building and deploying next-generation applications and services.
|!mysql_logo.gif|thumbnail!|*MySQL 5 Community Server*|The world's most popular open source database because of its fast performance, high reliability, ease of use, and dramatic cost savings.
|!opensolaris_logo.gif|thumbnail!|*OpenSolaris 2008.11*|Included here in a reduced footprint, Just enough Operating System (JeOS) form, OpenSolaris is a state-of-the-art, cutting-edge operating system that provides a rich, coherent platform for building and running applications. See the [OpenSolaris 2008.11 JeOS Prototype|http://wikis.sun.com/display/jeos/OpenSolaris++2008.11+JeOS+Prototype].
{column}
{column}
{column}
{section}
h1. Downloads
See [Downloads|https://cds.sun.com/is-bin/INTERSHOP.enfinity/WFS/CDS-CDS_SMI-Site/en_US/-/USD/ViewProductDetail-Start?ProductRef=GF_WebSpace-10-VMT-1.0-OTH-G-F@CDS-CDS_SMI]
h1. Supported Virtualization Platforms and Known Start Up Issues
||Platform||Format||Loading the Image||Known Start Up Issues||
|VirtualBox |OVF|Select "File -> Import Appliance..."| The image is configured to run in 32 bit execution mode by default. Users may re-configure it to 64 bits, if needed. VirtualBox 2.2.4 or later is a requirement for running in 64 bits. We encourage reading release notes accompanying the selected version to understand potential limitations.
|VirtualBox |VDI|Select "Machine -> New..."\\"Name" = "Web Space Server VM Template"\\"Operating System" = "Solaris"\\"Version" = "OpenSolaris"\\"Memory" = 1024 MB\\Select "Use existing hard disk", click folder icon, select "Add" and select the .vdi file from your download.\\ \\Once the machine has been created, click on "Network" and change the "Attached to" to "Bridged Adapter" if you want the machine to obtain an IP address on your host network. Select "Intel PRO/1000 MT Server (82545EM)" as your network adapter. | The suggested default configuration for the VM is "Operating System" = "Solaris", "Version" = "OpenSolaris" (32 bit execution) given that it is known to work on a wide range of VirtualBox versions (version 1.6.8 and later). Users may configure it to 64 bits too, if needed. VirtualBox 2.2.4 or later is a requirement for running in 64 bits. We encourage reading release notes accompanying the selected version to understand potential limitations.
|VMware Player, Workstation, Server, Fusion | VMDK| Open the VMX filed through "File -> Open..."|...
|VMware ESX |VMDK| Unpack your image into a VMWare ESX datastore and uncompress the VMDK. \\ Browse the datastore where you have unpacked the image from VMWare ESX and double-click on the VMX file to import it \\ Before booting the image, you need to have a configured DHCP server running |...
Also see [Other Known Issues|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template#WebSpaceServer10VMTemplate-OtherKnownIssues] that don't affect initial start up and basic operation of the VM template.
h1. Initial Network Configuration
*Bridged Networking and DHCP by Default:* Since the VM template is configured to use bridged networking and DHCP by default, the VM template will attempt to obtain an IP address on your host's network and it will display the IP address on the console during start up.
*Using Static IP Address:* If you'd prefer to use a static IP address, you can set an IP address from the console after start up by following these [instructions|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template+Advanced+Topics#WebSpaceServer10VMTemplateAdvancedTopics-DefiningaStaticIPAddressinOpenSolaris].
*Using NAT:* If you prefer to use NAT in VirtualBox, then follow these [instructions|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template+Advanced+Topics#WebSpaceServer10VMTemplateAdvancedTopics-ConfiguringNATinVirtualBox]. Use of NAT in VMware does not require extra set up steps.
h1. Quick Start
On a modern system with at least 1 GB of RAM available for the VM template, Web Space Server application start up should take approximately 5 minutes. On slower systems with less resources, start up could take 10 minutes or longer.
Once your VM has started, the command line interface displays the IP address to the VM by the DHCP server of your host's network. You can access the VM template's start page via your browser:
{code}
http://<IP Address>
{code}
You can access the Web Space Server application by clicking on the "Try Web Space Server" link. If this link fails to load, the application may still be in the process of starting. You may need to wait several more minutes before the application has completely started.
If the application fails to respond even after 10 minutes, see the [Troubleshooting|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template#WebSpaceServer10VMTemplate-Troubleshooting] section.
If you'd like to log into the VM template via the console, you can use the user name and password:
||Username||Password||
|template|template|
If you'd like to access the template using SSH, see the [Advanced Topics|http://wikis.sun.com/display/Appliance/Web+Space+Server+10+VM+Template+Advanced+Topics#WebSpaceServer10VMTemplateAdvancedTopics-UsingSSH]
h1. More Advanced Topics
Refer to the [Advanced Topics|Web Space Server 10 VM Template Advanced Topics] for more information on configuring and managing the template.
h1. Other Known Issues
||Issue||Description
|Warnings in log files| OpenSolaris and GlassFish warnings are visible in logs of OpenSolaris and GlassFish. Those warnings are product specific, not VM template specific. They shouldn't impact the functionality nor the performance of the VM template negatively. They are to be worked on in future releases of integrated products.
|WebMin doesn't work with MySQL on 32 bit OS instances|It tries to run as a 64 bit binary. This issue needs to be addressed in future releases of the image. Configuring the VM to run in 64 mode ("Operating System" = "Solaris"\\"Version" = "OpenSolaris64") works around this issue. VirtualBox 2.2.4 or later is a requirement for running in 64 bits. We encourage reading release notes accompanying the selected version to understand potential limitations.
|VMware ESX 3.5 U3 Restart Issue|If the VM template is deployed on VMWare ESX 3.5 U3 or earlier and it is restarted, the system time is set to an invalid value (to 1980). This is because of the following issue: [4788 | http://defect.opensolaris.org/bz/show_bug.cgi?id=4788]. This is impacting GlassFish and Web Space Server functionality too. Specifically, some of Web Space Server samples don't show up after the result or even GlassFish may fail to start at all. This issue is resolved in VMWare 3.5 U4. Resetting the time to the actual time works this issue around on older version of VMWare ESX.
|VM doesn't start on VirtualBox 2.2.0|The VM template doesn't run in a 64 bit mode on VirtualBox 2.2.0 and earlier versions, if nested paging is not enabled on the VM and the physical machine. Make sure, it is enabled, if you would like to run this configuration. If your hardware doesn't support nested paging, switch to 32 bits bode.
|VM system time out of sync with the host OS system time | Time Zone settings may cause the time to be out of sync. Click [here | http://forums.virtualbox.org/viewtopic.php?f=4&t=15034] for details.
|Invalid certificate warning|Invalid certificate warnings show up, when opening the WebMin interface for OpenSolaris or MySQL administration. Get and accept the self-signed certificate for evaluation purposes. For production purposes, it is strongly recommended-generating all your certificates associated with applications deplyed in the VM template.
h1. Troubleshooting
||Symptom||Recommended Action
|"Try Web Space Server" link does not respond| GlassFish domain (service domain2) has to be up and running, before the Web Space Server can start. On a modern system with at least 1 GB of RAM available for the VM template, the GlassFish domain and the Web Space Server application start up should take approximately 5 minutes. On slower systems with less resources, start up could take 10 minutes or longer. To check, if the service domain2 is online, executing the following command through the command line: {code}svcs domain2{code}.
| |Try another version (if possible, the latest version) of your virtualization software.
| |If you run your image in a 32 execution mode, try the 64 bit mode, if you run in 64 bit, try 32 bits. You may need to unpack the VM from the downloaded file again before you start in another execution mode to make sure that you start with a clear image.
h1. Additional Resources
Product documentation of integrated products:
* [Web Space Server 10 | http://docs.sun.com/app/docs/coll/1863.3]
* [GlassFish Enterprise Server v2.1 | http://docs.sun.com/app/docs/prod/gf.entsvr.v21?l=en&a=view]
* [MySQL 5 Community Server |http://docs.sun.com/source/mysql-refman-5.0/]
* [OpenSolaris 2008.11 | http://www.opensolaris.com/use/]
h1. Providing Feedback
Send an e-mail to the [vm-template-feedback AT sun.com | mailto:vm-template-feedback@sun.com] alias.
h1. Acknowledgment
Thanks to Rudolf Kutina and Nemanja Lukic for their technical contribution in creating this document!