Developer's Guide to Building vApps and Virtual Appliances - VMware

122 Pages·2009·1.44 MB·English

Developer’s Guide to Building vApps
and Virtual Appliances
VMware Studio 2.0
EN-000207-00
Developer’s Guide to Building vApps and Virtual Appliances
You can find the most up-to-date technical documentation on the VMware Web site at:
http://www.vmware.com/support/
The VMware Web site also provides the latest product updates.
If you have comments about this documentation, submit your feedback to:
[email protected] 
© 2008-2009 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual
property laws. VMware products are covered by one or more patents listed at http://www.vmware.com/go/patents.
VMware, the VMware “boxes” logo and design, Virtual SMP, and VMotion are registered trademarks or trademarks of
VMware,Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks
of their respective companies.
VMware,Inc.
3401 Hillview Ave.
Palo Alto, CA 94304
www.vmware.com
2 VMware,Inc.
Contents
About This Book 7
1 Introduction to VMware Studio 9
Overview 9
What is a vApp? 9
What is a Virtual Appliance? 10
Audience for VMware Studio 10
Key Features 11
Architecture of VMware Studio 12
Virtual Appliance Management Infrastructure (VAMI) 12
Build System 13
VMware Studio Plugin for Eclipse 13
Integration with VMware Update Manager 14
Roadmap of This Manual 14
Linux and Eclipse Developers 14
Windows Developers 14
Developers Planning to Build vApps 14
Automating Builds from the Command Line 14
ISVs Shipping Virtual Appliances 14
2 Getting Started with VMware Studio 15
Prerequisites 15
Deploying VMware Studio 16
Deployment Options 16
Supported Distribution Formats 17
Deployment Procedure 18
Security of Self‐Signed SSL Certificate 18
Modifying the Network and Time Zone Settings 19
Choosing Between DHCP and Static Network Addresses 19
Configuring Static IP Addresses 19
Configuring the Network Proxy 19
Configuring DHCP 20
Setting the Time Zone 20
Using VMware Studio Web Console 20
Accessing the VMware Studio Web Console 20
Shutting Down the VMware Studio Appliance 20
Setting Time Zone in the Web Console 21
Network Configuration 21
3 Building VMs and vApps Using VMware Studio 23
Outline of VM Build Procedure 23
Outline of vApp Build Procedure 23
Acquiring the OS ISO 24
Requirements for Building 64‐Bit VMs 24
Output Formats 24
Supported Products to Run Generated VMs and vApps 24
VMware vSphere User Privileges for Provisioning 25
VMware, Inc. 3
Developer’s Guide to Building vApps and Virtual Appliances
Developing a Linux‐Based VM
4 Creating a Linux‐Based VM 29
Overview 29
Prerequisites – OS and Application 29
Accessing the Web Console 29
Operating System ISO Image 30
Application Packages 30
Creating a VM Build Profile 31
Web Console Tab Reference 32
Description Tab 33
Hardware Tab 34
OS Tab 35
Application Tab 36
Management Tab 36
Output Tab 38
Build Settings Tab 39
Building a VM from the Build Profile 41
Testing the Generated VM 41
Reiterating the Build Process 42
Using Existing VM as Input 42
Migrating Build Profiles from VMware Studio 1.0 42
VMware Tools Installed in a Generated VM 43
5 Packaging a Linux Application 45
VMware Studio Make Package (mkpkg) Tool 45
Options of the Make Package Tool 45
Example of Creating a DEB Package 46
Example of Creating an RPM Package 47
Operating System Native Tools 48
DEB Native Packaging 48
RPM Native Packaging 48
TAR Archive as Input Format 49
6 Adding a Linux Management Service 51
VMware Studio Management Service 51
Default Management Services 52
Creating a Management Service 52
service.xml 53
view.xml 53
Management Services with Eclipse 54
Importing a Management Service 54
7 Managing the Linux Update Repository 55
Overview of Updates 55
Generating an Update 56
Updates on CDROM 57
Updates Requiring Reboot 58
Publishing an Update 58
Publishing an Update Repository from ZIP 58
Testing Against a Staging Update Repository 59
Update Repository Format 60
Supporting Central Updates with VMware Update Manager 60
4 VMware, Inc.
Contents
8 Using the VMware Studio Plugin for Eclipse 61
Requirements of VMware Studio Plugin for Eclipse 61
Getting Started with VMware Studio Plugin for Eclipse 61
Packaging Applications to Run In a Virtual Machine 62
Creating Management Services 63
Additional Eclipse Features 63
Uninstalling the Eclipse Plugin 64
Developing a Windows‐Based VM
9 Creating a Windows‐Based VM 67
Overview 67
Prerequisites – OS and Application 67
Accessing the Web Console 67
Operating System ISO Image 68
Windows Application Packages 68
Creating a VM Build Profile 68
Additional Fields for Windows Reference 69
OS Tab 69
Application Tab 71
Building a VM from the Build Profile 72
Testing the Generated VM 72
Reiterating the Build Process 73
10 Packaging a Windows Application 75
About VMware Studio Package for Windows 75
Repository of Windows Application Packages 75
Creating a Windows Application Package 76
Registered Exit Codes 77
Environment Variables when installing Packages 77
Developing a vApp for vSphere
11 Creating a vApp from VM Builds 81
Introduction to Building a vApp 81
Prerequisites 81
Creating a vApp Build Profile 81
Web Console Tab Reference 82
Description Tab 83
VMs Tab 83
Start Order Tab 84
Resources Tab 84
Output Tab 84
Building a vApp Build Profile 85
Testing the Generated vApp 86
Importing vApp Profiles 86
VMware, Inc. 5
Developer’s Guide to Building vApps and Virtual Appliances
12 Guidelines for Creating Virtual Appliances 87
Outline of Virtual Appliance Build Procedure 87
VMware Recommendations 88
Choosing OVF Version 88
Choosing Virtual Hardware Version 88
User Accounts 88
Include Update Agent 88
Partitioning Disk for System and User Data 88
13 Building from the Command Line 89
Using the Command Line 89
Managing Builds 91
Old Builds 91
Appendixes
A Management Services Web API 95
Root Object 95
VAMI Container 95
vami.container.navigate 95
vami.container.logout 95
vami.container.newHistoryItem 96
vami.container.isLogin 96
vami.container.getUser 96
vami.container.getSessionID 96
VAMI Container Callbacks 96
vami.container.registerOnShowCallback 96
vami.container.registerOnHideCallback 97
vami.container.registerOnNavigateCallback 97
VAMI I/O 97
vami.io.httpGet 97
vami.io.httpPost 98
VAMI Log 98
vami.log.info 98
vami.log.warn 98
vami.log.error 99
B Security with SSH and SSL 101
Installing SSH on Windows 101
Workstation 6.5 and Server 1.0 101
Checking Veracity of an SSL Certificate 102
C Editing XML Build Profiles 105
Introduction 105
Structure of VM XML Build Profiles 106
Useful Attributes Not Displayed in the VMware Studio Web Console 113
Customizing the Footer in the Web Console 113
Creating Virtual Disks, Partitions, and Virtual Devices 114
Structure of vApp XML Build Profiles 116
D Troubleshooting 119
Resolving VMware Studio Issues 119
Resolving Eclipse Plugin Issues 122
6 VMware, Inc.
About This Book
VMware® Studio is an integrated development tool that takes existing software applications and packages 
them into virtual machines and vApps that are ready to run and optimized for VMware product platforms.
This book, the Developer’s Guide to Building vApps and Virtual Appliances, provides information about creating 
virtual machines and vApps using VMware Studio 2.0.
Revision History
This book is revised with each release of the product or when necessary. A revised version can contain minor 
or major changes. Table1 summarizes the significant changes in each version of this book.
Table1. Revision History
Revision Description
20090828 Release version, the Developer’s Guide to Building vApps and Virtual Appliances for VMware Studio 2.0.
20090629 Version of the Developer’s Guide to Building vApps and Virtual Appliances for VMware Studio 2.0 Beta.
20090205 Similar version with minor corrections throughout the text.
20080905 First version, the Guide to Building and Implementing Virtual Appliances for VMware Studio 1.0.
VMware provides several different SDK products, each of which targets different developer communities and 
target platforms. To view documentation for the various SDK products, and the current version of this guide, 
go to http://www.vmware.com/support/pubs/sdk_pubs.html.
VMware Studio Forum
If you have questions about VMware Studio or want to interact with other users and developers, go to 
http://communities.vmware.com/community/vmtn/vam/studio?view=discussions.
Intended Audience
This document is intended for developers, independent software vendors (ISV), system integrators (SI), value 
added resellers (VAR), hardware appliance vendors (HAV), IT professionals, and datacenter administrators 
who want to create quick‐starting virtual machines, vApps and virtual appliances with VMware Studio. For 
information about deploying vApps and virtual appliances created by VMware Studio, see the companion 
manual, User’s Guide to Deploying vApps and Virtual Appliances.
Document Feedback
VMware welcomes your suggestions for improving our documentation. Send your feedback to 
[email protected].
VMware, Inc. 7
Developer’s Guide to Building vApps and Virtual Appliances
Technical Support and Education Resources
The following sections describe the technical support resources available to you. To access the current versions 
of other VMware books, go to http://www.vmware.com/support/pubs.
Online and Telephone Support
To use online support to submit technical support requests, view your product and contract information, and 
register your products, go to http://www.vmware.com/support.
Support Offerings
To find out how VMware support offerings can help meet your business needs, go to 
http://www.vmware.com/support/services.
VMware Professional Services
VMware Education Services courses offer extensive hands‐on labs, case study examples, and course materials 
designed to be used as on‐the‐job reference tools. Courses are available onsite, in the classroom, and live 
online. For onsite pilot programsand implementation best practices, VMware Consulting Services provides 
offerings tohelp you assess, plan, build, and manage your virtual environment. To access information about 
education classes, certification programs, and consulting services, go to http://www.vmware.com/services.
8 VMware, Inc.
1
1
Introduction to VMware Studio
This chapter includes the following topics:
 “Overview” on page9
 “Architecture of VMware Studio” on page12
 “Roadmap of This Manual” on page14
