You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@vcl.apache.org by fa...@apache.org on 2012/12/10 20:12:36 UTC
svn commit: r1419674 -
/vcl/site/trunk/content/docs/vmwareconfiguration.mdtext
Author: fapeeler
Date: Mon Dec 10 19:12:35 2012
New Revision: 1419674
URL: http://svn.apache.org/viewvc?rev=1419674&view=rev
Log:
CMS commit to vcl by fapeeler
Modified:
vcl/site/trunk/content/docs/vmwareconfiguration.mdtext
Modified: vcl/site/trunk/content/docs/vmwareconfiguration.mdtext
URL: http://svn.apache.org/viewvc/vcl/site/trunk/content/docs/vmwareconfiguration.mdtext?rev=1419674&r1=1419673&r2=1419674&view=diff
==============================================================================
--- vcl/site/trunk/content/docs/vmwareconfiguration.mdtext (original)
+++ vcl/site/trunk/content/docs/vmwareconfiguration.mdtext Mon Dec 10 19:12:35 2012
@@ -16,31 +16,29 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-## VMware Configuration
+##Terminology
-**Terminology**
-
-**VM Host**
+####VM Host
- A VM host is a physical computer running a VMware hypervisor
- A VCL computer entry must be added for each VM host (Manage Computers > Edit Computer Information)
- After the computer has been added to VCL, it is designated as a VM host by changing the computer state to vmhostinuse (Manage Computers > Computer Utilities)
-**VM**
+####VM
- A VM is a virtual machine managed by VCL
- A computer entry must be added to VCL for each VM (Manage Computers > Edit Computer Information)
- Each VM must be assigned to a VM host (Virtual Hosts > VM Hosts tab > Configure Host)
- VMs do not need to be created manually in VMware, VCL automatically creates and deletes VMs
-**VM Host Profile**
+####VM Host Profile
- A VM host profile contains several parameters which describe how a VM host is configured so that VCL knows how to manage it
- Each VM host is assigned a VM host profile
- A VM host profile may be assigned to multiple VM hosts if they are configured identically
- VM host profiles may be added or modified via Virtual Hosts > VM Host Profiles tab
-**VMware Products Supported**
+####VMware Products Supported
- VMware Server 2.x
- VMware ESX 3.5 - 4.x
@@ -49,7 +47,7 @@ Notice: Licensed to the Apache Softwa
- - -
-**VM Host Management Options**
+##VM Host Management Options
The VCL management node must be able to control the VM host and the VMs running on it. VMware provides several different ways of doing this. VCL currently supports the following methods for remote VM host management:
@@ -60,13 +58,13 @@ The vSphere SDK can only be used if mana
If remote management is restricted, the VM host can be managed if SSH is enabled on it. VCL will execute vim-cmd and other commands on the VM host via SSH.
-**How to enable SSH on the VM host:**
+##How to enable SSH on the VM host:
-*VMware Server 2.x*
+####VMware Server 2.x
Enable the SSH daemon and configure identity key authentication according to the underlying VM host OS
-**ESX/ESXi 3.5 & 4.0**
+####ESX/ESXi 3.5 & 4.0
- Connect to the console of the ESX/ESXi host
- Press ALT-F1 - you should see a black screen with the VMware product name at the top
@@ -80,7 +78,7 @@ Enable the SSH daemon and configure iden
- You should see a line that looks like: 5065 5065 busybox inetd
- Kill the process (enter the PID from the output of the previous command): kill -HUP 5065
-**ESXi 4.1**
+####ESXi 4.1
Beginning with ESXi 4.1, SSH can be enabled using the vSphere Client:
@@ -94,7 +92,7 @@ Beginning with ESXi 4.1, SSH can be enab
- Click Start
- Click OK
-**ESX 5.0**
+####ESX 5.0
In the case of ESX 5.0:
@@ -109,7 +107,7 @@ In the case of ESX 5.0:
- - -
-**How to configure ESX/ESXi to use SSH identity key authentication:**
+###How to configure ESX/ESXi to use SSH identity key authentication:
SSH identity key authentication must be configured if SSH is used to manage the VM host.
@@ -143,4 +141,130 @@ IMPORTANT: Under ESXi 4.x, the authorize
*Note*: VCL will perform these steps automatically when the 1st reservation assigned to the host is processed.
- - Create a compressed tarball file containing the /.ssh directory:
\ No newline at end of file
+ - Create a compressed tarball file containing the /.ssh directory:
+
+ :::BashLexer
+ tar -C / -czf bootbank/vcl.tgz .ssh
+
+ - Edit the /bootbank/boot.cfg file and append ' --- **vcl.tgz**' to modules line as shown in the following example:
+
+ :::BashLexer
+ kernel=b.z
+ kernelopt=
+ modules=k.z â s.z â c.z â oem.tgz â license.tgz â m.z â state.tgz â vcl.tgz
+ build=4.1.0-260247
+ updated=2
+ bootstate=0
+
+ :::BashLexer
+ Optionally you can run the following two commands:
+ tar -C / -czf vcl.tgz .ssh
+ BootModuleConfig.sh --add=vcl.tgz --verbose
+
+##VM Host Profile Parameters
+
+###General Parameters
+
+####Name
+
+ - Descriptive name of the VM host profile
+
+####Type (deprecated)
+
+ - Removed in VCL 2.3
+
+####Image (optional)
+
+ - VCL hypervisor image installed on VM host computers using xCAT
+ - xCAT is not required. VM host computers may be installed manually or by some other means.
+
+ - If xCAT is not used, select "No Image"
+ - VCL has the ability to install a hypervisor image on bare-metal computers using xCAT. If the image property is configured, the image is installed when a computer's state is changed to vmhostinuse via Manage Computers > Computer Utilities
+
+####Username/Password (optional)
+
+ - Name and password of the administrative or root user residing on the VM host
+ - This account is used to manage the VM host and VMs assigned to the host
+ - The username and password are currently only used if the vSphere SDK is used to manage the VM host and VMs
+
+####Storage Parameters
+
+Resource Path (optional)
+Resource Path only needs to be configured if VMware vCenter is used. It defines the location where VMs will be created in the vCenter inventory tree. The inventory tree contains at least one Datacenter, and may also contain Folders, Clusters, and Resource Pools.
+Example: /DatacenterA/Folder1/Cluster2/ResourcePool3
+
+
+####Repository Path (optional)
+
+ - Path where master copies of images are stored which are used to transfer images to VM host datastores or to other repositories:
+ - If a reservation is assigned to a host but the image does not exist in that host's datastore, it is copied from the repository to the virtual disk path when the VM is loaded
+ - If the VCL environment contains multiple management nodes and the image does not exist in the repository or the host's datastore, the image will be retrieved from another management node's repository by copying it via SCP
+ - The Repository Path parameter does not need to be configured if the VCL environment contains a single management node and all VM hosts share the same Virtual Disk Path
+ - Example: /vmfs/volumes/nfs-repository1
+ - VMs do not run directly off of the images stored in the repository
+ - Setting the Repository Path parameter determines whether or not an additional copy of an image is created when an image is captured
+ - If repository path is not configured then only a single copy of the image will exist in the virtual disk path after an image is captured
+ - If repository path is configured then two copies of the image will exist after an image is captured - one in the virtual disk path and one in the repository
+ - Repository Path location can refer to and be mounted on either the management node or VM host
+ - It is highly recommended that the repository be mounted on the VM host
+ - When mounted on the VM host, vmdk operations can be done directly on the VM host in a single step
+ - Images in the repository are stored in the 2 GB sparse vmdk format
+ - The size of the vmdk files will approximately be equal to the amount of actual data saved in the image regardless of the size of the VM's hard drive
+ - Storing images in the 2 GB sparse format is necessary to allow images to be transferred via SCP without having to transfer data equal to the entire size of the VM's hard drive
+
+####Repository Image Type
+Virtual disk file format for images stored in the repository.
+
+####Virtual Disk Path (previously Datastore Path)
+
+ - Location where master copies of images are stored which are used by running VMs
+ - Example: /vmfs/volumes/nfs-datastore1
+ For ESXi, the path configured in the profile may simply be the short datastore name as it appears in the vSphere Client: nfs-datastore1
+ - Storage location should be large enough to store all of the images which may be loaded on the VM host (from 100's of GB to several TB)
+ - VCL creates a directory for each image in the Virtual Disk Path
+ - Images are stored in the vmfs thin vmdk format
+ - Virtual Disk Path may either reside on local or network storage
+ - Multiple VM hosts can share the same datastore if network storage is used
+ - A single datastore may be used by all VM hosts if performance is adequate
+ - Multiple VMs on different hosts may access the same Virtual Disk Path image at the same time
+ - It is recommended that datastores are shared among hosts so that fewer copies of each image have to be stored
+ - The underlying storage hardware and network connectivity from the hosts to the storage must be adequate
+ - Storage where the datastore is located should be optimized for read performance
+ - VCL configures VMs to access images stored in the Virtual Disk Path in read-only mode
+ - Changes made to the VM's hard drive are written to delta files located in the VM Working Directory Path dedicated for the VM
+
+####Virtual Disk Image Type
+
+Virtual disk file format for images stored in the virtual disk path.
+
+####Virtual Disk Mode (previously VM Disk)
+
+ - Defines whether the storage where the VM host's Virtual Disk Path resides is dedicated to a single host or shared among multiple hosts:
+ - dedicated (previously localdisk)
+ - The VM host's Virtual Disk Path is located on local disks or dedicated network storage
+ - The VM host is the only host which accesses the Virtual Disk Path
+ - Repository Path must be configured
+ - shared (previously networkdisk)
+ - The VM host's Virtual Disk Path is located on network storage which is shared by other VM hosts
+ - Repository Path is optional
+
+ The Virtual Disk Mode (VM Disk) parameter does not determine whether or not:
+...images are copied from the datastore to the repository during image capture
+...images are copied from the repository to the datastore during image load
+These are determined by whether or not Repository Path is configured in the profile
+
+####VM Working Directory Path (optional) (previously VM Path)
+
+ - Defines path on VM host where VM working directories will reside (contains .vmx, delta, .vswp, nvram files)
+ - If not configured, the Virtual Disk Path location will be used
+ - VCL creates a directory under the VM Working Directory Path for each VM it creates
+ - Contains the .vmx file which defines the VM
+ - Contains delta vmdk files which are written to as changes are made to the VM's hard drive
+ - VM Working Directory Path may either reside on local or network storage
+ - Location should be dedicated for each VM host
+ - Multiple VM hosts should not share the same VM Working Directory Path location for performance and image safety reasons
+ - VM Working Directory Paths of multiple hosts may reside on the same volume but a subdirectory should be created for each host
+ - Storage where the VM Working Directory Path is located should be optimized for read-write performance
+
+####Networking Parameters
+VM Network (previously Virtual Switch)
\ No newline at end of file