Virgo User Guide

Rob Harrop

Paul Kuzan

Sam Brannen

Paul Harris

Christopher Frost

Ben Hale

Glyn Normington

Juliet Shackell

Steve Powell

Violeta Georgieva

Hristo Iliev

Borislav Kapukaranov

3.5.0

Copyright © 2009, 2011 VMware Inc. and others

Contributors:

  • VMware Inc. - initial contribution and subsequent updates

  • Violeta Georgieva, SAP AG - Tomcat context configuration

  • Hristo Iliev, SAP AG - Setting jmx.properties permissions

  • Borislav Kapukaranov, SAP AG - Configuring framework extensions and fragments on system bundle; Added Virgo Nano references and tips


Table of Contents

1. Introduction
A Note for Virgo Kernel Users
A Note for Virgo Jetty Server Users
A Note for Virgo Nano Users
2. Concepts
Modular Runtimes and Applications
OSGi Concepts
Bundles
Life Cycle
Services
Versioning
Spring DM and Blueprint Concepts
Virgo Concepts
The Provisioning Repository
p2 Concepts
3. Using the p2 director
Prerequisites
Installing with the p2 director from Eclipse
4. Installing Virgo Server for Apache Tomcat
Prerequisites
Installing from the ZIP Download
Downloading the ZIP file
Installing
Installing from an update site
The repository location
Using the p2 director
Post-installation steps
Set environment variable variables
Microsoft Windows - Troubleshooting Security Permissions
5. Installing Virgo Kernel
Prerequisites
Installing from the ZIP Download
Downloading the ZIP file
Installing
Installing from an update site
The repository location
Using the p2 director
Post-installation steps
6. Installing Virgo Nano
Prerequisites
Installing from the ZIP Download
Downloading the ZIP file
Installing
Installing from an update site
The repository location
Using the p2 director
Post-installation steps
7. Starting and Stopping VTS
Starting Virgo Server for Apache Tomcat
Linux
Microsoft Windows
Starting in Clean Mode
Linux
Microsoft Windows
Starting in Debug Mode
Linux
Microsoft Windows
Starting with JMX Access Modifications
Linux
Microsoft Windows
Starting with a Custom Configuration Directory
Linux
Windows
Stopping Virgo Server for Apache Tomcat
Linux
Microsoft Windows
Cleaning Virgo Server for Apache Tomcat without Starting it
Linux
Microsoft Windows
Using Equinox Launcher
8. Equinox Console
Enabling the Equinox Console
Using Virgo Shell Commands
Virgo Shell Commands
Virgo Shell Command Reference
bundle Command
config Command
packages Command
par Command
plan Command
service Command
install Command
shutdown Command
clhas command
clexport command
clload command
Using the p2 for extending your Virgo installation
Extending with the p2 director
Extending via the p2 shell commands
9. The Admin Console
Invoking the Admin Console
Changing the Admin User
Typical Admin Console Use Cases
Viewing and Managing the Lifecycle of Deployed Artifacts
Installing a New Artifact
Viewing Properties of Deployed Configuration Artifacts
Viewing the Details of Dump Files
Viewing Overview and Details of the OSGi State
10. The Provisioning Repository
Overview of the Provisioning Repository
Local Repository Structure
Installing Artifacts to a Repository
Downloading Bundles from the SpringSource Enterprise Bundle Repository
Configuring the Repository
11. Serviceability and Diagnostics
Event Logging
(Trace) Logging
Application Output
Service Dumps
12. Working with Applications
Deploying Artifacts
Hot Deploy
Deploying Using the Admin Console
What Happens When You Deploy
Deployment Ordering
Deploying Shared Artifacts
Restrictions
Undeploying Artifacts
Hot Undeploy
Undeploying Using the Admin Console
Undeploying Shared Artifacts
13. Configuration
Configuring the OSGi Framework
Configuring OSGi Framework Properties
Configuring OSGi Framework Bundles
Configuring OSGi Framework Profile
Configuring Framework Extensions and Fragments on the System Bundle
Configuring Serviceability and Diagnostics
The org.eclipse.virgo.medic.properties File
The serviceability.xml File
Configuring the Local Provisioning Repository
Should I Configure a Watched or External Repository?
Search Paths: Additional Information
Using System Properties
Example Repository Configurations
Configuring a Hosted Repository
Configuring the Kernel and User Region
Configuring the Kernel
Configuration Files
Configuring Deployment
Configuring the User Region
Configuring Authentication
Configuring the Embedded Tomcat Servlet Container
Description of the Default Apache Tomcat Configuration
Connector Configuration
Cluster Configuration
Context Configuration
Configuring the Web Integration Layer
Configuring the Embedded Jetty Servlet Container
A. Event log codes
Format of the event log codes
B. Known Issues
Timeout During Startup Due to Firewall Settings
Timeout During Startup Due to Insufficient Resources
OutOfMemoryError: PermGen Space Running on Sun JVM
Alternate serviceability and work Directories
Problem Deleting Installation Directory under Windows
Long Work Directory Paths under Windows
Virgo Jetty Server Restrictions
Shutdown Log Messages in Telnet Shell
C. Further Reading

List of Figures

2.1. Bundle life cycle