Skip Headers
Oracle® Virtual Assembly Builder Installation Guide
11g Release 1 (11.1.1)

Part Number E15836-02
Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Feedback page
Contact Us

  View PDF

Oracle® Virtual Assembly Builder

Installation Guide

11g Release 1 (11.1.1)


June 2010

The following sections describe how to do a complete installation of Oracle Virtual Assembly Builder.

1 Security Precautions

Ensure that you read this section before proceeding. It contains important security information and precautions. Failure to read and understand these items may cause security vulnerabilities.

2 Before you Begin

Before using Oracle Virtual Assembly Builder, ensure that your environment meets the following prerequisites.

2.1 Oracle WebLogic Server Domain Requirements

You must ensure that any Oracle WebLogic Server domain being introspected is configured to be editable. This allows edits to be performed successfully during deployment. For more information on configuring your Oracle WebLogic Server, see your product documentation.

2.2 Virtual to Virtual Introspection and Deployment Requirements

The following are requirements for virtual to virtual introspection and deployment.

2.2.1 Introspection

Introspection on a deployed virtual machine (VM) can fail to complete when the temporary directory used for introspection is a mounted NFS share with NFS file locking. To avoid this problem, remount the NFS file system with locking turned off:

mount -o nolock example:/scratch /net/example/scratch

2.2.2 Base Image Template Sizing

You must ensure that the reference system on the virtual machine has enough space for an image of itself. If this is an issue, you can resolve it by using one of the following options:

  • Copy System.img to Oracle Virtual Assembly Builder host and run modifyjeos to increase the disk size to handle the snapshot of the product installation. Then redeploy the image and restart it. This will provide enough space in the /tmp directory.

  • If the previous option is not feasible, mount an NFS disk of suitable size, and place the catalog on it. For remote packaging, use the NFS disk location, rather than /tmp.

2.3 LDAP Provider Requirements

Oracle recommends the use of Oracle Internet Directory as the LDAP provider on the reference system, not file-based LDAP. File-based LDAP cannot work properly in a deployed system due to synchronization issues.

3 Installation Overview

In order to deploy your applications into virtualized environments, you must also have appropriate Reference Systems set up (for Introspection), and an Oracle VM environment ready to deploy your applications.

3.1 Installation Road Map

This document details the steps you must complete in order to install and configure Oracle Virtual Assembly Builder. The entire process is comprised of the following steps:

4 Certification and System Requirements

Ensure your environment meets all requirements before starting the installation.

4.1 Certification

