This document supports the version of each product listed and
supports all subsequent versions until the document is
replaced by a new edition. To check for more recent editions
of this document, see http://www.vmware.com/support/pubs.
EN-0001030-00
vCloud Director Installation and Upgrade Guide
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:
VMware is a registered trademark or trademark of VMware, Inc. in the United States and 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
VMware vCloud Director Installation and Upgrade Guide5
Overview of vCloud Director Installation, Configuration, and Upgrade7
1
vCloud Director Architecture 7
Configuration Planning 8
vCloud Director Hardware and Software Requirements 8
Creating a vCloud Director Server Group23
2
Install and Configure vCloud Director Software on the First Member of a Server Group 24
Configure Network and Database Connections 26
Install vCloud Director Software on Additional Members of a Server Group 29
Install Microsoft Sysprep Files on the Servers 31
Start or Stop vCloud Director Services 32
Uninstall vCloud Director Software 32
Upgrading vCloud Director33
3
Use the Cell Management Tool to Quiesce and Shut Down a Server 35
Upgrade vCloud Director Software on Any Member of a Server Group 36
Upgrade the vCloud Director Database 38
Upgrade vShield Manager 40
Upgrade vCenter, Hosts, and vShield Edge Appliances 40
vCloud Director Setup43
4
Review the License Agreement 44
Enter the License Key 44
Create the System Administrator Account 44
Specify System Settings 44
Ready to Log In to vCloud Director 45
Cell Management Tool Reference47
5
Commands for Managing a Cell 48
Commands for Exporting Database Tables 49
Commands for Replacing SSL Certificates 51
Commands for Generating Self-Signed SSL Certificates 52
Recovering the System Administrator Password 53
Index55
VMware, Inc. 3
vCloud Director Installation and Upgrade Guide
4 VMware, Inc.
VMware vCloud Director Installation and
Upgrade Guide
The VMware vCloud Director Installation and Upgrade Guide provides information about installing or
upgrading VMware vCloud Director software and configuring it to work with VMware vCenter™ to
provide VMware-ready VMware vCloud® services.
Intended Audience
The VMware vCloud Director Installation and Upgrade Guide is intended for anyone who wants to install or
upgrade VMware vCloud Director software. The information in this book is written for experienced system
administrators who are familiar with Linux, Windows, IP networks, and VMware vSphere®.
VMware, Inc. 5
vCloud Director Installation and Upgrade Guide
6 VMware, Inc.
Overview of vCloud Director
Installation, Configuration, and
Upgrade1
A VMware vCloud® combines a vCloud Director server group with the vSphere platform. You create a
vCloud Director server group by installing vCloud Director software on one or more servers, connecting the
servers to a shared database, and integrating the vCloud Director server group with vSphere.
The initial configuration of vCloud Director, including database and network connection details, is
established during installation. When you upgrade an existing installation to a new version of
vCloud Director, you update the vCloud Director software and database schema, leaving the existing
relationships between servers, the database, and vSphere in place.
This chapter includes the following topics:
“vCloud Director Architecture,” on page 7
n
“Configuration Planning,” on page 8
n
“vCloud Director Hardware and Software Requirements,” on page 8
n
vCloud Director Architecture
A vCloud Director server group consists of one or more vCloud Director servers. These servers share a
common database, and are linked to an arbitrary number of vCenter servers and ESXi hosts. vShield
Manager servers provide network services to vCenter and vCloud Director.
A typical installation creates a vCloud Director server group comprising several servers. Each server in the
group runs a collection of services called a vCloud Director cell. All members of the group share a single
database. Each cell in the group connects to multiple vCenter servers, the hosts that they manage, and the
vShield Manager servers that are configured to support the vCenter servers.
VMware, Inc.
7
vCloud Director Installation
vCloud Director
Server
Cell
vCloud Director
Database
VMware vCloud Director
VMware vSphere
vCenter
Database
vShield
Manager
vCenter
ESX/ESXi
ESX/ESXi
vCloud Director Installation and Upgrade Guide
Figure 1‑1. vCloud Director Architecture Diagram
The vCloud Director installation and configuration process creates the cells, connects them to the shared
database, and establishes the first connections to a vCenter server, vShield Manager, and hosts. A system
administrator can then use the vCloud Director Web console to add vCenter servers, vShield Manager, and
hosts to the vCloud Director server group at any time.
Configuration Planning
vSphere provides storage, compute, and networking capacity to vCloud Director. Before you begin
installation, consider how much vSphere and vCloud Director capacity you need, and plan a configuration
that can support it.
Configuration requirements depend on many factors, including the number of organizations in the cloud,
the number of users in each organization, and the activity level of those users. The following guidelines can
serve as a starting point for most configurations:
Allocate one vCloud Director server (cell) for each vCenter server that you want to make accessible in
n
your cloud.
Be sure that all vCloud Director servers meet at least the minimum requirements for memory, CPU, and
n
storage detailed in “vCloud Director Hardware and Software Requirements,” on page 8.
Configure the vCloud Director database as described in “Installing and Configuring a vCloud Director
n
Database,” on page 14.
vCloud Director Hardware and Software Requirements
Each server in a vCloud Director server group must meet certain hardware and software requirements. In
addition, a supported database must be accessible to all members of the group. Each server group requires
access to a vCenter server, vShield Manager, and one or more ESXi hosts.
Supported Platforms
Current information about the VMware platforms supported by this release of vCloud Director is available
from the VMware Product Interoperability Matrixes at
Chapter 1 Overview of vCloud Director Installation, Configuration, and Upgrade
vSphere Configuration Requirements
Servers and hosts intended for use with vCloud Director must meet specific configuration requirements.
vCenter networks intended for use as vCloud Director external networks or network pools must be
n
available to all hosts in any cluster intended for vCloud Director to use. Making these networks
available to all hosts in a datacenter simplifies the task of adding new vCenter servers to
vCloud Director.
vSphere Distributed Switches must be used for cross-host fencing and network pool allocation.
n
vCenter clusters used with vCloud Director must configure storage DRS with an automation level of
n
Fully Automated. This configuration requires shared storage attached to all ESXi hosts in a DRS cluster.
vCloud Director can take full advantage of Storage DRS, including support for fast provisioning, with
vCenter 5.1 or later.
vCenter servers must trust their hosts. All hosts in all clusters managed by vCloud Director must be
n
configured to require verified host certificates. In particular, you must determine, compare, and select
matching thumbprints for all hosts. See Configure SSL Settings in the vCenter Server and HostManagement documentation.
vSphere Licensing Requirements
vCloud Director requires the following vSphere licenses:
VMware DRS, licensed by vSphere Enterprise and Enterprise Plus.
n
VMware Distributed Switch and dvFilter, licensed by vSphere Enterprise Plus. This license enables
n
creation and use of vCloud Director isolated networks.
Supported vCloud Director Server Operating Systems
Table 1‑1. Supported vCloud Director Server Operating Systems
Operating System (64-bit only)Updates
CentOS 64
Red Hat Enterprise Linux 54-9
Red Hat Enterprise Linux 61-4
Disk Space
Requirements
Memory Requirements
Linux Software
Packages
Each vCloud Director server requires approximately 1350MB of free space
for the installation and log files.
Each vCloud Director server must be provisioned with at least 4GB of
memory.
Each vCloud Director server must include installations of several common
Linux software packages. These packages are typically installed by default
with the operating system software. If any are missing, the installer fails with
a diagnostic message.
Table 1‑2. Required Software Packages
Package NamePackage NamePackage Name
alsa-liblibICEmodule-init-tools
bashlibSMnet-tools
chkconfiglibstdcpciutils
coreutilslibX11procps
VMware, Inc. 9
vCloud Director Installation and Upgrade Guide
Table 1‑2. Required Software Packages (Continued)
Package NamePackage NamePackage Name
findutilslibXauredhat-lsb
glibclibXdmcpsed
greplibXexttar
initscriptslibXiwhich
krb5-libslibXt
libgcclibXtst
Supported vCloud Director Databases
vCloud Director supports Oracle and Microsoft SQL Server databases. The most current information about
supported databases is available from the VMware Product Interoperability Matrixes at
For recommended database server configurations, see “Installing and Configuring a vCloud Director
Database,” on page 14.
Supported LDAP Servers
Table 1‑3. Supported LDAP Servers
PlatformLDAP ServerAuthentication Methods
Windows Server 2003Active DirectorySimple, Simple SSL, Kerberos, Kerberos SSL
Windows Server 2008Active DirectorySimple
Windows 7 (2008 R2)Active DirectorySimple, Simple SSL, Kerberos, Kerberos SSL
LinuxOpenLDAPSimple, Simple SSL
Guest OS Support
See the vCloud Director User's Guide for a list of supported guest operating systems.
Browsers That vCloud Director Supports
The vCloud Director Web Console is compatible with recent versions of Google Chrome, Mozilla Firefox,
and Microsoft Internet Explorer.
NOTE The vCloud Director Web Console is compatible only with 32-bit browsers. When a browser is listed
as supported on a 64-bit platform, use of a 32-bit browser on the 64-bit platform is implied.
Browser Support on Linux Platforms
On these Linux platforms, the vCloud Director Web Console is compatible with the most recent version of
Mozilla Firefox and Google Chrome, and with their immediate predecessor versions.
10 VMware, Inc.
Chapter 1 Overview of vCloud Director Installation, Configuration, and Upgrade
Table 1‑4. Browser Support and Operating System Compatibility on Linux Platforms
PlatformGoogle ChromeMozilla Firefox
CentOS 6.xYESYES
Red Hat Enterprise Linux 6.xYESYES
Ubuntu 12.xYESYES
Browser Support on Windows Platforms
On Windows platforms, the vCloud Director Web Console is compatible with at least one version of
Microsoft Internet Explorer. Some Windows platforms are also compatible with the most recent version of
Mozilla Firefox and Google Chrome, and with their immediate predecessor versions.
Table 1‑5. Browser Support and Operating System Compatibility on Microsoft Windows Platforms
Internet
Google
Platform
Windows XP ProYESYESYESNoNo
Windows Server 2003
Enterprise Edition
Windows Server 2008YESYESYESYESYES
Windows Server 2008 R2YESYESYESYESYES
Windows VistaYESNoYESYESYES
Windows 7YESYESYESYESYES
Windows 8YESYESNoNoYES
Chrome
YESYESYESNoNo
Mozilla
FirefoxInternet Explorer 8.x
Internet
Explorer 9.x
Explorer
10.x
Browser Support on Macintosh Platforms
On Macintosh platforms, the vCloud Director Web Console is compatible with the most recent version of
Mozilla Firefox and Google Chrome, and with their immediate predecessor versions.
Supported Versions of Adobe Flash Player
The vCloud Director Web Console requires Adobe Flash Player 11.2 or later. Only the 32-bit version is
supported.
Supported Versions of Java
vCloud Director clients must have JRE 1.6.0 update 10 or later installed and enabled. Only the 32-bit version
is supported.
Supported TLS and SSL Protocol Versions and Cipher Suites
vCloud Director requires clients to use SSL. The following SSL server protocols are supported:
TLS versions 1.0, 1.1, and 1.2
n
SSL version 3
n
Supported cipher suites include those with RSA, DSS, or Elliptic Curve signatures and DES3, AES-128, or
AES-256 ciphers.
VMware, Inc. 11
vCloud Director Installation and Upgrade Guide
Summary of Network Configuration Requirements for vCloud Director
Secure, reliable operation of vCloud Director depends on a secure, reliable network that supports forward
and reverse lookup of hostnames, a network time service, and other services. Your network must meet these
requirements before you begin installing vCloud Director.
The network that connects vCloud Director servers, the database server, vCenter servers, and vCloud
Networking and Security, must meet several requirements:
IP addresses
Console Proxy Address
Network Time Service
Server Time Zones
Hostname Resolution
Each vCloud Director server requires two IP addresses, so that it can support
two different SSL connections. One connection is for the HTTP service. The
other is for the console proxy service. You can use IP aliases or multiple
network interfaces to create these addresses. You cannot use the Linux ip
addr add command to create the second address .
The IP address configured as the console proxy address must not be located
behind an SSL-terminating load balancer or reverse proxy. All console proxy
requests must be relayed directly to the console proxy IP address.
You must use a network time service such as NTP to synchronize the clocks
of all vCloud Director servers, including the database server. The maximum
allowable drift between the clocks of synchronized servers is 2 seconds.
All vCloud Director servers, including the database server, must be
configured to be in the same time zone.
All host names that you specify during installation and configuration must
be resolvable by DNS using forward and reverse lookup of the fully qualified
domain name or the unqualified hostname. For example, for a host named
vcloud.example.com, both of the following commands must succeed on a
vCloud Director host:
nslookup vcloud
nslookup vcloud.example.com
In addition, if the host vcloud.example.com has the IP address 192.168.1.1, the
following command must return vcloud.example.com:
nslookup 192.168.1.1
Transfer Server Storage
To provide temporary storage for uploads, downloads, and catalog items
that are published or subscribed externally, you must make an NFS or other
shared storage volume accessible to all servers in a vCloud Director server
group. This shared volume must have write permission for root. Each
member of the server group must mount this volume at the same
mountpoint, typically /opt/vmware/vcloud-director/data/transfer. Space
on this volume is consumed in two ways:
Transfers (uploads and downloads) occupy this storage for as long as
n
the transfer is in progress, and are removed when the transfer is
complete. Transfers that make no progress for 60 minutes are marked as
expired and cleaned up by the system. Because transferred images can
be large, it is a good practice to allocate at least several hundred
gigabytes for this use.
Catalog items in catalogs that are published externally and enable
n
caching of published content occupy this storage for as long as they
exist. (Items from catalogs that are published externally but do not
enable caching do not occupy this storage.) If you enable organizations
12 VMware, Inc.
Chapter 1 Overview of vCloud Director Installation, Configuration, and Upgrade
in your cloud to create catalogs that are published externally, it is safe to
assume that hundreds or even thousands of catalog items will need
space on this volume, and that each catalog item will be the size of a
virtual machine in compressed OVF form.
NOTE If possible, the volume you use for transfer server storage should be
one whose capacity can be easily expanded.
Network Security Recommendations
Secure operation of vCloud Director requires a secure network environment. Configure and test this
network environment before you begin installing vCloud Director
Connect all vCloud Director servers to a network that is secured and monitored. vCloud Director network
connections have several additional requirements:
Do not connect vCloud Director directly to the public Internet. Always protect vCloud Director
n
network connections with a firewall. Only port 443 (HTTPS) must be open to incoming connections.
Ports 22 (SSH) and 80 (HTTP) can also be opened for incoming connections if needed. All other
incoming traffic from a public network must be rejected by the firewall.
Table 1‑6. Ports That Must Allow Incoming Packets From vCloud Director Hosts
PortProtocolComments
111TCP, UDPNFS portmapper used by transfer service
920TCP, UDPNFS rpc.statd used by transfer service
61611TCPActiveMQ
61616TCPActiveMQ
Do not connect the ports used for outgoing connections to the public network.
n
Table 1‑7. Ports That Must Allow Outgoing Packets From vCloud Director Hosts
PortProtocolComments
25TCP, UDPSMTP
53TCP, UDPDNS
111TCP, UDPNFS portmapper used by transfer service
123TCP, UDPNTP
389TCP, UDPLDAP
443TCPvCenter, vShield Manager, and ESX
connections
514UDPOptional. Enables syslog use.
902TCPvCenter and ESX connections.
903TCPvCenter and ESX connections.
920TCP, UDPNFS rpc.statd used by transfer service.
1433TCPDefault Microsoft SQL Server database port.
1521TCPDefault Oracle database port.
5672TCP, UDPOptional. AMQP messages for task
extensions.
VMware, Inc. 13
vCloud Director Installation and Upgrade Guide
Table 1‑7. Ports That Must Allow Outgoing Packets From vCloud Director Hosts (Continued)
PortProtocolComments
61611TCPActiveMQ
61616TCPActiveMQ
Route traffic between vCloud Director servers and the vCloud Director database server over a
n
dedicated private network if possible.
Virtual switches and distributed virtual switches that support provider networks must be isolated from
n
each other. They cannot share the same level 2 physical network segment.
Installing and Configuring a vCloud Director Database
vCloud Director cells use a database to store shared information. This database must exist before you can
complete installation and configuration of vCloud Director software.
NOTE Regardless of the database software you choose, you must create a separate, dedicated database
schema for vCloud Director to use. vCloud Director cannot share a database schema with any other
VMware product.
Configure an Oracle Database
Oracle databases have specific configuration requirements when you use them with vCloud Director. Install
and configure a database instance and create the vCloud Director database user account before you install
vCloud Director.
Procedure
1Configure the database server.
A database server configured with 16GB of memory, 100GB storage, and 4 CPUs should be adequate
for most vCloud Director clusters.
2Create the database instance.
Use commands of the following form to create separate data (CLOUD_DATA) and index
(CLOUD_INDX) tablespaces:
3Create the vCloud Director database user account.
The following command creates database user name vcloud with password vcloudpass.
Create user $vcloud identified by $vcloudpass default tablespace CLOUD_DATA;
NOTE When you create the vCloud Director database user account, you must specify CLOUD_DATA
as the default tablespace.
14 VMware, Inc.
Chapter 1 Overview of vCloud Director Installation, Configuration, and Upgrade
4Configure database connection, process, and transaction parameters.
The database must be configured to allow at least 75 connections per vCloud Director cell plus about 50
for Oracle's own use. You can obtain values for other configuration parameters based on the number of
connections, where C represents the number of cells in your vCloud Director cluster.
Oracle Configuration ParameterValue for C Cells
CONNECTIONS
PROCESSES
SESSIONS
TRANSACTIONS
OPEN_CURSORS
75*C+50
= CONNECTIONS
= PROCESSES*1.1+5
= SESSIONS*1.1
= SESSIONS
5Create the vCloud Director database user account.
Do not use the Oracle system account as the vCloud Director database user account. You must create a
dedicated user account for this purpose. Grant the following system privileges to the account:
CONNECT
n
RESOURCE
n
CREATE TRIGGER
n
CREATE TYPE
n
CREATE VIEW
n
CREATE MATERIALIZED VIEW
n
CREATE PROCEDURE
n
CREATE SEQUENCE
n
6Note the database service name so you can use it when you configure network and database
connections.
To find the database service name, open the file $ORACLE_HOME/network/admin/tnsnames.ora on the
database server and look for an entry of the following form:
(SERVICE_NAME = orcl.example.com)
Configure a Microsoft SQL Server Database
SQL Server databases have specific configuration requirements when you use them with vCloud Director.
Install and configure a database instance, and create the vCloud Director database user account before you
install vCloud Director.
vCloud Director database performance is an important factor in overall vCloud Director performance and
scalability. vCloud Director uses the SQL Server tmpdb file when storing large result sets, sorting data, and
managing data that is being concurrently read and modified. This file can grow significantly when
vCloud Director is experiencing heavy concurrent load. It is a good practice to create the tmpdb file on a
dedicated volume that has fast read and write performance. For more information about the tmpdb file and
SQL Server performance, see http://msdn.microsoft.com/en-us/library/ms175527.aspx.
Prerequisites
You must be familiar with Microsoft SQL Server commands, scripting, and operation.
n
To configure Microsoft SQL Server, log on to the SQL Server host computer using administrator
n
credentials. You can configure SQL server to run with the LOCAL_SYSTEM identity, or any identity
with the privilege to run a Windows service.
VMware, Inc. 15
vCloud Director Installation and Upgrade Guide
Procedure
1Configure the database server.
A database server configured with 16GB of memory, 100GB storage, and 4 CPUs should be adequate
for most vCloud Director clusters.
2Specify Mixed Mode authentication during SQL Server setup.
Windows Authentication is not supported when using SQL Server with vCloud Director.
3Create the database instance.
The following script creates the database and log files, specifying the proper collation sequence.
USE [master]
GO
CREATE DATABASE [vcloud] ON PRIMARY
(NAME = N'vcloud', FILENAME = N'C:\vcloud.mdf', SIZE = 100MB, FILEGROWTH = 10% )
LOG ON
(NAME = N'vcdb_log', FILENAME = N'C:\vcloud.ldf', SIZE = 1MB, FILEGROWTH = 10%)
COLLATE Latin1_General_CS_AS
GO
The values shown for SIZE are suggestions. You might need to use larger values.
4Set the transaction isolation level.
The following script sets the database isolation level to READ_COMMITTED_SNAPSHOT.
USE [vcloud]
GO
ALTER DATABASE [vcloud] SET SINGLE_USER WITH ROLLBACK IMMEDIATE;
ALTER DATABASE [vcloud] SET ALLOW_SNAPSHOT_ISOLATION ON;
ALTER DATABASE [vcloud] SET READ_COMMITTED_SNAPSHOT ON WITH NO_WAIT;
ALTER DATABASE [vcloud] SET MULTI_USER;
GO
For more about transaction isolation, see http://msdn.microsoft.com/en-us/library/ms173763.aspx.
5Create the vCloud Director database user account.
The following script creates database user name vcloud with password vcloudpass.
USE [vcloud]
GO
CREATE LOGIN [vcloud] WITH PASSWORD = 'vcloudpass', DEFAULT_DATABASE =[vcloud],
DEFAULT_LANGUAGE =[us_english], CHECK_POLICY=OFF
GO
CREATE USER [vcloud] for LOGIN [vcloud]
GO
6Assign permissions to the vCloud Director database user account.
The following script assigns the db_owner role to the database user created in Step 5.
USE [vcloud]
GO
sp_addrolemember [db_owner], [vcloud]
GO
16 VMware, Inc.
Chapter 1 Overview of vCloud Director Installation, Configuration, and Upgrade
Create SSL Certificates
vCloud Director requires SSL to secure communications between clients and servers. Before you install and
configure a vCloud Director server group, you must create two certificates for each member of the group
and import the certificates into host keystores.
Each vCloud Director server requires two IP addresses, so that it can support two different SSL endpoints.
Each server requires two SSL certificates, one for each SSL endpoint.
NOTE All directories in the pathname to the SSL certificates must be readable by the user vcloud.vcloud.
This user is created by the vCloud Director installer.
Procedure
1List the IP addresses for this server.
Use a command like ifconfig to discover this server's IP addresses.
2For each IP address, run the following command to retrieve the fully qualified domain name to which
the IP address is bound.
nslookup ip-address
3Make a note of each IP address, the fully qualified domain name associated with it, and whether
vCloud Director should use the address for the HTTP service or the console proxy service.
You need the fully qualified domain names when you create the certificates, and the IP addresses when
you configure network and database connections.
4Create the certificates.
You can use certificates signed by a trusted certification authority, or self-signed certificates. Signed
certificates provide the highest level of trust. A 2,048-bit key length provides a high level of security.
Create and Import a Signed SSL Certificate
Signed certificates provide the highest level of trust for SSL communications.
Each vCloud Director server requires two SSL certificates, one for each of its IP addresses, in a Java keystore
file. You must create two SSL certificates for each server that you intend to use in your vCloud Director
server group. You can use certificates signed by a trusted certification authority, or self-signed certificates.
Signed certificates provide the highest level of trust.
To create and import self-signed certificates, see “Create a Self-Signed SSL Certificate,” on page 19.
Prerequisites
Generate a list of fully-qualified domain names and their associated IP addresses on this server, along
n
with a service choice for each IP address. See “Create SSL Certificates,” on page 17.
Verify that you have access to a computer that has a Java version 6 runtime environment, so that you
n
can use the keytool command to create the certificate. The vCloud Director installer places a copy of
keytool in /opt/vmware/vcloud-director/jre/bin/keytool, but you can perform this procedure on any
computer that has a Java version 6 runtime environment installed. Certificates created with a keytool
from any other source are not supported for use with vCloud Director. Creating and importing the
certificates before you install and configure vCloud Director software simplifies the installation and
configuration process. These command-line examples assume that keytool is in the user's path. The
keystore password is represented in these examples as passwd.
VMware, Inc. 17
Loading...
+ 39 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.