Overview
VMware Studio is an integrated development tool that takes existing software applications and packages them 
into virtual machines and vApps that are ready to run and optimized for VMware product platforms. 
VMwareStudio can build both Linux‐based VMs and Windows‐based virtual machines and vApps, running 
single tier or multitier applications.
Linux‐based virtual machines that VMware Studio generates contain an in‐guest management agent with a 
Web console that an ISV can brand and ship as part of a customized virtual appliance. VMware Studio serves 
as an extension to the ISV’s build system, generating automated builds of virtual machines and vApps 
containing the latest software binaries. Virtual machines and vApps generated by VMware Studio are in an 
industry‐standard format, enabling them to run on many virtualization platforms.
What is a vApp?
VMware recently introduced the vApp, a software solution optimized for the cloud OS. A vApp is a logical 
entity composed of one or more virtual machines, which can be managed as a unit. The vApp specifies and 
encapsulates components of a multitier application as well as the operational policies and service levels 
associated with it. The vApp gives application owners a standard way to describe operational policies for an 
application, which the cloud OS can consistently interpret and run. The vApp is a broad category of virtual 
applications that are built by ISVs, system integrators, value‐added resellers, and onsite IT administrators.
The Open Virtualization Format (OVF) standard 1.0 is employed to represent a single virtual machine or 
combination of multiple virtual machines. As implemented, draft OVF standard 0.9 cannot represent more 
than one virtual machine. You can deploy a vApp through vCenter Server with the vSphere Client, or with 
ovftool. VirtualCenter 2.5 and ESX/ESXi 3.5 supported OVF 0.9 only. You can run all or part of a vApp on 
ESX/ESXi 3.5 if you deploy the vApp through vCenter Server 4.
See http://www.vmware.com/appliances/learn/ovf.html for details about the OVF standard (DMTF DSP0243).
From a management perspective, a vApp acts like a virtual machine object. It has power operations, networks, 
datastores, and its resource use can be configured. See the vApp chapter of vSphere Basic System Administration 
for vApp management information.
From an implementation perspective, a vApp container is a specialized resource pool that is extended with 
compute resources, product information, and importability. In the VMware vSphere API Reference, VirtualApp 
(the managed object type for vApp) contains virtual machines.
VMware, Inc. 9
Developer’s Guide to Building vApps and Virtual Appliances
What is a Virtual Appliance?
Virtual appliances are prebuilt software solutions, comprising one or more virtual machines and applications, 
which are packaged, updated, maintained, and managed as a unit. Unlike traditional hardware appliances, 
software appliances let customers easily acquire and deploy preintegrated solution stacks.
With virtual appliances, ISVs can create a single application stack, reducing the cost and complexity of 
deployment and management. It is possible to ship preinstalled, preconfigured solutions that allow customers 
to plug solutions into their computing environments. For customers, deploying and managing software is 
easier when the applications are delivered in a virtual appliance. The following items summarize the benefits 
of virtual appliances:
 Accelerate time to market – Customers can quickly download and power‐on your virtual appliance.
 Reduce distribution overhead – The same virtual appliance runs on most VMware product platforms.
 Increase reliability – VMware Studio builds an optional update repository for automatic patching.
 Enhance security – Appliances are less vulnerable to security breaches than a general‐purpose OS.
 Lower support costs – Virtual appliances require little configuration and no maintenance.
Audience for VMware Studio
If you are a software developer at an ISV, VMware Studio can assist you in delivering your applications as 
virtual appliances, quickly and effectively. If you are an information‐technology professional or system 
administrator, VMware Studio can help you package existing operating systems and applications for your 
virtualized datacenter for use within the enterprise. VMware Studio can build both Linux‐based VMs and 
Windows‐based virtual machines and vApps, running single tier or multitier applications.
Figure1‐1 illustrates the workflow to create, distribute, and update a virtual appliance. A software vendor 
packages the software for distribution to corporate customers and end‐users, who deploy the package on a 
virtualization platform. VMware Studio can optionally build an update repository, and embed the URL of the 
update repository into the virtual appliance, which periodically checks for updates after deployment.
Figure1-1. VMware Studio Workflow
Within the enterprise, these two boxes might be joined together. Within the same organization, IT developers 
use VMware Studio to package virtual appliances for delivery to datacenter customers. Administrators control 
operational policies and service levels after deployment and configuration.
10 VMware, Inc.