Provider's Guide to Integrating Parallels Presence Builder 12 with Parallels Automation

Transcription

1 Parallels Automation Provider's Guide to Integrating Parallels Presence Builder 12 with Parallels Automation Last updated: 23 January 2015 Copyright Parallels IP Holdings GmbH and its affiliates. All rights reserved.

2 Parallels IP Holdings GmbH Vordergasse Schaffhausen Switzerland Tel: Fax: Copyright Parallels IP Holdings GmbH and its affiliates. All rights reserved. Distribution of this work or derivative of this work in any form is prohibited unless prior written permission is obtained from the copyright holder. { Patented technology protected by U.S.Patents 7,328,225; 7,325,017; 7,293,033; 7,099,948; 7,076,633. Patents pending in the U.S.} Parallels and the Parallels logo are registered trademarks of Parallels IP Holdings GmbH in the United States and other countries. All other trademarks are the property of their respective owners.

3 Contents Preface... 4 Documentation Conventions... 4 Typographical Conventions... 4 General Conventions... 5 Feedback... 5 Introduction... 6 Integration Overview... 6 System Requirements... 7 Deploying Parallels Presence Builder for PA... 9 Licensing... 9 Pre-Deployment Actions... 9 Importing Parallels Presence Builder for PA Application Creating 'Parallels Presence Builder for PA' External Provisioning Attribute Adding Parallels Presence Builder for PA Specific Resource Types Selecting Hosts for Deployment Creating Instance of Parallels Presence Builder for PA Saving URL and Password of Installed Parallels Presence Builder for PA Preparing Parallels Presence Builder Service Template Pre-deployment Actions Importing Parallels Presence Builder Application Creating 'Hosting for Parallels Presence Builder Sites' Attribute Adding Specific Resource Types Creating Physical Hosting Resource Type for Linux Creating Physical Hosting Resource Type for Windows Preparing Service Template Known Limitations Common Operations Installing Package on Host Index... 22

4 C HAPTER 1 Preface This section contains introductory notes and important information about typographical conventions used in this document. In This Chapter Documentation Conventions... 4 Feedback... 5 Documentation Conventions Before you start using this guide, it is important to understand the documentation conventions used in it. Typographical Conventions Formatting convention Type of Information Example Special Bold Items you must select, such as menu options, command buttons, or items in a list. Titles of chapters, sections, and subsections. Go to the Resources tab. Refer to the Managing Your Account chapter. Italics Monospace Used to emphasize the importance of a point, to introduce a term or to designate a command line placeholder, which is to be replaced with a real name or value. The names of commands, files, and directories. Type a placeholder into the From field, ontact_ @ payflow.verisign.com CAPITALS Names of keys on the keyboard. SHIFT, CTRL, ALT KEY+KEY Key combinations for which the user must press and hold down one key and then press another. CTRL+P, ALT+F4