This certification document details supported installation types, platforms, operating systems, databases, and JDKs. See Assembly Builder Certification (at

4.2 System Requirements

Please ensure you meet the following requirements.

4.2.1 Operating System

The following operating systems are supported:

  • Oracle Enterprise Linux 5 (UL3+)

  • Red Hat Enterprise Linux 5 (UL3+)

You can verify your operating system version using the commands listed here.

  • Oracle Enterprise Linux:

    # cat /etc/enterprise-release
  • Red Hat Enterprise Linux:

    # cat /etc/redhat-release

4.2.2 Java Development Kit

Download and install Sun JDK 1.6.0_14 (or later) or Oracle JRockit 6 Update 14 R27.6.5 (or later) to the machine on which Oracle Virtual Assembly Builder will be installed. You can download them from the locations listed here.

4.2.3 Oracle Enterprise Linux JeOS

Download and install Oracle Enterprise Linux JeOS from: If this is your first time using eDelivery, you will be required to register. Register, then continue.

  1. On the Welcome screen, click Continue. The Media Pack Search screen appears.

  2. Select a Product Pack (Enterprise Linux), and Platform (x86 32 bit). Click Go. The Results are displayed.

  3. Select Oracle Enterprise Linux JeOS for Building Oracle VM templates for x86 (32 bit). Click Continue. Available downloads appear.

  4. Download JeOS Base x86 and x86_64, by clicking Download. The file is downloaded.

  5. Unzip

  6. (As root) install the packages using this command:

    rpm -ivh ovm-modify-jeos-1.1.0-2.el5.noarch.rpm ovm-template-config-1.1.0-1.el5.noarch.rpm

4.2.4 System Base Images

Depending on the type of operating system you choose for your appliance at template creation time, you may need the Oracle Enterprise Linux Base Image or Oracle WebLogic Server on Oracle JRockit Virtual Edition Base Image (or both).


You have a choice of downloading an Oracle provided sample Oracle Enterprise Linux Base Image, or creating your own. The sample image is available on Oracle Technology Network:

To create the appropriate Base Image(s):

  • Oracle Enterprise Linux Base Image, see The information on this page (and on referenced pages, especially on: will provide the information you need to create your own System Base Image.

    When specifying a base image, the image must meet the following requirements:

    • Oracle Enterprise Linux 5 base

    • You must have installed the following packages (RPMs):

      • nc

      • libaio

      • zip

      • unzip

      • nfs-utils

      • xen-tool

      • xen-devel

    • You must turn on oraclevm-templates while creating the image.

    • You are recommended to turn off iptables while creating the image.

    • The base image must have the user oracle. One example of meeting this requirement is to boot the base image, log on to it as root, and call /usr/sbin/useradd oracle.


      Refer to modifyjeos documentation to create the base image.
    • Oracle WebLogic Server on Oracle JRockit Virtual Edition Base Image is included in the Oracle WebLogic Server on Oracle JRockit Virtual Edition bundle. Unzip the product's zip file, and find the System.img and vm.cfg files (in the wlsve sub-directory of the structure into which you unzipped the files).


The base image (system.img) must not have an executable bit. Otherwise, export/import may not work properly. You must set the permission of base images properly, for example, to 644:
$ chmod 644 System.img
$ ls -l System.img
-rw-r--r-- 1 jdoe g900 748500480 Apr 22 12:52 System.img 

5 Install Oracle Virtual Assembly Builder

Follow these steps to install and configure Oracle Virtual Assembly Builder.


These installation instructions are limited to installing Oracle Virtual Assembly Builder on Oracle Enterprise Linux 5.4. You can adapt them for your local environment.

5.1 Extract Compressed Files

Follow these steps to copy program files.

  1. Download Oracle Virtual Assembly Builder.

    Oracle Virtual Assembly Builder is available as part of Oracle Fusion Middleware 11g Media Pack. You can also download it from Oracle eDelivery or Oracle Technology Network:

  2. Create a directory (for example: ab_home).

    mkdir ~/ab_home
  3. Copy the Oracle Virtual Assembly Builder zip file that you downloaded into the ~/ab_home directory and unzip it. For example (zip file name will vary):

    cp <zip file name>  ~/ab_home/
          cd ~/ab_home
          unzip <zip file name>

5.2 Execute the Script

After installation of Oracle Virtual Assembly Builder, execute (as user root) located in the $AB_HOME/bin directory.

This step is necessary to successfully create templates, otherwise Oracle Virtual Assembly Builder will give an error during template creation process.

5.3 Copy the System Base Image(s)

Oracle Virtual Assembly Builder requires system base images to create deployable templates for appliances. The default locations of system base images are listed below.

  • Oracle Enterprise Linux Base Image: $AB_HOME/templates/baseImage/OVM/OEL

  • Oracle WebLogic Server on Oracle JRockit Virtual Edition: $AB_HOME/templates/baseImage/OVM/JRVE

Copy the system.img and vm.cfg files of your system base image(s) created in Section 4.2.4, "System Base Images" into the corresponding above-mentioned directories.


This step (copying the system base images) is optional and is only necessary if you choose to keep your system base images in the default locations. If you choose to keep your system base images in alternate locations, make sure to specify the system base image locations at template creation time, otherwise the template creation operation will result in an error.

5.4 Configure

There are mandatory and optional variables to set in order to configure this installation:

  • (Mandatory) JAVA_HOME and AB_HOME:

    1. Set JAVA_HOME to the location where you installed Sun JDK or Oracle JRockit.

    2. Set AB_HOME to the location where you unzipped Oracle Assembly Builder zip file.


    1. Set AB_CONFIG_HOME to the location where your Oracle Virtual Assembly Builder configuration is stored. By default AB_CONFIG_HOME = $AB_HOME.

    2. Set AB_CATALOG_HOME to the location where your Oracle Virtual Assembly Builder catalog will be stored. By default:

      AB_CONFIG_HOME/catalog (if set) or

      The algorithm Oracle Virtual Assembly Builder uses to determine catalog location is (in this order):

      • catalog option, if it is set in the command (applicable for operations performed using abctl command line only)

      • AB_CATALOG_HOME environment variable, if it is set

      • AB_CONFIG_HOME/catalog, if AB_CONFIG_HOME environment variable is set

      • AB_HOME/catalog

5.5 Verify Your Installation

Verify your installation to ensure you have done everything correctly. You can verify installation of the command-line tool and the graphical Oracle Virtual Assembly Builder Studio.

  • To test the command-line interface (CLI):

    cd $AB_HOME/bin
    ./abctl version
  • To test the graphical Oracle Virtual Assembly Builder Studio:

    cd $AB_HOME/bin/abstudio/bin

6 Deinstallation

To deinstall Oracle Virtual Assembly Builder, execute this command:

rm -rf $AB_HOME

This deinstalls Oracle Virtual Assembly Builder if it was installed in default locations.If you remove $AB_HOME, you must also remove your catalog and config homes as well. Do not reuse your catalog after removing the $AB_HOME.

7 Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

TTY Access to Oracle Support Services

To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. Complete instructions for using the AT&T relay services are available at After the AT&T Customer Assistant contacts Oracle Support Services, an Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process.

Oracle Virtual Assembly Builder Installation Guide, 11g Release 1 (11.1.1)


Copyright © 2010 Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.