Product Documentation

Install Roles and Locations

Jun 05, 2015
Updated: 2014-10-10
Deploying the CloudPortal Services Manager (Services Manager) first comprises installing and configuring core components (server roles) and locations. The Setup Tool manages prerequisites and installs server roles. The Configuration Tool configures server roles and locations. Both tools offer a graphical wizard-driven interface and a command-line interface.

After you install the server roles, and configure the roles and locations, you install and configure the web services. See Installing Web Services for details.

Role installation and configuration summary

An initial server role deployment includes the following tasks:
  1. Perform environment readiness checks – You can verify the extended Active Directory schema and DNS aliases. This procedure is available in the graphical interface; you can also perform the verifications manually. You can run this task from anywhere in the domain.
  2. Create system databases - Microsoft SQL Server databases serve as repositories for user and service configurations in a Services Manager deployment. All databases should be backed up and synchronized daily.

    In the graphical interface, you specify database information before you install the server roles. In the command line interface, you specify database information when you configure the server roles and location.

    You run this task from the server where Microsoft SQL Server is installed.

  3. Install server roles - Web Server, Provisioning Engine, Directory Web Service, Data Warehouse, and Report Mailer.
  4. Configure server roles and locations – Specifies configuration settings for the installed roles, and settings for primary and remote locations.

    An XML configuration file is used to maintain context across the Services Manager deployment. As you configure the server roles, information is read and written to the configuration file. For example, the Provisioning Engine writes its own configuration information and reads where to reach the database. When you configure the primary location, the configuration file will already have information needed about the provisioning server.

    A location is the main unit of isolation between tenants, and usually corresponds to an Active Directory domain or forest. Customers are provisioned into a location. Configuring a server role makes that role operational, while configuring the location ties the components together and makes the system operational.

    There is one configuration file per location, although all locations can share a single database server. You configure the primary location first, then optionally, remote locations. For example, a new customer with an existing infrastructure and domain might be integrated as a remote location in the control panel. When you configure remote locations, you specify connection details, which are used to generate a new configuration file. After that, configuring a remote location is similar to configuring the primary location.

    You configure locations from the server hosting the Provisioning Engine or the Web Server.

Preparing to install and configure server roles

See System Requirements for Server Roles for supported platforms, required software, and preparation tasks.

Plan where you will install the server roles.
  • Typically, the Directory Web Service is installed on the same server as the Provisioning Engine.
  • Install Microsoft SQL Server (minimum SQL Server 2008 R2) and SQL Server Reporting Services on the server that you will configure as the main system (OLM) database. Typically, this is a separate server from the server on which you install other Services Manager roles. In larger deployments, you can install SQL Server Reporting Services on a separate server from the SQL Server database.
  • You can use a separate SQL server to host the reporting database (OLMReporting) and billing, or you can use the main system database for those functions. Using a separate reporting database avoids taxing the primary database, and is recommended for larger deployments.
  • For best practice, install the Web role on a separate server. This server will likely have enhanced security.

Whether you use the graphical interface or the command line to configure installed roles, review the information in the topic Configuring Server Roles and Locations from the Graphical Interface before you start the configuration. It describes the information you will need to provide.

Note: During configuration, you must specify license reporting information by configuring the Report Mailer.
General conventions:
  • You can specify server addresses as an IP address, in the form server.domain.local, by environment variables, or by DNS alias. In the graphical interface, you can check the aliases by selecting the Perform Readiness Checks task. If you use the command-line interface, verify the aliases before using them when installing Services Manager roles.
  • Role configuration includes specifying credentials for several Active Directory user accounts. In most cases, you can either specify the user name and password, or select the option that instructs the Configuration Tool to generate the credentials. This option is generally disabled by default. Some user account specifications also provide an option that instructs the Configuration Tool to create the user account if the account does not already exist. This option is generally enabled by default.
  • In the command line interface, enclose option values that contain spaces in quotation marks (for example, /LocationName:"Southeast Hub").