Published: October 2013Interworks Cloud 2013interworks.cloud OSS VMware vSphere® Service ManagerInstallation Guide
Interworks interworks.cloud S.A.
This document contains information proprietary to Interworks interworks.cloud S.A. and its receipt or possession does not convey any rights to reproduce, disclose, manufacture, or sell anything it might describe. Use without Interworksinterworks.cloud' specific written authorization is strictly forbidden. interworks. Interworks cloud makes no representations or warranties with respect to the contents or use of this document, and it reserves the right to revise this document any time, without the obligation to notify any person or entity of revisions. Further, Interworks interworks.cloud assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind (express, implied, or statutory) with respect to the contents or use of the information, and expressly disclaims any and all warranties of merchantability, fitness for particular purposes, and non-infringement of third-party rights.
Interworks
interworks.cloud, the Interworks interworks.cloud logo, the Interworks Cloud interworks.cloud Platform logo, the Interworks Cloud interworks.cloud BSS logo, the Interworks Cloud interworks.cloud Storefront logo, the Interworks interworks.cloud Marketplace and the Interworks Cloud interworks.cloud OSS logo are registered trademarks of Interworks interworks.cloud S.A. All other trademarks are the property of their respective owners.
Interworks
interworks.cloud S.A.
207 Regent Street, London | Atrina Center Building A | 8 Iatrou Gogousi Str. |
www.interworkscloud.com
Table of Contents
Document revision history5
About this guide 6
Introduction6
Document conventions6
Support and feedback7
CHAPTER 1 8
Overview of Cloud OSS VMware vSphere Service Manager 8
Introduction8Overview of VMware vSphere 5.x8
Overview of Cloud OSS9
CHAPTER 2 10
Preparing for the installation 10
Introduction10
Deploying VMware vSphere Infrastructure10
Preparing the network11
Preparing the VM templates (Guest OS Master Images)11
CHAPTER 3 12
Installing Cloud OSS VMware vSphere Service Manager 12
Introduction12
Installing Cloud OSS VMware vSphere Service Managers12
CHAPTER 4 14
Configuring Cloud OSS VMware vSphere Service Manager 14
Introduction14
Configuring VMware vSphere module15
Configuring Network Settings17
Creating Virtual Server18
Creating Hosting Plan19
APPENDIX A 20
APPENDIX B 38
This page is intentionally left blank
Document revision history
There have been no changes to this document since its initial publication. For information about new features in this release, see the latest release notes at: *http://www.interworkscloud.com/release.en.aspx*
About this guide
Introduction
This guide provides instructions for installing and configuring Interworks Cloud interworks.cloud OSS VMware vSphere Service Manager 2.x. The following versions of VMware vSphere are currently supported in this release:
- VMware vSphere 5.1
- VMware vSphere 5.5
Note: | This guide is updated as new information becomes available. Before you begin, be sure to check the OSS documentation section at the Interworks Cloud interworks.cloud Platform support site, http://www.interworkscloud.com/downloads , to make sure you have the latest version of the guide. The publication date on the title page indicates the version; changes, if any, are recorded in the document revision history chapter of this guide. |
Document conventions
Throughout this guide, specific fonts and styles are used to identify user input, computer code, and user interface elements. The following table lists conventions used in this guide.
Table 1. Document conventions
Convention | Usage |
Bold text, Arial font | Used for information you type as well as path names, file names, menus, and command keys. |
Italic text, Arial font | Used for column names, field names, window names. |
Bold, italic text enclosed in angle brackets | Used for variables you replace with the appropriate information. |
Normal text, Courier New | Used for system messages, screen text, and code examples. |
Support and feedback
To receive support for the Cloud OSS platform use the following link:
*http://www.interworkscloud.com/downloads* to access product downloads and online help and documentation
CHAPTER 1
Overview of Cloud OSS VMware vSphere Service Manager
Introduction
This chapter provides an overview of Interworks Cloud interworks.cloud OSS platform and the VMware vSphere Service Manager.
Overview of VMware vSphere 5.x
VMware vSphere is the industry-leading virtualization platform for building cloud infrastructures. It enables IT to meet SLAs (service-level agreements) for the most demanding business critical applications, at the lowest TCO (total cost of ownership).
VMware vSphere Hypervisor Architecture provides a robust, production-proven, high-performance virtualization layer. It enables multiple virtual machines to share hardware resources with performance that can match (and in some cases exceed) native throughput.
VMware vSphere Virtual Symmetric Multiprocessing enables the use of ultra-powerful virtual machines that possess up to 64 virtual CPUs.
VMware vSphere Virtual Machine File System (VMFS) allows virtual machines to access shared storage devices (Fiber Channel, iSCSI, etc.) and is a key enabling technology for other vSphere components such as VMware vSphere Storage vMotion®.
VMware vSphere Storage APIs provide integration with supported third-party data protection, multi-pathing and disk array solutions.
Overview of Cloud OSS
The Interworks Cloud interworks.cloud OSS platform is a centralized software application that simplifies the day-to-day burden of activating, configuring and managing a service provider's unified communications and collaboration infrastructure. interworks. Interworks Cloud cloud OSS enables service providers to centrally create, control, and deliver hosted IP and application services. It addresses critical operational challenges for provisioning, monitoring, metering, self-management, authentication and further integration into other applications in the service provider's OSS/BSS systems.
Interworks Cloud interworks.cloud OSS has the following components:
- Cloud OSS Provisioning Portal
...
The Cloud OSS Service Manager can be seen as a provisioning helper server. Service Managers expose an extensive set of web services APIs that perform the actual provisioning actions as dictated by the Orchestration Servers. Service Managers are mainly installed on servers that host specific applications or services (e.g.: IIS, SQL Server), but they can also be installed on servers that have special management tools to manage and control other applications or services (e.g.: Exchange servers, Lync servers, etc.). Cloud OSS Service Managers are typically placed in the Back End network.
CHAPTER 2
Preparing for the installation
Introduction
This chapter explains how to prepare a hosting/cloud environment for the Cloud OSS VMware vSphere Service Manager installation.
Deploying VMware vSphere Infrastructure
This guide assumes that you have deployed and configured vSphere in high availability mode. The Service Manager can only interact with the vSphere infrastructure through vCenter Server, therefore vCenter Server must be installed and properly configured to manage the entire infrastructure. At the very least two servers running ESXi hypervisors are required in order to form a vSphere cluster.
The VMware vSphere Service Manager requires that the following configuration settings are applied:
- A cluster of two or more ESXi Hosts is created and configured appropriately
- A Datastore Cluster is configured with one or more datastores
- A Datacenter object container is defined. The Cluster and Datastore Cluster must be linked under this Datacenter container
- Network and storage configuration of each ESXi Host is set up correctly
Important: | The current release of VMware vSphere Service Manager supports only the Standard vSwitch. Make sure that Standard vSwitches are properly setup for the VM networks on each ESXi Host. Distributed vSwitches will be supported in future releases. |
The vSphere administrator should also ensure that various other settings such as Time Configuration, DNS and Routing, Power Management, etc. are properly configured.
Note: | Further configuration of the hosts and cluster regarding settings such as HA, FT, Monitoring, EVC, DRS, SDRS, etc. is out of scope of this guide. |
Preparing the Network
The current release of VMware vSphere Service Manager supports provisioning of VMs in standard VLAN based isolated networks. Each tenant (customer) is automatically assigned a VLAN and all VMs provisioned under that tenant belong to that specific VLAN. The Service Manager automatically configures the Standard vSwitch in each ESXi Host with the appropriate port group settings for each tenant VM.
The Network Administrator must prepare for and supply the following information:
A list of VLANs that will be made available to the VMs
Important:
Further configuration may be required depending on the existing network infrastructure. This may include routers, firewalls, physical switches or other networking devices.
- A list of IP Addresses/Ranges (IP address, Network Subnet mask, Default Gateway) that will be assigned to VMs during provisioning
- Primary and Secondary DNS server IP addresses that the provisioned VMs will use
Preparing the VM templates (Guest OS Master Images)
The Service Manager requires the use of templates created in vCenter Server, in order for VM provisioning to function correctly. The vSphere administrator should prepare the required VM templates along with relevant Guest OS customization specification files. Further instructions on how to create the necessary customization specification files and specific guest OS images can be found in Appendix A of this guide.
Important: | Take a note of the names of the VM templates and the names of the customization specification files that you create in vCenter Server. You will use these names in a special configuration file later on, during installation of the Cloud OSS VMware vSphere Service Manager. |
CHAPTER 3
Installing Cloud OSS VMware vSphere Service Manager
Introduction
This chapter explains how to install the Cloud OSS VMware vSphere Service Manager.
Installing Cloud OSS VMware vSphere Service Managers
To integrate VMware vSphere into the Cloud OSS platform you will need to install the Cloud OSS Service Managers components on one or more mediation servers You can install Interworks Cloud interworks.cloud OSS Service Manager on more than one servers and make use of hardware or software load balancing to distribute load and maintain high availability. This server may also be referred as Mediation Server. in your environment. Installation of the components is performed by the Interworks Cloud interworks.cloud Platform Installer. For more information about installing the Interworks Cloud interworks.cloud Platform Installer and the Service Managers please consult the Interworks Cloud interworks.cloud OSS Installation Guide.
The mediation server should have the following minimum system and software specifications:
Mediation Server System Requirements
Server Role | Network Zone | Processors | Memory | Storage | Notes | ||||||
Mediation Server | Back Net | 2 CPU Cores 2GHz | 4GB | 60GB | Windows 2008 R2 Std. | ||||||
Software | Version |
|
|
|
| ||||||
PowerCLI | 5.1 Or 5.5 depending on the VSphere version. Version 3
|
|
|
|
|
Login to every mediation server and install the Cloud OSS Service Managers components as described in the Cloud OSS Installation Guide. Keep in mind the following network port requirements, in order to maintain successful communication between the various Cloud OSS components and the vSphere infrastructure.
Network Access Rules
Source | Destination | Protocol | Src. Port | Dest. Port | Notes |
Mediation Server | vCenter Server | TCP | Any | 80,443,902,903 8080,8443,9090 9443 |
|
Mediation Server | vCenter Server | UDP | Any | 902 |
|
OSS Orchestrator Server | Mediation Server | TCP | Any | 9003 |
|
After installation has completed successfully, you will need to manually edit the configuration file templatesConfiguration.xml (you can use notepad or any other common text editor). This file is located at the root of the installation directory of the Cloud OSS Service Manager and contains the VM templates that the Service Manager will use to provision VMs. In this configuration file you define the names of the VM templates and the customization specification files you created earlier in vCenter Server (See previous section Preparing the VM templates). Fig. 3.1 shows an example of the contents of the configuration file.
Fig. 3.1
According to the example above, the administrator has configured one VM template named Windows Server 2008 R2 Standard and one VM template named CentOS 6.4 (64-Bit). There are also two customization specification files. One is configured for Windows based guest OS and is named OSS Windows Customization, and the other is configured for Linux based guest OS and is named OSS Linux Customization.
Appendix A of this guide contains step by step instructions on how to create both VM templates and customization specification files in vCenter Server to support VM provisioning in Cloud OSS.
Note: | The vSphere administrator may have configured any number of VM templates and/or customization specification files. Only the ones defined in the templatesConfiguration.xml file will be available in Cloud OSS during provisioning of new VMs. |
CHAPTER 4
Configuring Cloud OSS VMware vSphere Service Manager
Introduction
This section provides information about configuring the Cloud OSS VMware vSphere Service Manager. It is assumed that you have installed the Cloud OSS Service Managers components on all servers that require it, as described in the previous sections and you have verified connectivity to the Service Managers web sites. Before configuring each component, it is necessary to add each server to the Cloud OSS servers' collection. This is done by signing in to the Cloud OSS Provisioning Portal, navigating to Configuration ► Servers (Fig. 4.1) and clicking on Add Server (Fig. 4.2) button.
Fig. 4.1 Fig. 4.2
You have to enter a server name (you may choose any name that is meaningful and/or descriptive of the server role) as well as the URL and server password that correspond to each Service Manager installation. For more information about administering and configuring Cloud OSS platform you may consult the Cloud OSS Administrator Guide.
Configuring VMware vSphere module
Sign in to Cloud OSS Provisioning Portal and navigate to Configuration ► Servers. Click on the server where the Cloud OSS VMware vSphere Service Manager was previously installed and perform the following actions:
- Under the Services section click Add next to VMware vSphere (Fig. 4.4)
- Optionally, change the Service Name label if required
- Select vSphere 5.x as Service Provider
- Click on the Add Service button
...
VMware Custom Service has been provisioned successfully
Fig. 4.5
Configuring Network Settings
VLAN Pool configuration
Sign in to Cloud OSS Provisioning Portal and navigate to Configuration ► Virtual LANs. Click on Add Virtual LAN button and enter a meaningful name in the Description field; then enter the range of available VLANs and finally click on the Add button to save your VLAN selection (Fig. 4.6).
Fig. 4.6
You can repeat this process if you wish to insert additional VLAN ranges.
IP Address Pool configuration
Sign in to Cloud OSS Provisioning Portal and navigate to Configuration ► IP Addresses. Click on the Add IP Address button and enter the following information (Fig. 4.7):
- Select VMware External Network in the Pool: drop down list
- Select the server previously configured in the Server: drop down list (See section Configuring VMware vSphere module)
- Enter an appropriate IP address range
- Optionally, set the NAT Address that will apply to the selected IP Address range
- Enter the Subnet mask and the Default Gateway
Fig. 4.7
You can repeat this process if you wish to insert additional IP Address ranges.
Creating Virtual Server
Sign in to Cloud OSS Provisioning Portal and navigate to Configuration ► Virtual Servers. Click on Add Virtual Server button and enter a meaningful name in the Server Name: field; then click on Add Server button to save the new Virtual Server.
Note: | It is strongly recommended to use Virtual Servers and not Servers to assign to Hosting Plans. This greatly increases scalability and helps you avoid potential problems when you want to add services or extra resources to existing customers. |
Click on Add Services button and select VMware vSphere service on the server previously configured.
Click on the Update button.
Creating Hosting Plan
Sign in to Cloud OSS Provisioning Portal and navigate to Account Home ► Hosting Plans ► Create Hosting Plan. Enter a meaningful plan name and an optional description and select as target server the Virtual Server you created earlier from the drop-down list. Under the Quotas section select the VMware vSphere service. Adjust the quotas and values of the service to meet your plan needs and click on the Save button to save the new Hosting Plan (Fig. 4.8).
Fig. 4.8
You are now ready to create a new customer and assign a new Hosting Space to the customer based on the Hosting Plan you just created.
APPENDIX A
Deploying Guest OS Master Images (VM Templates)
Introduction
This section provides information that can help you create Windows and Linux based guest OS templates that will be used by Cloud OSS during VM provisioning. Instructions provided herein will assist in creating customizations specification files for Windows and Linux operating systems as well as optimized images ready for provisioning. To follow these instructions you will need administrative access to vCenter Server (via vSphere Client) as well as adequate ISO images or CD/DVD discs containing the operating systems for the guest OS.
Windows Customization Specification
Launch vSphere client and connect to the vCenter Server using root credentials (or another user with administrative privileges). Navigate to Management ► Customization Specifications Manager and click New to create a new Customization Specification.
In the Properties page make the following selections:
...
Click Finish to finalize and save the Customization Specification
Linux Customization Specification
Launch vSphere client and connect to the vCenter Server using root credentials (or another user with administrative privileges). Navigate to Management ► Customization Specifications Manager and click New to create a new Customization Specification.
In the Properties page make the following selections:
...
Click Finish to finalize and save the Customization Specification
Create a Windows Server 2008 R2 Standard with SP1 Guest OS Template
The following instructions aim to assist in configuring and deploying a server guest OS template based on Windows Server 2008 R2 Standard with SP1. You may choose to select different settings depending on your own experience or other requirements that may apply in your environment.
Launch vSphere client and connect to the vCenter Server using root credentials (or another user with administrative privileges). Navigate to Inventory ► VMs and Templates, select the Datacenter container and right click New Virtual Machine… to create a new VM.
Fig. A1: Select Custom configuration for the VM Fig. A2: Enter a meaningful name for the VM Fig. A3: Select a cluster to run the VM Fig. A4: Choose the destination storage of the VM
Fig. A5: Select the Virtual Machine version Fig. A6: Choose the guest OS and specify the version (Normally the latest version should be selected) In this example the selection is Windows and Microsoft Windows Server 2008 R2 (64-bit)
Fig. A7: Select 1 virtual socket and 1 CPU core Fig. A8: Select 512 MB for the memory size of the VM
Fig. A9: Configure 1 Network connection, choose the VMXNET 3 Adapter Fig. A10: Choose the LSI Logic SAS SCSI controller
Fig. A11: Select to create a new virtual disk Fig. A12: Set the disk size to 20GB and select Thindisk provisioning
Fig. A13: Keep default settings in disk advanced options Fig. A14: Click Finish to create the new VM
Fig. A15: Optionally uncheck the Enable logging checkbox Fig. A16: Enable memory and CPU hot add for the VM
Fig. A17: Insert the parameter devices.hotplug in Configuration Fig. A18: Set the value of disk.EnableUUID option in Parameters and set its value to false Configuration Parameters to false
Fig. A19: Force the BIOS setup to launch next time the VM starts
Mount a Windows ISO image or insert a Windows DVD in the host DVD device (Make sure that the VM's DVD device status is set to Connect at power on) and power on the VM. At the BIOS setup screen disable the following devices:
...
- Reboot the VM
- Release the IP address (Set TCP/IP settings to DHCP)
- Shutdown the VM
- Right click the VM and select Template ► Convert to Template
Fig. A20: Sample content of setupcomplete.cmd file
Fig. A21: Sample content of unattend.xml file
Create a Linux CentOS 6.4 (64-Bit) Guest OS Template
The following instructions aim to assist in configuring and deploying a server guest OS template based on CentOS 6.4 (64-bit). You may choose to select different settings depending on your own experience or other requirements that may apply in your environment.
Launch vSphere client and connect to the vCenter Server using root credentials (or another user with administrative privileges). Navigate to Inventory ► VMs and Templates, select the Datacenter container and right click New Virtual Machine… to create a new VM.
Fig. A22: Select Custom configuration for the VM Fig. A23: Enter a meaningful name for the VM
Fig. A24: Select a cluster to run the VM Fig. A25: Choose the destination storage of the VM
Fig. A26: Select the Virtual Machine version Fig. A27: Choose the guest OS and specify the version (Normally the latest version should be selected) In this example the selection is Linux and Red Hat Enterprise Linux 6 (64-bit)
Fig. A28: Select 1 virtual socket and 1 CPU core Fig. A29: Select 512 MB for the memory size of the VM
Fig. A30: Configure 1 Network connection, choose the VMXNET 3 Adapter Fig. A31: Choose the VMware Paravirtual SCSI controller
Fig. A32: Select to create a new virtual disk Fig. A33: Set the disk size to 20GB and select Thindisk provisioning
Fig. A34: Keep default settings in disk advanced options Fig. A35: Click Finish to create the new VM
Mount a CentOS ISO image or insert a CentOS DVD in the host DVD device (Make sure that the VM's DVD device status is set to Connect at power on) and power on the VM.
The CentOS installer will launch. Proceed with installing CentOS 6.4 (64-bit)
Logon to CentOS after installation completes. Perform the following actions:
...
[root@localhost]# yum update
- Optionally, install and configure additional software packages, i.e.:
...
- Optionally, configure security settings such as iptables, Security Enhanced Linux, etc.
- Reboot the VM
- Unmount the CentOS DVD (Set the CD/DVD drive of the VM to Client Device)
- Install VMware Tools
- In vSphere Client, right-click on the VM and select Guest ► Install/Upgrade VMware Tools
- Logon to VM and install prerequisite packages and software: [root@localhost]# yum install perl gcc make –y
- Reboot the VM
- Mount the installer image: [root@localhost]# mount -t iso9660 /dev/cdrom /mnt
- Copy the installer files to a temporary location and run the installation script: [root@localhost]# cd /mnt [root@localhost]# cp VMwareTools-9.2.2-893683.tar.gz /tmp [root@localhost]# cd /tmp [root@localhost]# tar xzvf VMwareTools-9.2.2-893683.tar.gz [root@localhost]# cd vmware-tools-distrib/ [root@localhost]# ./vmware-install.pl Follow the instructions and provide default values unless otherwise required.
- Unmount CD/DVD [root@localhost]# umount /mnt
- Reboot the VM
- Navigate to /etc/sysconfig/network-scripts/ and edit the file ifcfg-eth0 Remove the line that contains the following parameter:
- HWADDR
- Remove the following files:
- 70-persistent-net.rules [root@localhost]# rm -rf /etc/udev/rules.d/70-persistent-net.rules
- SSH Keys [root@localhost]# rm -rf /etc/ssh/ssh_host_* http://support.microsoft.com/kb/2550978
- Shutdown the VM [root@localhost]# halt
- Right click the VM and select Template ► Convert to Template
APPENDIX B
Troubleshooting
Introduction
This section provides basic information that can help you troubleshoot issues with Interworks Cloud interworks.cloud OSS VMware vSphere Service Manager installation and configuration.
Basic troubleshooting
1. Make sure all Cloud OSS web applications (Cloud OSS Provisioning Portal, Cloud OSS Orchestration Server and Cloud OSS Service Managers) are of the same version.
2. Make sure all Cloud OSS components have been upgraded to the latest Cloud OSS release.
3. Make sure you are able to open all Cloud OSS web applications (Cloud OSS Provisioning Portal, Cloud OSS Orchestration Server and Cloud OSS Service Managers) URLs in web browser.
4. Make sure Cloud OSS Service Managers are able to manage the systems where they are deployed. Sign in to the provisioning portal, navigate to Configuration ► Servers, select a server, and then open Windows Services.
5. Those error messages can contain useful information for troubleshooting:
a. Error message (if exists) with stack trace from Cloud OSS Audit Log (Sign in to the provisioning portal, navigate to Account Home ► Audit Log).
b. Errors and warnings from Cloud OSS event log (WebSitePanel) in the Windows Event Viewer.
To increase level of the WebsitePanel event log you need to go to C:\Cloud360\Service Managers (or the directory where you installed Cloud OSS Service Manager components) end edit web.config file with notepad. Find the entry <add name="Log" value="1"/> and set the value to 3. After this change, please check that the WebsitePanel event log is set to "Override events as needed".
Note: | The most important information is usually derived from the first error or warning that appears in this log during error reproduction. |
Interworks interworks.cloud S.A.Interworks Cloud interworks.cloud OSS VMware vSphere® Service ManagerInstallation Guide