XMS FULLY AUTOMATED PROVISIONING: SERVER CONFIGURATION AND QUICK START GUIDE ABSTRACT This white paper in the form of screenshots explains how to capture the vcenter infrastructure details using vsphere Client and map that information to configure xms Server Administration tab in Management Center. The xms Server uses this information and resources to create environment templates, provision environments in fully automated provisioning method. February, 2015 EMC WHITE PAPER
To learn more about how EMC products, services, and solutions can help solve your business and IT challenges, contact your local representative or authorized reseller, visit www.emc.com, or explore and compare products in the EMC Store Copyright 2015 EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. VMware is registered trademark of VMware, Inc. in the United States and/or other jurisdictions. All other trademarks used herein are the property of their respective owners. Part Number H13853 2
TABLE OF CONTENTS EXECUTIVE SUMMARY... 4 AUDIENCE... 4 OVERVIEW... 4 XMS SERVER ADMINISTRATION... 5 Configure Media Location... 6 VMWare Connections... 6 Organizations... 8 Virtual Data Center... 9 vdc Resources... 10 VDC Domain Policy... 11 VDC Network Policy... 12 Switch configuration... 12 Network Type - UNMANAGED... 13 Network Type - MANAGED... 14 Host Templates... 15 vcenter Host Template... 16 System VDC... 17 VAPP ENABLE TEMPLATE... 17 PROVISIONING THE ENVIRONMENT... 19 CONCLUSION... 20 3
EXECUTIVE SUMMARY The xcelerated Management System (xms) manages environments and applications deployed into those environments. Fully Automated provisioning means xms provisions deployment environments into the VMware infrastructure as virtual applications (vapps). The resulting virtual machines (VMs) appear in vsphere Client or vcloud Director. In fully automated provisioning, IP configuration and other network customizations are done by xms. xms also configures domain on those machines, if needed. Then xms installs components on those machines. The xms Management Center UI lets you create and provision environments using the automated or orchestrated provisioning method. Following table compares these available methods of provisioning an environment in xms Management Center User Interface. Figure 1. Deployment Methods All information included in this document is provided "as-is" and does not guarantee EMC's support or approval. Please consult the official product documentation or the Product Support team regarding any questions of supportability. AUDIENCE The information in this guide is for application and system administrators who use xms software to deploy and administer environments. This is intended for Administrators, EMC support personnel, professional services and customers. Overview This white paper is in the form of screenshots explains how to capture the vcenter infrastructure details using vsphere Client and map that information to configure xms Server Administration tab in Management Center. The xms Server uses this information and resources to create environment templates, provision environments in fully automated provisioning method. This whitepaper is applicable for xms 1.1 and xms 1.2 releases. xms consists of: xms Tools: The command-line interface (CLI). User use a blueprint to define the environment structure, build an environment template based on the blueprint, and provision an environment based on the environment template. xms Server: The engine that executes xms commands. xms Server can provision environments and patch those provisioned environments. xms Agent: A lightweight service for application deployment and endpoint resolution in both manually created environment and xms-provisioned environments. xms Management Center: It is a web user interface utility. The xms Management Center has a set of default environment templates based on module template files, which are like the blueprint files. Within these environment templates, the xms Management Center has a default host template. User can create additional host templates and environment templates to meet 4
their need. The xms catalog contains these environment templates and host templates. The system uses a host template as a base when user prepares environment templates and provision environments. For automated provisioning, a host template specifies a base VM template on vsphere or vcloud with a pre-installed operating system and other software. User can use either default or custom environment templates to create and provision environments. In both cases, you can provision multiple environments from the same environment template. Environment Templates commonly define different types of environments. With different environment templates such as clustered, non-clustered, and developer, user can provision environments as needed. xms Server Administration The xms Management Center enables you to specify information and resources for the xms Server. It interacts with the xms Server to perform validations and system updates. The xms Management Center UI has 5 tabs as shown in Figure 1 below: Environments Catalog Operations Administration Users Figure 2. xms Server Main Page view Here we will establish a relationship between xms Server Administration and vcenter infrastructure components from vsphere Client or vcloud Director. After successfully installing xms-server.war using install-xms-server.bat in {xms-tools-home}\bin as per details in installing xms Server section Setting up xms Tools and installing the xms Server in xms Deployment Guide, open the following URL in a browser: https://<host>:<port>/xms-server You can find the host and port information in xms-server.properties in ${xms-tools-home}\config on the machine where you installed xms Server. Login to xms Management Center UI and configure xms Server Administration details for fully automated provisioning as explained in sections below: 1. Configure Media Location 2. VMWare Connections 3. Organizations 4. vdcs 5. System VDC Note: Login to vcenter Server from vsphere Client (not from vsphere Web Client) to capture vcenter infrastructure details. 5
Configure Media Location Specify the credentials to connect to shared media or NAS storage where installers are present as shown in Figure 3 below. Figure 3. Configuring Media Location VMWare Connections xms requires connection information to communicate with virtual infrastructure through its API. One xms Server connects to only one vcenter at any time. As shown in Figure 4 below: vcenter hostname/ip address is the vcenter Server IP address or the hostname. vcloud Director hostname/ip address is the vcloud Director IP address or the hostname. Username and Password are the login credentials for vcenter and vcloud Director. 6
Figure 4. Configuring vcenter or vcloud Director connection details 7
Organizations There can be multiple organizations in the xms system. Figure 5. Mapping of xms Organization name to vcloud Director Organization Organization Name o o o Organization name should point to the organization name in vcloud Director in case of vcloud executions as shown in Figure 5 above. Organization name is just a placeholder in case of vcenter. The organization name cannot be edited once saved. Organization Key value can be an abbreviation for the organization name and this will be referenced by vdc for the VM naming policy during provisioning. 8
Virtual Data Center A virtual datacenter (vdc) is an xms entity corresponding to the vsphere or vcloud datacenter. There can be multiple vdcs and the xms system requires at least one vdc. Figure 6. Mapping of VDC name to vcloud Organization VDCs The VDC name cannot be edited once saved. The VDC name should point to the Organization vdc name in vcloud Director if the management type is vcloud as shown in Figure 6 above. The VDC name can be user-defined if the management type is vcenter. vcenter Datacenter Path is the Datacenter name preceded by forward slash / as shown in Figure 6 above. 9
vdc Resources As shown in Figure 7 below: Resource Pool Name can be identified from vsphere Client console at Home -> Inventory -> Hosts and Clusters. If you don t specify resource pool name, the system generates the resources such as VMs and vapps in the root default cluster or default host. Default Data Store specifies the vsphere datastore for generated resources. Get the Default Data Store value from vsphere Client console at Home -> Inventory -> Datastores and Datastore Clusters. If you intended datastore is part of clustered datastore then specify as <clustered datastore name>/<datastore name>in xms configuration. For Example, in Figure 7 below, if you intend to use datastore NewStorageDisk which is part of clustered datastore storage, then specify as storage/newstoragedisk for Default Data Store value in Resources configuration in xms. Get the Default Cluster or Default Host values from vsphere Client console at Home -> Inventory -> Hosts and Clusters. Figure 7. vdc Resources configuration 10
VDC Domain Policy Figure 8. VDC Domain Policy as External OS Domain Policy can be Local or External Local is no domain configuration specified by user, the xms system uses the local Administrator account to provision services. External is xms system adds every provisioned VM to the fully qualified Domain Name specified as shown in figure 8 above 11
VDC Network Policy Switch configuration Figure 9. Switch name from vcenter infrastructure As shown in Figure 9 above: The switch name for vcenter can be identified from vsphere Client at Home -> Inventory -> Networking 12
Network Type - UNMANAGED Figure 10. VDC Network Type UNMANAGED configuration for vcloud The system assumes the address type as HOSTNAME if you select the network type as UNMANAGED vcenter: When the network type is UNMANAGED, the DHCP Server manages the IP addresses for the VMs. vcloud: When the network type is UNMANAGED, the IP address assignment is managed by vcloud Director i.e. vcloud Director manages the IP addresses for the VMs from the Static IP Pool as shown in Figure 10 above. 13
Network Type - MANAGED Figure 11. VDC Network Type MANAGED configuration for vcloud vcenter: When the network type is MANAGED, the system assigns the IP address from the IP range specified in Network Details for VDC configuration along with Subnet, Mask, Gateway and DNS Primary. 14
vcloud: When the network type is MANAGED, the system assigns the IP address from the IP range specified in Network Details for VDC configuration. The Subnet, Mask, Gateway, Primary DNS and Secondary DNS are taken from Network Specification properties of External Networks in vcloud Director as shown in Figure 11 above. Host Templates A host template specifies a template on vsphere or vcloud with a pre-installed operating system and other software. The system uses a host template referenced in Environment Templates as a base when building environment templates. VMware tools should be installed on this host template and user account control (UAC), Microsoft Windows firewall and any antivirus software disabled. After provisioning, you can enable them. 15
vcenter Host Template Figure 12. Host template path configuration for vcenter execution Host Template name can be user-defined. Clone the host template DEFAULT_HOST_TEMPLATE and give any desirable name. Now update this cloned template to set the provisioning type as Fully Automated and specify the built-in Administrator account credentials for Host Administration Credentials value. These credentials will be used to login to cloned VMs and execute xms commands during vapp Enable Template operation for Fully Automated provisioning method. 16
Note: Do not specify here, the domain account credentials or any other local account credentials having administrative privileges. For vcenter, the VM Template Path is the absolute path from the Datacenter to the template folder followed by the template name as shown in Figure 12 above. For vcenter the VM Template Path is the vapp name present in the organization having the host template VM. System VDC Figure 13. System vdc Configuration- Build Path during environment template creation for vcenter Select the vdc that you want to use as the system vdc. The build path for vsphere is the relative path from vcenter Datacenter Path (Refer Figure 5) specified in VDC configuration as shown in Figure 13 above. The Environment Template vapp will be created at this folder location under templates folder. The xms system clones the base VM template in this vapp during vapp Enable Template operation for Fully Automated provisioning method. The build path is optional if the System vdc is of type vcloud. In vcloud, the system creates all templates in the vcloud utility organization catalog. vapp Enable Template In xms Management Center UI and select the Environment Template which you want to use to provision a fully automated environment. vapp Enable this template by following the details steps in Chapter 4: Preparing Environment Templates of xms Deployment Guide. While updating the Environment template Pre-requisites for the type of database and type of application server (tcserver or Tomcat) to be used in the provisioned environment, in the Host Groups tab; edit and update the Host Template mapping for the various host 17
groups to the Host Template name configured for Fully Automated provisioning as discussed above in Host Templates section and as shown in Figure 14 below. Figure 14. Updating Host Template mapped to Host Groups for Environment Template xms vapp Template execution reads environment template services, gets the component installers from the media location, clones the base VM template, and vapp enables the environment template. xms vapp Template operation performs following: Instantiate VMs Silently (without user interaction) install and configure components into VMs Build environment templates and store them as vapps. xms stored the environment template as a vapp in vsphere at the folder location as per the Build path specified for System VDC in xms Server Administration tab as shown in Figure 15 below. The vapp name is as the Template Name which you have selected to vapp Enable. You now use this vapp enabled environment template to provision a fully automated environment. 18
Figure 15. Environment Template created in vcenter For vcloud executions, xms stores the environment template as a vapp in Organization s catalog in the vcloud Director. The organization is as per the organization referenced in the VDC mapped to System vdc in xms Server Administration tab. Provisioning the Environment After vapp Enable an environment template, use xms to provision that environment template. xms provisions the environment and creates a vapp with fully configured VMs. The system saves the new environment as another vapp in the deployment-environments folder in vcenter. The deployment-environments folder will be created by xms if not already present; the location of folder would be relative to vcenter Data Center path specified in VDC configuration as shown in Figure 16 below. The provisioned vapp name is the Environment Name specified in xms Management Center UI. 19
Figure 16. Provisioned Environment vapp stored in vcenter The system generates the provisioned VM names with the following format: <Host template key><vm key><environment key><instance ID> <org key> Host template key is the 3 character Environment Template Key for the vapp Enabled Environment Template. VM cluster key is 1 character vm-cluster key in the module-template file. It is unique for each service provisioned. Environment Key is 2 character key given during Create Environment operation in xms Management Center UI before provisioning the environment. Instance ID is 1 character. It is always 1 for non-clustered VMs. Org key is 1-6 alphanumeric character organization key specified during creating organization in Administration tab of xms Management Center UI. Considering an example of Host Template key as X12, environment key as RC and organization key as XMS, figure 15 above shows the sample provisioned VM names. Conclusion The user can use this document as quick reference guide on how and where to find the network details and infrastructure resources required by xms system to create environment templates and provision environments in fully automated provisioning mode. 20