5 Preface General Conventions Be aware of the following conventions used in this book. Modules in this guide are divided into sections, which, in turn, are subdivided into subsections. For example, Documentation Conventions is a section, and General Conventions is a subsection. When following steps or using examples, be sure to type double-quotes ("), left single-quotes (`), and right single-quotes (') exactly as shown. The key referred to as RETURN is labeled ENTER on some keyboards. Commands in the directories included into the PATH variable are used without absolute path names. Steps that use commands in other, less common, directories show the absolute paths in the examples. Feedback If you have found a mistake in this guide, or if you have suggestions or ideas on how to improve this guide, please send your feedback to userdocs@parallels.com. Please include in your report the guide's title, chapter and section titles, and the fragment of text in which you have found an error. 5

6 C HAPTER 2 Introduction In This Chapter Integration Overview... 6 System Requirements... 7 Integration Overview Parallels Presence Builder for PA is а site creation and content management solution produced by Parallels. Parallels Presence Builder for PA provides unique capabilities for nontechnical users who want to create, publish, and maintain their web sites without any knowledge of HTML or other programming languages. The Parallels Presence Builder for PA website content management solution allows wide groups of users to create their websites with minimum efforts. Parallels Presence Builder 12 is integrated with POA using two APS packages: Parallels Presence Builder for PA - the main application that allows editing and publishing websites.

7 Introduction Parallels Presence Builder - the connector package that can be installed on a customer's domain to provide website publishing functionality. System Requirements General system requirements: POA 5.5 or later with APS and Linux Shared Hosting modules. POA 5.5 or later with APS and Windows Shared Hosting modules. Important: The Parallels Presence Builder version 12 will not work with POA versions earlier than 5.5. Parallels Presence Builder for PA system requirements: 10 gigabytes of free disk space. 1 gigabyte of RAM. Linux Shared Hosting or Linux Shared Hosting NG. Make sure that the Shared hosting PHP resource is included in the service template. MySQL 5.0 (or later) server. 7

8 Introduction Exclusive IPv4 address Important: Enable sw-engine support on the host where Parallels Presence Builder for PA Application will be installed. This package is required for the correct work of the application. Refer to the section Pre-Deployment Actions (page 9) for instructions. You can install Parallels Presence Builder for PA on any Linux Shared Hosting host (Legacy Apache Web Server, Web Server NG or Web Cluster NG). The Parallels Presence Builder package can be installed on (customers sites can be published to) any Linux or Windows Shared Hosting server with IIS 7.0 or 7.5. Make sure that POA websites can be resolved from the node on which Parallels Presence Builder for PA will be installed; and the node, where customer sites will be published. Firewall Requirements Make sure that the firewall is configured to allow the following connections. From To Protocol Ports Internet Server where Parallels Presence Builder for PA is installed TCP 80, 443 Server where Parallels Presence Builder for PA is installed Web servers for publishing customer sites Server where Parallels Presence Builder for PA is installed Server where Parallels Presence Builder for PA is installed Internet TCP 80, 443 Server where Parallels Presence Builder for PA is installed Server where the Presence Builder for PA database is hosted TCP 443 TCP 3306 ka.parallels.com TCP

9 C HAPTER 3 Deploying Parallels Presence Builder for PA In This Chapter Licensing... 9 Pre-Deployment Actions... 9 Importing Parallels Presence Builder for PA Application Creating 'Parallels Presence Builder for PA' External Provisioning Attribute Adding Parallels Presence Builder for PA Specific Resource Types Selecting Hosts for Deployment Creating Instance of Parallels Presence Builder for PA Saving URL and Password of Installed Parallels Presence Builder for PA Licensing License must be acquired and installed for every instance of Parallels Presence Builder for PA. There are two types of licensing: Unlimited license. The number of customer web sites is not limited. Usage statistics is collected using CSR tool. Provider is billed depending on actual usage. License for a limited number of web sites. The license and the respective activation code can be acquired from the Parallels sales team. The activation code must be specified in the settings of Parallels Presence Builder for PA Resource Type before installation. Pre-Deployment Actions Adjust PHP Settings on Web Server Important: It is recommended to create separate Apache Configuration for the needs of Parallels Presence Builder, as this configuration is specific and may not properly work for another purpose. PHP4 must be disabled on the web server, and default values of some PHP settings should be modified to allow proper functioning of Parallels Presence Builder for PA application.

10 Deploying Parallels Presence Builder for PA 1 In Provider's Control Panel, go to Services > Web Hosting and click Manage Configurations. 2 To select Apache Configuration for web server/cluster, that will host Parallels Presence Builder for PA, move to PHP Configuration tab and then click Edit. 3 Make sure that PHP as module value is set to Off. 4 Click Submit. 5 Go to the Resource Limits subtab. 6 Adjust the following PHP settings to recommended values: max_execution_time = memory_limit = 192M post_max_size = 2048M 7 Go to the Files Related subtab. 8 Adjust the following PHP setting to the recommended value: upload_max_filesize = 2048M Install the sw-engine Package on the Legacy Apache Shared Node 1 Connect via SSH to the node. 2 Create a new.repo file in the /etc/yum.repos.d/ directory. 3 Add a repo URL to that.repo file taken from this list - (if you are using CentOS x64 on the node). Otherwise, you should select a repository suitable for your architecture from the list here: 4 Use the yum repolist command to make sure that the repository you have added is available in the system. 5 Install the sw-engine package following the instructions in the section Installing a Package on the Host (page 20). Note: Due to package incompatibilities MySQL and sw-engine cannot be installed on the same host. Adjust PHP Settings on Legacy Apache Shared Node PHP4 must be disabled on the web server, and default values of some PHP settings should be modified in the php.ini configuration file to allow proper functioning of Parallels Presence Builder for PA application. 1 On the shared node go to /usr/lib64. 2 If there is no php.ini file in this location, create such file. 3 Adjust the following PHP settings to the file:

11 Deploying Parallels Presence Builder for PA max_execution_time = 600 memory_limit = 192M upload_max_filesize = 2048M post_max_size = 2048M Importing Parallels Presence Builder for PA Application To import the Parallels Presence Builder for PA Application to POA: 1 In POA Control Panel, go to Services > Applications. The list of the applications appears. 2 Click Import Package. 3 Specify the URL to Parallels Presence Builder for PA package. You can find out the URL to the latest version of the package at 4 Select the Enabled (available in subscriptions) checkbox. 5 Click Submit. Check that all tasks are finished successfully: go to Operations > Tasks and click Refresh (till task disappears). Check that new version of Parallels Presence Builder for PA is available: Services > Applications > Parallels Presence Builder for PA > Versions. Creating 'Parallels Presence Builder for PA' External Provisioning Attribute In POA, the Attributes mechanism allows pointing a host where a resource should be provisioned. An Attribute is a special label using which the Provider marks the resource (more precisely, Resource Type) to be provided. The same label is marked on the host, where this resource should be provisioned. To create an Attribute, follow these steps: 1 In Provider's Control Panel, go to Products > Resources and switch to the Attributes tab. 11

12 Deploying Parallels Presence Builder for PA 2 Click Add New Attribute. The adding new attribute window appears on the screen. 3 Enter Parallels Presence Builder for PA for the Attribute name and description. 4 Click Submit. Adding Parallels Presence Builder for PA Specific Resource Types For the detailed information on installing and configuring Parallels Presence Builder for PA, refer to the POA Application Hosting Deployment Guide, Deployment Scenarios: Shared Environment (Linux) section. To create a Resource Type: 1 In POA Control Panel, go to Products > Resources. The list of existing Resource Types opens. 2 Click on the Add New Resource Type button. The list of Resource Classes opens. 3 Select resource class, type resource name (see details below). 4 Assign provisioning attribute Parallels Presence Builder for PA. Below, we only describe in details resource classes to be selected and resource name. Create the following Resource Types: MySQL databases: Select 'Shared hosting MySQL databases' -> type name 'MySQL databases for PA for Web Presence. Diskspace: Select 'Diskspace' -> type name 'Diskspace for PA for Web Presence' Traffic: Select 'Traffic' -> type name 'Traffic for PA for Web Presence' Shared hosting PHP: 1 Select Shared hosting PHP. 2 Type the name 'Shared hosting Apache for PA for Web Presence'. Click Next. 3 Make sure that /usr/bin/php-cgi is selected in the Path to php binary list. Physical Hosting: 12

13 Deploying Parallels Presence Builder for PA 1 Select 'Shared hosting Apache'. 2 Type the name 'Physical hosting (Apache) for PA for Web Presence'. 3 In the Default Domain's Identifier menu, select the domain ID that you want to use. 4 Click Next. Parallels Presence Builder for PA Application: 1 Select 'Application'. 2 Type the name 'Parallels Presence Builder for PA'. Click Next. 3 Click 'Parallels Presence Builder for PA'. 4 Put a tick into the box next to Allow Account's SSL Certificate to enable it, select SSL enabled, HTTP entry points from the SSL protection menu. Note: The Show application in navigation menu option must be disabled for the Parallels Presence Builder for PA resource. Selecting Hosts for Deployment To assign a provisioning Attribute to a server, perform the following actions: 1 In POA Control Panel, go to Infrastructure > Service Nodes. The list of the service nodes registered in POA is displayed. 2 Click on the name of the server for Apache hosting or for MySQL hosting. 3 Go to the General tab > Attributes subtab. The list of the Attributes already assigned to the servers (if any) opens. 4 Click the Assign button. The list of existing Attributes opens. 5 Select the Attribute you have created for the APS Application - Parallels Presence Builder for PA. 6 Click the Submit button. Creating Instance of Parallels Presence Builder for PA To create an instance of Parallels Presence Builder for PA: 1 Open hosting panel (click Hosting CP link in the right top corner). 2 As the Hosting CP opens, select Applications > Install New Application > Parallels Presence Builder for PA. 3 Click Next 13

14 Deploying Parallels Presence Builder for PA 4 Click Finish. Return to POA Administrator Control Panel. Check that all tasks are finished successfully: go to Operations > Task Manager and click Refresh (till task disappears). To learn information on licensing and activation codes, refer to the Licensing section. Saving URL and Password of Installed Parallels Presence Builder for PA To get the URL and password of installed Parallels Presence Builder for PA: 1 Open hosting panel (click Hosting CP link in the right top corner). 2 To get the URL: select Applications > Install New Application > Parallels Presence Builder for PA. and then select the General tab. Copy the URL of Parallels Presence Builder for PA link at the bottom of the screen. 3 To get the password: select the Settings tab. The password is shown in the field Password to Parallels Presence Builder for PA. 14

15 C HAPTER 4 Preparing Parallels Presence Builder Service Template In This Chapter Pre-deployment Actions Importing Parallels Presence Builder Application Creating 'Hosting for Parallels Presence Builder Sites' Attribute Adding Specific Resource Types Preparing Service Template Pre-deployment Actions Prepare Legacy Apache Shared Node/Windows Shared Node After a website is created in Parallels Presence Builder, its content is to be published to one of POA web servers. You need to install ioncube Loader PHP extension on Apache Web Server/Windows Shared Node following the instructions from the Installing a Package on the Host section (page 20). Importing Parallels Presence Builder Application To import the Parallels Presence Builder Application to POA: 1 In POA Control Panel, go to Services > Applications. The list of the applications appears. 2 Click Import Package. 3 Specify the URL to Parallels Presence Builder package. You can find out the URL to the latest version of the package at 4 Select the Enabled (available in subscriptions) checkbox. 5 Click Submit.

16 Preparing Parallels Presence Builder Service Template Check that all tasks are finished successfully: go to Operations > Tasks and click Refresh (till task disappears). Check that new version of Parallels Presence Builder is available: Services > Applications > Parallels Presence Builder > Versions. Creating 'Hosting for Parallels Presence Builder Sites' Attribute To create an Attribute, follow these steps: 1 In Provider's Control Panel, go to Products > Resources and switch to the Attributes tab. 2 Click the Add New Attribute button. The adding new attribute window appears on the screen. 3 Enter Hosting for Parallels Presence Builder Sites for the Attribute name and description. 4 Click Submit. Adding Specific Resource Types The set of resource types needed for Parallels Presence Builder for Linux and for Windows has a common part described in this section. Physical Hosting resource types differ depending on the platform. To create a Resource Type: 1 In POA Control Panel, go to Products > Resources. The list of existing Resource Types opens. 2 Click on the Add New Resource Type button. The list of Resource Classes opens. 3 Select resource class, type resource name (see details below). 4 Assign provisioning attribute Hosting for Parallels Presence Builder Sites. Below, we only describe in details the resource classes to be selected, resource names, and additional resource configuration if such is needed. Create the following Resource Types: Parallels Presence Builder Application: 1 Select Site Applications. 2 Type 'Parallels Presence Builder Site Application'. 16

17 Preparing Parallels Presence Builder Service Template 3 Select 'Parallels Presence Builder'. 4 Click Next. 5 Enter URL and password to Parallels Presence Builder for PA saved before. ProFTPD: Select Shared hosting ProFTPD and type the name ProFTPD for Parallels Presence Builder sites. Shared Hosting Apache For Linux Shared Hosting you also need the Shared hosting PHP resource type. Select Shared hosting PHP: 1 Type the name 'Shared hosting for Parallels Presence Builder Sites'. Click Next. 2 Make sure that /usr/bin/php-cgi is selected in the Path to php binary list. Physical Hosting: Please follow the links to get instructions for different platforms about Physical Hosting Resource Types creation: For Linux For Windows Creating Physical Hosting Resource Type for Linux In this section we describe only resource class selection and further configuration of resource type. The common steps of resource type creation are described in the Adding Specific Resource Types section. To create the Physical Hosting Resource Type for Parallels Presence Builder for Linux: 1 Select Shared hosting Apache resource class. 2 Type name Physical hosting (Apache) for Presence Builder sites. 3 Click Next. 4 Select Default Domain's Identifier. Creating Physical Hosting Resource Type for Windows In this section we describe only resource class selection and further configuration of resource type. The common steps of resource type creation are described in the Adding Specific Resource Types section. 1 Select Shared hosting IIS. 17

18 Preparing Parallels Presence Builder Service Template 2 Type name Physical hosting (Windows) for Presence Builder sites. 3 Click Next. 4 Select PHP mode (FastCGI will be used in case of empty parameter) as Run only as a FastCGI application. 5 Select Default Domain's Identifier. 6 Select IIS version in the IIS version (IIS 6.0 will be used in case of empty parameter) drop-down list. It is strongly recommended to select IIS 7.0. Preparing Service Template To prepare service template with Parallels Presence Builder service: 1 Go to Products > Service Templates 2 Click Add New Service Template 3 Type the name, for example Hosting plan with Parallels Presence Builder Sites, check Autoprovisioning box, click Next. 4 To select resources, choose the corresponding check boxes next to resources names: Diskspace DNS hosting Select the Physical Hosting resource type Parallels Presence Builder sites, depending on the platform: Physical hosting (Apache) for Presence Builder sites for Linux platform Physical hosting (Windows) for Presence Builder sites for Windows platform Shared Hosting PHP ProFTPD for Parallels Presence Builder sites, Parallels Presence Builder Site Application, Traffic IP addresses - Optional, but needed to sell sites with exclusive IP addresses. Click Next. 5 Set limits for all resources. 6 Click Finish. 7 Activate the service template for Parallels Presence Builder. Go to Products > Service Templates, open your service template Hosting plan with Parallels Presence Builder Sites, and click Activate. 18

19 C HAPTER 5 Known Limitations Branding is not supported. Instead we propose the following: Provider creates Resource Type of Parallels Presence Builder for PA for reseller; Provider installs Parallels Presence Builder for PA for reseller; Provider creates Parallels Presence Builder Resource Type with proper Parallels Presence Builder for PA settings for Reseller. IPv6 is not supported in the following configurations: Parallels Presence Builder for PA on legacy Linux Shared Hosting on IPv6, Parallels Presence Builder on legacy Shared Hosting on IPv6 (for FTP or web site). Applying modified settings (especially URL of Parallels Presence Builder for PA instance) of Parallels Presence Builder Resource Type to existing instances does not imply migration of customer sites from one instance of Parallels Presence Builder for PA to another. Thus, such operation will potentially produce errors during Parallels Presence Builder application reconfiguration. Editing and publishing of web sites on wildcard domains is not supported. For large number of Parallels Presence Builder for PA Resource Types and instances under one subscription (e.g. Provider subscription) do not use 'Show application in navigation menu'. This can cause clutter in Provider's hosting Control Panel. For Parallels Presence Builder to work properly, Customer webspace must have PHP5 enabled by default. To avoid misconfiguration, one can disable PHP4 support in Service Templates with Parallels Presence Builder.

20 C HAPTER 6 Common Operations In This Chapter Installing Package on Host Installing Package on Host This section describes the following operations: Installing a package on the host. Use this operation to install single packages on one host. For example, to install a Service Controller on the Management Node. Installing a set of packages on the group of hosts. Use this operation to install a set of packages on the group of hosts at a time. For example, to install Control Panels on several UI Servers. Installing a Package on the Host To install a package on the host, perform the following steps: 1 In POA Control Panel, go to the target host (path in Control Panel depends on type of host): Hardware Node: Infrastructure > Service Nodes. VPS: Services > Cloud Infrastructure > VPSs. 2 Select the host you wish to install the package. 3 On the Packages tab, click Install Package. You will be offered, not yet installed. 4 Locate a required package from the list of available components and click appropriate Install package icon in the Actions column. The list of components that should be installed on the host is displayed. There are the following types of packages: Package has no editable properties. In that case, the following icon is displayed in the Actions column: Package has editable properties. Properties are pre-filled with default values that can be customized. In that case, the following icon is displayed in the Actions column:

21 Common Operations Package has editable properties. Properties should be defined prior to package installation. In that case, the following icon is displayed in the Actions column: 5 Click the or icon and specify package's properties. Note: This step is performed if a package has editable properties or properties that are mandatory to specify. 6 Click Finish. Important: Install POA Service Controller Package in the following way: go to Infrastructure and click Service Controllers under System Services. Click Install Service Controller and follow the installation Wizard. Note: To check whether a package is installed on the host, the following options are available: 1. Select the target host, switch to the Packages tab, and check whether the file is listed. 2. Use the Notification system. Notification system is described in the POA Provider's Guide, Monitoring System > Managing Notifications section. Installing Set of Packages on Group of Hosts To install a set of packages on the group of hosts, perform the following actions: 1 Specify mandatory properties of packages you wish to install. To do that: a In POA Control Panel, go to Infrastructure and click Packages Repository under Packages. b Select the package and click icon in the Actions area. c Specify the package properties and click Submit. Important: Execute these steps for every package that participates in the installation operation and has mandatory properties to be specified. 2 In POA Control Panel, go to Infrastructure and click PPM Group Operations under Packages. 3 Click the Create new PPM group operation link. 4 Select the Installation option from the Operation drop-down box and click Next. 5 Select all target hosts and click Next. 6 Select the packages to install and click Next. 7 Click Finish. Note: To check whether a package is installed on the host, the following options are available: 1. Select the target host, switch to the Packages tab, and check whether the file is listed. 2. Use the Notification system. Notification system is described in the POA Provider's Guide, Monitoring System > Managing Notifications section. 21

22 Index Index A Adding Parallels Presence Builder for PA Specific Resource Types - 12 Adding Specific Resource Types - 16 C Common Operations - 20 Creating 'Hosting for Parallels Presence Builder Sites' Attribute - 16 Creating Instance of Parallels Presence Builder for PA - 13 Creating 'Parallels Presence Builder for PA' External Provisioning Attribute - 11 Creating Physical Hosting Resource Type for Linux - 17 Creating Physical Hosting Resource Type for Windows - 17 D Deploying Parallels Presence Builder for PA - 9 Documentation Conventions - 4 F Feedback - 5 G General Conventions - 5 I Importing Parallels Presence Builder Application - 15 Importing Parallels Presence Builder for PA Application - 11 Installing Package on Host - 20 Integration Overview - 6 Introduction - 6 K Known Limitations - 19 L Licensing - 9 P Pre-deployment Actions - 15 Pre-Deployment Actions - 9 Preface - 4 Preparing Parallels Presence Builder Service Template - 15 Preparing Service Template - 18 S Saving URL and Password of Installed Parallels Presence Builder for PA - 14 Selecting Hosts for Deployment - 13 System Requirements - 7 T Typographical Conventions - 4