Parallels Plesk Automation

pathetictoucanMechanics

Nov 5, 2013 (3 years and 9 months ago)

152 views



Parallels
®

Plesk Automation










Contents

About This Document

4

Introduction

5

Preparing for the Move

7

1. Install the PPA Moving Tools

................................
................................
................................
....

8

2. Install Mail Sync Software (Windows Servers)

................................
................................
..........

9

3. Configuring Firewalls

................................
................................
................................
.................

9

Assimilation Scenario for Pan
el 10.x and Later

11

1. Configure the Tool

................................
................................
................................
...................

13

2. Generate a Transfer List

................................
................................
................................
.........

16

3. Import Resellers to PPA

................................
................................
................................
..........

17

4. Import Plans to PPA

................................
................................
................................
................

17

5. Associate Subscriptions with Plans

................................
................................
.........................

18

6. Check for Possible Conflicts

................................
................................
................................
....

20

7. (Optional) Create Reverse DNS Zones

................................
................................
...................

21

8. Run Assimilation

................................
................................
................................
......................

21

Transfer Scenario for Panel 8.6 and Later

24

1. Prepare Source Servers

................................
................................
................................
..........

26

2. Prepare Service Nodes

................................
................................
................................
...........

28

Register Service Nodes in PPA

................................
................................
........................

29

Check Disk Space on Service Nodes

................................
................................
...............

29

Install MySQL on IIS Web Server Nodes (Windows Servers)

................................
..........

29

Install Server Side Includes (Windows Servers)

................................
...............................

30

3. Import Resellers to PPA

................................
................................
................................
..........

30

4. Import Plans to PPA

................................
................................
................................
................

31

5. Configure the Tool

................................
................................
................................
...................

32

6. Generate a Transfer List

................................
................................
................................
.........

35

7. Associate Subscriptions with Plans

................................
................................
.........................

37

8. Check for Po
ssible Conflicts

................................
................................
................................
....

38

9. Run Transfer

................................
................................
................................
............................

39

10. Redirect DNS to the New Servers

................................
................................
.........................

39

11. Finalize the Synchronization of Content

................................
................................
................

39

12. (Optional) Create Reverse DNS Zones

................................
................................
.................

40

Transfer Scenario for Expand 2.3.3

41

1. Prepare Source Servers

................................
................................
................................
..........

43

2. Prepare Service Nodes

................................
................................
................................
...........

45

Register Service Nodes in PPA

................................
................................
........................

46

Check Disk Space on Ser
vice Nodes

................................
................................
...............

46

Install MySQL on IIS Web Server Nodes (Windows Servers)

................................
..........

47

Install Server Side Includes (Windows Servers)

................................
...............................

48



About This Document

3


3. Import Resellers to PPA

................................
................................
................................
..........

48

4. Import Plans to PPA

................................
................................
................................
................

49

5. Configure the Tool

................................
................................
................................
...................

51

6. Generate a Transfer List

................................
................................
................................
.........

55

7. Associate Subscriptions with Plans

................................
................................
.........................

57

8. Check for Possible Conflicts

................................
................................
................................
....

58

9. Run Transfer

................................
................................
................................
............................

59

10. (Optional) Create Reverse DNS Zones

................................
................................
.................

60

Transfer Scenario for H
-
Sphere 3.5 and Later

61

Prerequisites

................................
................................
................................
................................

63

1. Configure the Tool

................................
................................
................................
...................

63

2. Generate a Transfer List

................................
................................
................................
.........

66

3. Import Resellers to PPA

................................
................................
................................
..........

67

4. Associate Subscriptions from H
-
Sphere with Plans in PPA

................................
....................

68

5. Perform the Migration

................................
................................
................................
..............

69

6. Set Up DNS Forwarding

................................
................................
................................
..........

69

Transfer Scenario for PBAS

70

1. Prepare Service Nodes

................................
................................
................................
...........

73

2. Import Plans to PPA

................................
................................
................................
................

74

3. Connect PPA to PBAS

................................
................................
................................
............

74

4. Generate the Transfer Data and Configuration Files

................................
..............................

76

5. Configure the ppa
-
transfer Tool

................................
................................
..............................

78

6. Check for Possib
le Conflicts

................................
................................
................................
....

80

7. Install the rsync Software (Windows Servers)

................................
................................
.........

81

8. Install MySQL on IIS Web Server Nodes (Windows Servers)

................................
................

82

9. (Optional) Create Reverse DNS Zones

................................
................................
...................

82

10. Run Transfe
r

................................
................................
................................
..........................

83

11. Finalize Transfer

................................
................................
................................
....................

83

Troubleshooting

84

Known Issues and Limitations

................................
................................
................................
.....

84







This document describes how to move from a number of independent servers
controlled by some hosting panels to a multi
-
server environment controlled by Parallels
Plesk Automation (hereafter referred to as PPA). The document describes

two main
scenarios of performing the move, which typically depend on a hosting panel type used
on a server.

This document is intended for administrators who are considering moving their hosting
servers under the PPA control and are willing to gain all ben
efits of centralized server
management.

C
H A P T E R
1

About This Document





Currently, a large number of hosting providers use control panels like Parallels Plesk
Panel (hereafter referred to as Panel) as a means to manage web hostin
g on a
single
server
. Typically, such servers are administered separately, so server maintenance
costs grow with each new added server. To reduce the costs and simplify server
maintenance, we offer the providers to transform their existing infrastructure i
nto a
multi
-
server environment managed from a single web interface called Parallels Plesk
Automation (PPA).

PPA is a web hosting control panel where one central server (
management node
)
controls an arbitrary number of other servers with various roles
-

web
, mail, DNS, and
so on. In terms of PPA, these controlled servers are called
service nodes
. When a
customer subscribes to a web hosting plan, PPA allocates all the necessary resources
on service nodes and links these resources to the customer's account. Fo
r example,
when a customer subscribes to a shared web hosting plan, PPA creates a customer’s
webspace (virtual host) on one of the available web server nodes. If the subscription
also includes mail services, PPA creates the customer's mailboxes on one of t
he mail
server nodes.

Note:
This document assumes you already have a working PPA installation. For
information about how to install PPA, refer to the
Parallels Plesk Automation: Deployment
Guide
.

Moving Scenarios

There are two main scenarios of performing

the move to PPA:



Assimilating existing servers into PPA infrastructure (Panel 10.x and later only).

The assimilation scenario implies that you attach your independent Panel servers to
the PPA infrastructure. After assimilation, former Panel servers becom
e completely
integrated with PPA: They are converted to PPA service nodes. Main business
objects (service plans, customer and reseller accounts, and other) are transferred
from the servers to the PPA management node. Subscriptions remain intact on
assimila
ted servers.



Transferring hosting data from existing servers to PPA service nodes.


While assimilating implies that existing servers become fully functional PPA service
nodes, transferring assumes only copying of all hosting data (plans, customer
accounts,

and so on) to PPA. This way of switching to PPA assumes that you
already have working PPA environment with service nodes that can be used as a
replacement for your existing servers: During migration you do not add your existing
servers to PPA infrastructu
re but only transfer all hosting data to particular PPA
nodes. All business objects (service plans, customer and reseller accounts, and
other) are transferred from the servers to the PPA management node. All
subscriptions are relocated to registered PPA se
rvice nodes.

C
H A P T E R
2

Introduction


6

Introduction


Each of the scenarios has its own pros and cons and may suit better in a certain
situation. The details on the scenarios given in the table below will help you choose
your way of moving to PPA.


Assimilation scenario

Transfer scenario

Suppor
ted hosting panels

Panel 10.x and later

Panel 8.6 and later

Parallels Plesk Expand 2.3.3

Parallels Business Automation Standard
4.3.1
-
12 and later

Parallels H
-
Sphere 3.5 and later

Safety

Issues arising during servers
assimilation (for example, a hardware
failure) may lead to Panel inoperability
on existing servers.

Existing source servers are not affected by
transfer in any way. Even if a transfer is
unsuccessful, source servers continue
working.

Environment

Typically, requires only two servers in
addit
ion to the existing infrastructure:
PPA management node and mail
server node. All existing servers are
attached to PPA as web server nodes.


Requires a number of additional servers
registered as PPA service nodes. These
nodes are the destination for existi
ng
hosting subscriptions.

Performing the Move to PPA

Regardless of the scenario you choose, you should perform a number of common
preparation steps

(on page
7
). Once the steps are completed you can start either the
assimilation

(on p
age
11
) or data transfer process. The transfer scenarios differ
depending on the source platform:



Panel 8.6 and later

(on page
24
).



Parallels Business Automation Standard 4.3.1
-
12 and later

(on page
70
) (hereafter
referred to as PBAS).



Parallels Plesk Expand 2.3.3

(on page
41
) (hereafter referred to as Expand).



Parallels H
-
Sphere 3.5 and later

(on page
61
) (hereafter referred to as H
-
Sphere).









Regardless of the way you choose to move to PPA, you should perform the following
preparation steps before performing the move:

1.

Install the moving tools

(on page
8
).

In order to perform your move to PPA, you should use the set of tools available on
the Parallels website. These command
-
line tools can transfer hosting data from a
number of servers to the PPA management node and make the Panel servers
PPA
-
compatible (for
the assimilation scenario).

2.

Install mail sync software (Windows servers)

(on page
9
).

This step is required only if you perform the move from Windows
-
based Panel
servers. Without this software, the tools will be unable to transfer ma
il from such
servers.

3.

Open ports in firewalls

(on page
9
).

To ensure that the data transfer is possible, configure the firewalls on the source
and destination servers to allow connections on the necessary ports.

4.

Make sure that the ad
ministrative shares (admin$, c$, d$) exist on the source
servers. This step is required only if you perform the move from Windows
-
based
servers.


Once the preparation is finished, you can start one of the switching scenarios:
assimilating existing Panel se
rvers

(on page
11
) or
transferring hosting data to PPA

(on
page
24
).

In this chapter:

1. Install the PPA Moving Tools

................................
................................
.........

8

2. Install Mail Syn
c Software (Windows Servers)

................................
...............

9

3. Configuring Firewalls

................................
................................
.....................

9



C
H A P T E R
3

Preparing for the Move


8

Preparing for the Move


1. Install the PPA Moving Tools

The PPA moving tools consist of two files:
ppa
-
assimilate

and
ppa
-
transfer
. The
ppa
-
assimi
late
is responsible for the assimilation scenario: It makes assimilated Panel servers
PPA
-
compatible and transfers data from them to PPA. The
ppa
-
transfer

tool should be used
for the transfer scenario: This tool transfers hosting data from your servers to
PPA. We
strongly recommend that you install the tools on the management node. All further
instructions in this guide are given for the tools located on the management node.
Nevertheless, if needed, you may run the tools on any

server in your network that m
eets the
following requirements:



CentOS 5.x/6.x or Red Hat Enterprise Linux 5.x/6.x is installed on the server.



The server has the connection to your hosting servers and the PPA management node.



To install the tools on a server:

1.

Log in to your server as
r
oot
.

2.

Download the installation script:

wget
http://autoinstall.plesk.com/PPA_11.1.0/migration
-
tools/installer.sh

3.

Make
installer.sh

executable:

chmod +x installer.sh

4.

Insta
ll the tools by running the script:

./installer.sh

After you complete this step, the tools will be ready for operation.

Important:
The common preparation steps described in this chapter can be performed by
both tools. Therefore, all tools usage examples of

this chapter are given only for the ppa
-
assimilate tool. If you are going to transfer data instead of assimilating your servers, use the
same examples simply replacing the
ppa
-
assimilate

tool name with
ppa
-
transfer
.

If you already installed the tools and

only want to update them to the latest available version,
follow the instruction below.



To update the tools to the latest version:

1.

Log in to your server as
root
.

2.

Update the tools:

./installer.sh
--
upgrade




Preparing for the Move

9


2. Install Mail Sync Software (Windows
Servers)

Important:
This step is required if the mail server on your Panel for Windows supports IMAP.
By default, the support for IMAP is turned on in all versions of Panel for Windows starting
with Panel 9. If your use earlier Panel version or you intentionally tu
rned off the support for
IMAP, skip this step.

The PPA moving tools transfer mail services from Windows servers using the third
-
party
utility
imapsync
. Therefore, before assimilating Windows servers, you should install imapsync
on the same server with the
PPA moving tools.



To install imapsync on CentOS 5, use the PPA moving tools:

ppa
-
assimilate install
-
imapsync



To install imapsync on later versions of CentOS or on RHEL, follow the
instructions below:

1.

Install EPEL repository by running the following command
:

On 32
-
bit OSes:

rpm
-
ihv
http://dl.fedoraproject.org/pub/epel/5/i386/epel
-
release
-
5
-
4.noarch.rpm

On 64
-
bit OSes:

rpm
-
ihv
http://dl.fedoraproject.org/pub/epel/5/x86_64/epel
-
release
-
5
-
4.noarch.rpm

2.

Install imapsync from the EPEL repository:

yum install imapsync

3. Configuring Firewalls

If a source or destination server is behind a f
irewall, you need to properly configure the
firewall to allow the migration data exchange.

The following ports must be opened on the source servers.

Source platform

Services and ports

Linux
-
based servers running Plesk

SSH connections



TCP port 22

Plesk API



TCP port 8443


10

Preparing for the Move


Windows
-
based servers running Plesk

Files and Printers sharing



TCP ports: 135, 139, 445



UDP ports: 137, 138

Microsoft SQL server



TCP ports: 1433 (if using the default instance)



UDP ports: 1434



TCP ports: all, or manually selected (if using
a
named instance)

rsync



TCP ports: 873

Plesk API



TCP ports: 8443

POP3 and IMAP



TCP ports: 110, 143

Windows
-
based servers operating as
Plesk Expand centralized mail servers

Files and Printers sharing



TCP ports: 135, 139, 445



UDP ports: 137, 138

Plesk API



T
CP ports: 8443

POP3 and IMAP



TCP ports: 110, 143


Windows
-
based servers operating as
Plesk Expand centralized database
servers

Microsoft SQL Server



TCP ports: 1433 (if using the default instance)



UDP ports: 1434



TCP ports: all, or manually selected (if us
ing a
named instance)

MySQL



TCP ports: 3306






Assimilation Scenario for Panel 10.x and Later

11


The assimilation scenario implies that you attach your independent Panel servers to the PPA
infrastructure. After a
ssimilation, former Panel servers become a part of the multi
-
server
environment:



Attached servers are converted to PPA's service nodes. Parallels Plesk Panel is
completely removed from assimilated servers and can be no longer accessed.



Main business objec
ts (service plans, customer and reseller accounts, and other) are
transferred from the servers to the PPA management node. Former Panel service plans
become available for subscribing in PPA. Hosting subscriptions remain intact on the
servers and continue t
o work as is.

Each added Panel server becomes a

web server node
. This means that, after attaching, a
part of server functions is delegated to other PPA nodes. In more details:



Web hosting and database services continue to work on the node.



Mail services ar
e relocated to a mail node registered in PPA: This mail node becomes
responsible for mail delivery.



DNS services are relocated to DNS servers registered in PPA: They store all DNS zones
of the attached node.

After attaching, Panel's DNS server starts to fo
rward all requests to a PPA's master DNS
server. This allows keeping all existing NS records on a registrar's DNS server as is. See
the picture below.

Note:
PPA does not automatically create reverse DNS zones. Creating these zones in
PPA is one of the step
s that prepare servers for assimilation.


C
H A P T E R
4

Assimilation Scenario for Panel 10.x and
Later


12

Assimilation Scenario for Panel 10.x and Later


Important:
IP pools are not transferred to PPA. Existing IP addresses on Panel servers are
registered in PPA and are marked as used. Thus, if you want to
get a pool of free IP
addresses available on a certain attached server, you should register it manually once the
assimilation is finished.

Performing the Assimilation

The assimilation of Panel servers is performed by the
ppa
-
assimilation
tool and consists
of a
number of steps:

1.

Configure the ppa
-
assimilation tool

(on page
13
).

The tool is configured with the help of a configuration file. This defines various
communication parameters like server IP addresses, the administrator's credenti
als, and
so on.

2.

Create a transfer list

(on page
16
).

A transfer list is a file that specifies what objects (plans, reseller accounts, and
subscriptions) should be transferred to PPA from assimilated servers.

3.

Import resellers to PPA

(o
n page
17
).

The ppa
-
assimilate tool does not fully automate the transfer of resellers to PPA: It
automatically transfers reseller accounts while the corresponding reseller plans should be
created in PPA manually.

4.

Import plans (templat
es) to PPA

(on page
17
).

Service plans are not automatically transferred to PPA during assimilation. Therefore,
you should either create your plans in PPA manually or use the ppa
-
assimilate tool for
this purpose.

5.

Associate subscripti
ons and plans

(on page
18
).

Associate subscriptions with certain imported plans.

6.

Check for possible conflicts and limitations

(on page
20
).

Before moving to PPA, it is strongly recommended that you perform a pre
liminary check
for possible transfer conflicts. For example, two different service plans on different Panels
may have the same name. Based on the check results, the tool generates a report with
all found conflicts.

7.

(Optional) Create reverse DNS zones

(on p
age
21
)

As PPA does not automatically create reverse DNS zones for used IP network
addresses, this should be done manually.

8.

Run the assimilation.

Once all preparation steps are completed, you can run the assimilation.

In this chapter:

1. Configure the Tool

................................
................................
.........................

13

2. Generate a Transfer List

................................
................................
................

16

3. Import Resellers to PPA

................................
................................
................

17

4. Import Plans to PPA

................................
................................
......................

17

5. Associate Subscriptions with Plans

................................
................................

18

6. Check for Possible Conflicts

................................
................................
..........

20

7. (Option
al) Create Reverse DNS Zones

................................
..........................

21

8. Run Assimilation

................................
................................
............................

21



Assimilation Scenario for Panel 10.x and Later

13




1. Configure the Tool

Since the ppa
-
assimilate tool communicates with a number of servers, you should provide it
with server I
P addresses, administrators' credentials, and other information. The tool is
configured with the help of the
config.ini

file, which is not created by default. For your
convenience, the directory
/etc/ppa
-
migrator/

contains the
config.ini.plesks.template

fi
le which you can use as a basis for creating your own
config.ini
.

To configure the tool:

1.

Create the
config.ini

file based on the template. For example:

cp /etc/ppa
-
migrator/config.ini.plesks.template config.ini

2.

Edit the
config.ini

file to configure the too
l. The description of file sections is provided
below.

The Structure of the Configuration File

The
config.ini

file consists of several sections of two types:



Predefined
. These sections contain information about your PPA management node and
various aspects

of data transfer. The names of the sections
[GLOBAL]

and
[ppa]

are
predefined by the tool and you should not change them.



Custom
. These sections contain information about your existing servers. You can use
arbitrary names for such sections. For example,
[
plesk1]
,
[plesk2]
, and so on.


An Example of the Configuration File

Let us take a look at the example of the
config.ini

file. In this example, we are going to
assimilate three Panel servers (two on Linux and one on Windows).

[GLOBAL]

# Here go custom se
ction definitions. Each section in sources is
responsible for one Panel server.

# Order is important: Place ahead those servers which you want to get the
priority during conflict resolution.

source
-
plesks: plesk1, plesk2, plesk3

# The source
-
type defines

the type of the attached server (plesk in case if
you attach Panel server)

source
-
type: plesk

# Directory for temporary files

session
-
dir: migration
-
session


# This is the time in seconds, which the tool sets as the SOA minimum TTL
and refresh interval on

a new DNS server. On this step you can leave the
default value. Learn more about this parameter in the section Run
Assimilation.


14

Assimilation Scenario for Panel 10.x and Later


zones
-
ttl: 120

[ppa]

# IP address of the PPA management node

ip: 192.168.0.1


# PPA administrator credentials

panel
-
username:
admin

panel
-
password: setup


# root system user credentials (on the PPA management node)

ssh
-
username: root

# The tool supports two types of ssh authentication: password
-
based and
key
-
based.

# If you want to authenticate by password, uncomment the followin
g two
lines and specify the password.

# ssh
-
auth
-
type: password

# ssh
-
password:

# If you want to use key
-
based authentication, uncomment the following two
lines, and specify the correct path to the SSH key. Note that passphrase
-
protected SSH keys are not s
upported.

# ssh
-
auth
-
type: key

# ssh
-
key:


# Please list the section names of external PostgreSQL servers to be
migrated.

external
-
db
-
servers: pg1

# A directory on PPA management node and all target Unix service nodes for
temporary files. If not specified,

temporary files are put into /tmp.

unix
-
session
-
dir: /tmp

# A directory on PPA target Windows service nodes for temporary files. If
not specified, temporary files are put into C:
\
migrator.

windows
-
session
-
dir: C:
\
migrator

[plesk1]

# Here go connection par
ameters for the first Panel server (Linux
-
based)

ip: 192.168.0.100

os: unix

panel
-
username: admin

panel
-
password: setup

ssh
-
username: root

ssh
-
auth
-
type: password

ssh
-
password:


# The tool supports two types of ssh authentication: password
-
based and
key
-
ba
sed.

# If you want to authenticate by password, uncomment the following two
lines and specify the password.

# ssh
-
auth
-
type: password

# ssh
-
password:

# If you want to use key
-
based authentication, uncomment the following two
lines, and specify the correct
path to the SSH key. Note that passphrase
-
protected SSH keys are not supported.

# ssh
-
auth
-
type: key

# ssh
-
key:


# This parameter specifies whether to copy mail content from the server
(the 'full' value) or not ('none').

# By default (if the line is commen
ted out or removed), mail content is
copied.

copy
-
mail
-
content: full



Assimilation Scenario for Panel 10.x and Later

15


# A directory for temporary files. If not specified, temporary files are
put into /tmp.

session
-
dir: /tmp

[plesk2]

# Here go connection parameters for the second Panel server (Linux
-
based
)

ip: 192.168.0.101

os: unix

panel
-
username: admin

panel
-
password:

ssh
-
username: root

ssh
-
auth
-
type: key

ssh
-
key: /root/.ssh/id_rsa

session
-
dir: /root/migrator


[pg1]

# Here go connection parameters for external PostgreSQL database server

# 'host' must b
e exactly the same as you see the database server in Plesk
Panel (usually it is the same as server IP)

host: 192.168.0.107

ip: 192.168.0.107

ssh
-
username: root

ssh
-
auth
-
type: password

ssh
-
password:


[plesk3]

# Here go connection parameters for the third P
anel server (Windows
-
based)

ip: 192.168.0.102

os: windows

panel
-
username: admin

panel
-
password:

windows
-
username: Administrator

windows
-
password:


# no ssh credentials for os windows, and will be ignored if specified

# Define the following two parameters
if your source IMAP server does not
support the NAMESPACE extension.

# Otherwise, comment out these lines.

# If your source IMAP server is MailEnable or SmarterMail, leave the
default values for these parameters.

mailbox
-
name
-
separator: /

mailbox
-
name
-
pref
ix:


# This parameter specifies what mail content should be copied from the
server:

# 'full' to copy all mail content, 'messages' to copy only messages from
the Inbox folders, and 'none' to skip copying.

# By default (if the line is commented out or remove
d), all mail content is
copied.

# Note that if the server does not support IMAP, it is possible to copy
only Inbox messages using the 'messages' option.

copy
-
mail
-
content: full

# A directory for temporary files. If not specified temporary files are put
int
o C:
\
migrator.

# For MySQL database content to be copied, session directory should be
configured in rsync server as "migrator".

session
-
dir: C:
\
migrator




16

Assimilation Scenario for Panel 10.x and Later


2. Generate a Transfer List

A
transfer list

defines the list of objects (plans, reseller accounts, an
d subscriptions) that
should be transferred from assimilated Panels to PPA. The transfer list file can be
automatically generated by the ppa
-
assimilate tool. By default, after the generation, it
contains all objects that are present on assimilated servers
(see the example below).



To generate the transfer list, run the following command:

# ppa
-
assimilate generate
-
migration
-
list config.ini

After you run the command, the tool will create the
migration
-
list

file in the session
directory defined in your
config
.ini
. You will need this file during further assimilation
steps.

Transfer List Structure

After generation, the list contains all service plans, subscriptions, and reseller accounts that
exist on assimilated Panels. In addition, the file contains plans and

reseller accounts that
exist in PPA. The corresponding lines are marked with the comment
# exists in PPA
.

The list consists from a number of sections
-

one section per each reseller (for example,
[Reseller1]
). Each section consists from a number of subsec
tions
-

one subsection per
each service plan (for example,
(Gold Hosting)
). Each plan subsection contains the list
of subscriptions to that plan. Note that your hosting plans are not grouped under a certain
section: They go in the beginning of the file bef
ore the reseller sections. The tool
automatically determines association between plans and subscriptions. Thus, each plan
subsection contains the list of associated subscriptions. As custom subscriptions are not
associated with a certain plan, they are pla
ced outside of plan sections.

An Example of the List

# Subscriptions to provider's hosting plans

# Custom subscriptions

# These subscriptions should be moved to a section of a certain service
plan. Otherwise, the tool will not start assimilation.

admins
-
s
ubscription1.tld

admins
-
subscription2.tld


(Gold hosting)

customer1
-
subscription1.tld # customer1 (Bob Smith)

(Silver hosting)

customer1
-
subscription2.tld # customer1 (Bob Smith)

customer2
-
subscription1.tld # customer2 (Jack Smith)

customer2
-
subscription2
.tld # customer2 (Jack Smith)

(PPA shared hosting) # exists in PPA


# Subscriptions to resellers' hosting plans

[Reseller1] # John Smith

(Unlimited)

reseller1
-
subscription1.tld



Assimilation Scenar
io for Panel 10.x and Later

17


reseller1
-
subscription2.tld

reseller1
-
customer1
-
subscription1.tld # reseller1
-
c
ustomer1 (John Doe)


(Plan 1)

reseller1
-
customer2
-
subscription1.tld # reseller1
-
customer2 (Bob Doe)


[Reseller2] # Tom Smith

(Plan 1)

reseller2
-
customer1
-
subscription1.tld # reseller2
-
customer1 (Kate Doe)

3. Import Resellers to PPA

The ppa
-
assimilate tool
has the following limitation: It allows you to transfer reseller accounts
to PPA but it does not automatically transfer reseller plans. Therefore, to seamlessly import
existing reseller accounts from your Panel servers, you should first manually create res
eller
plans in PPA that correspond to the ones on your Panel servers, and subscribe the resellers
to these plans after the transfer. See the detailed instructions below.



To import resellers to PPA:

1.

Create reseller plans (templates) in PPA that correspond
to reseller plans on your Panel
servers.

If you use PPA with the Billing Panel, learn how to do this in the
Parallels Plesk Automation:
Operations Guide
, section

Employing Resellers Though the Billing Panel
.

If you use PPA without the Billing Panel, learn

how to do this in the
Parallels Plesk
Automation: Operations Guide
, section

Creating Reseller Service Templates
.

2.

Edit the transfer list file
migration
-
list

(located in your session directory) to exclude
reseller accounts that you do not want to transfer t
o PPA. To exclude a certain account
from transfer, comment out or delete the corresponding line from the list.

3.

Perform the transfer of reseller accounts to the PPA management node by running the
command:

# ppa
-
assimilate import
-
resellers config.ini

All res
ellers that exist on your Panel servers will be transferred to PPA.

4.

Subscribe the transferred resellers to the newly created reseller plans.

If you use PPA with the Billing Panel, learn how to do this in the
Parallels Plesk Automation:
Operations Guide
,
section

Employing Resellers Though the Billing Panel
.

If you use PPA without the Billing Panel, learn how to do this in the
Parallels Plesk
Automation: Operations Guide
, section

Subscribing Resellers to Templates
.



4. Import Plans to PPA

Service plans are

not automatically transferred to PPA during assimilation. Therefore, you
should either create your plans in PPA manually or use the ppa
-
assimilate tool for this
purpose. The second option is available only for PPA with the Billing Panel.



18

Assimilation Scenario for Panel 10.x and Later




To manually imp
ort plans to PPA:

1.

Create shared hosting plans (templates) in PPA that correspond to hosting plans on your
Panel servers.

If you use PPA with the Billing Panel, learn how to do this in the
Parallels Plesk Automation:
Operations Guide
, section

Serving Custom
ers Through the Billing Panel
.

If you use PPA without the Billing Panel, learn how to do this in the
Parallels Plesk
Automation: Operations Guide
, section

Creating Shared Hosting Templates
.

2.

Assign provisioning attributes to the plans.

The provisioning attr
ibute is a tag that links a plan and nodes on which the services
included into the plan can be set up. Learn more about attributes in the
Parallels Plesk
Automation: Operations Guide
, chapter

Setting Up Your Business Offer
.

Each Panel subscription includes

the support for a number of services, such as web
hosting, mail services, and database services. The only service that is relocated to other
PPA nodes from the assimilated server is the mail service. Therefore, it is essential to set
a provisioning attrib
ute at least to the mail service. Otherwise, PPA will be unable to
determine on which node it should relocate mail services from assimilated subscriptions.
If you use PPA with the Billing Panel, you can assign an attribute to the mail service in
the Billin
g Panel >

Plans
> select a plan

>

Change Settings
> the
Postfix Mail
section. If you
do not use billing automation, you can assign an attribute in the Administration Panel >
Products
>
Service Templates

> select a template >
Resources
>

Postfix Mail
>

Prov
isioning
Attributes
.

Other services (web hosting and database service) remain intact on the attached server.
Therefore you could leave these services without any attributes. Though note that in this
case the imported plans will be unavailable for further s
ubscribing.



To import plans to PPA using the ppa
-
assimilate tool (only for PPA with the
Billing Panel):

1.

Edit the transfer list file to exclude plans that you do not want to transfer to PPA. To
exclude a certain plan from transfer, comment out or delete the

corresponding line from
the list.

2.

Copy hosting plans to PPA by running the following command:

ppa
-
assimilate config.ini import
-
plans

The plans will appear in the Billing Panel >
Plans
. If you do not use billing automation, you
can view the list of added p
lans (templates) in the Administration Panel >
Products
>
Service Templates
.

3.

Assign provisioning attributes to the plans.


5. Associate Subscriptions with Plans

Before assimilating your servers, you should associate subscriptions that exist on your Panel
servers with certain service plans you have imported to PPA on the previous step. This is
done by adjusting the transfer list file.



Assimilation Scenario for Panel 10.x and Later

19


Typically, all subscriptions in Panel are associated with certain plans (these associations are
automatically reflected in t
he file). The only exceptions are custom subscriptions
-

subscriptions that are not the instances of certain service plans. As PPA does not support
custom subscriptions, it is necessary that you associate them with certain plans.



To associate subscriptions

with certain service plans, edit the transfer list file.

The association is performed by placing the corresponding subscription line under a certain
plan section.

Note that the tool will not start assimilation until there are subscriptions which are not
a
ssociated with plans. If you do not want to associate certain subscriptions with plans,
comment out the corresponding lines or delete them.

For example, to associate the custom subscription
admins
-
subscription.tld

with the
Gold hosting

plan move the corres
ponding line under the plan section.

Before

After

# Custom subscriptions

admins
-
subscription.tld


(Gold hosting)

customer1
-
subscription1.tld


(Silver hosting)

# Custom subscriptions


(Gold hosting)

customer1
-
subscription1.tld

admins
-
subscription.tld


(S
ilver hosting)




20

Assimilation Scenario for Panel 10.x and Later


6. Check for Possible Conflicts

Before performing assimilation, we strongly recommend that you perform the preliminary
check for possible conflicts that can cause issues during the data transfer process or even
make switching to PPA impos
sible. Such check is performed by the ppa
-
assimilate tool and
includes a number of checks concerning various aspects of hosting panels functionality.
Below we describe the most important checks that may require your attention:



Check for customer / reseller

accounts with the same e
-
mails and contact names.

There are three account parameters that the tools use to identify an account: username,
e
-
mail, and contact name. Let us look closer at the system behavior when these
parameters match for different account
s:



Usernames, e
-
mails, and contact names are the same
.

The system considers such accounts to represent the same person or company: Only
one of them will be transferred to PPA. The priority is given to the account from the
panel that is listed first in the

sources

string of
config.ini
. Accounts from other
panels are ignored: Their subscriptions are also registered in PPA, but these
subscriptions become associated with the customer / reseller account which had the
priority during the transfer. If you want ea
ch of such accounts to be transferred to
PPA, specify another e
-
mail and username for conflicting accounts.



Usernames and contact names are the same, e
-
mails are different
.

The move to PPA will be impossible until you specify another username for conflict
ing
accounts.



Usernames and e
-
mails are the same, contact names are different
.

The move to PPA will be impossible until you specify the same contact names (if
these are the same persons) for conflicting accounts.



E
-
mails are the same, usernames and contac
t names are different
.

The move to PPA will be impossible until you specify another e
-
mails for conflicting
accounts.



Check for the Panel license key
.

If you are going to assimilate Panel servers by PPA, the tools will check whether the
license keys that
come with your Panels can be used with PPA. If this is impossible, you
should upgrade existing license keys to the ones compatible with PPA.



To perform the preliminary check:

$ ppa
-
assimilate check config.ini


Based on the check results, the tool generate
s a report. The report contains messages of
two types:



WARNING. These messages warn you about the potential issues that may affect your
further work in PPA but are not critical for the assimilation process.



ERROR. These messages appear when a certain confl
ict blocks the assimilation.

You should resolve all issues marked as ERROR before performing the assimilation.




Assimilation Scenario for Panel 10.x and Later

21


7. (Optional) Create Reverse DNS Zones

A reverse DNS lookup process (when a client looks up a computer name based on its
address) is essential t
o a large number of Internet services. The processing of reverse
requests is based on reverse DNS zones that store the information about IP addresses and
corresponding domain names.

The DNS service in PPA has one limitation: PPA does not automatically cre
ate reverse DNS
zones for the registered IP network addresses. Therefore, one of the first steps of moving to
PPA should be the creation of reverse DNS zones for your IP network addresses. Reverse
DNS zones are created in the Administration Panel >
Operati
ons
>

DNS Manager
>

Reverse DNS
Zones
. Note that PTR records in these zones are automatically created by PPA.

Before proceeding to servers assimilation, you should create the following reverse DNS
zones for certain IP network addresses:

1.

Reverse DNS zones
for the IP network addresses of your existing Panel servers.

2.

Reverse DNS zones for the IP network addresses of your mail service node.

8. Run Assimilation

Once you are done with all preparation steps, you can start the assimilation of your servers
by PPA
. This operation requires some pre
-
planning. The reason is that mail services are
relocated to other nodes: Since an IP address of a mail server changes, there may be a
period of time when all mail is sent not to a PPA mail node (new location of the mail s
ervice)
but to a Panel mail server (old location of the mail service). In a worst
-
case scenario, this
time is equal to the sum of the TTL of an MX record and the SOA refresh interval. This may
happen when a secondary DNS server got the MX record right befo
re the zone change and a
mail client got the record from the secondary server right before the end of the refresh
interval. See the timeline diagram below.



22

Assimilation Scenario for Panel 10.x and Later


To minimize the DNS propagation time, w
e recommend that you follow the sequences
described in this section. There are two typical scenarios of assimilating Panel servers
depending on a DNS service mode:



The Panel DNS server is used as a primary DNS server

for domains in Panel.



An external DNS s
erver is used as a primary DNS server

for domains in Panel. The
Panel DNS server is either switched off or is used as a secondary DNS server for
domains in Panel.

Note:
If assimilated Panel servers contain both domains which zones are served by the
Panel D
NS server and an external DNS server, use the combination of the sequences
described below. The tool should be run only once.

Attaching Servers with the DNS Service in the Primary Mode

1.

Lower records' TTL and refresh interval on your Panel servers. This wil
l let you minimize
the time of new DNS records propagation. You can do this by running the command:

ppa
-
assimilate set
-
low
-
dns
-
timings config.ini

This command sets TTL and refresh time using the value of the
zones
-
ttl

parameter
from the
config.ini

file. We

recommend that you use the default value (120 seconds).

2.

Run the assimilation:

ppa
-
assimilate assimilate config.ini

The tool during its work converts Panel servers to PPA service nodes and performs
transfer of Panel objects and mail content. Note that as
the transfer of Panel objects may
require significant time, the
assimilate

command does not switch DNS forwarding on.

3.

Ensure that the period of time which is equal to the sum of
old values of TTL and SOA
refresh interval

has passed since you ran the tool.
This guarantees that all mail clients
have gotten a new TTL value before you switch DNS forwarding on.

4.

Turn on DNS forwarding:

ppa
-
assimilate set
-
dns
-
forwarding config.ini

5.

Ensure that the period of time which is equal to the sum of
new values of TTL and SO
A
refresh interval

(that you set up on the step 1) has left after you switched forwarding. This
guarantees that all clients have gotten a new address of your mail server.

6.

Restore the original values of TTL and SOA refresh interval:

ppa
-
assimilate restore
-
d
ns
-
timings config.ini

7.

Copy all mail messages from the Panel server that were sent during the assimilation:

ppa
-
assimilate sync
-
mail
-
content config.ini

8.

Remove the Panel software from the assimilated servers:

ppa
-
assimilate uninstall
-
obsolete
-
plesk
-
component
s config.ini

Note that this operation is irreversible. On this step, the tool removes all Panel
components and system databases.

Attaching Servers with the DNS Service in the Secondary/Switched
-
Off Mode

1.

Update MX records on your external primary DNS server

with a new location of mail
services.



Assimilation Scenario for Panel 10.x and Later

23


Note:
Once all DNS records are located on an external DNS server, you do not need the
delay set by the
zones
-
ttl

parameter. If you are sure that there are no domains in
Panel served by the Panel DNS server, you can l
eave the default value of
zones
-
ttl
.

2.

Run the assimilation:

ppa
-
assimilate assimilate config.ini

3.

Wait for the period of time which is equal to the sum of TTL and SOA refresh interval.
This guarantees that all mail clients will get a new IP address of the m
ail server.

4.

Copy all mail messages from the Panel server that were sent during the assimilation:

ppa
-
assimilate sync
-
mail
-
content config.ini

5.

Remove the Panel software from the assimilated servers:

ppa
-
assimilate uninstall
-
obsolete
-
plesk
-
components config.
ini

Note that this operation is irreversible. On this step, the tool removes all Panel
components and system databases.













Transferring hosting data is the only
option of switching to PPA from Panel versions
earlier than 10. This way of switching to PPA assumes that you already have a working
PPA environment with service nodes that can be used as a replacement for your
existing servers: All hosting data are transf
erred to particular PPA nodes. Thus, all
business objects such as plans, customer and reseller accounts are transferred to the
PPA management node. Subscriptions from your existing servers are transferred to
certain service nodes. One of the benefits of th
e transfer scenario is that your existing
hosting servers remain intact: Even if something goes wrong during the transfer, your
existing environment remains fully operable.

Performing the Data Transfer

The process of transferring hosting data is performed
by the
ppa
-
transfer
tool and
consists of a number of steps:

1.

Prepare source servers.

2.

Prepare service nodes in PPA

(on page
28
).

Before performing the data transfer, you should register service nodes with roles
corresponding to your exi
sting servers and install the required software on these
nodes.

3.

Import resellers to PPA

(on page
30
).

The ppa
-
transfer tool does not fully automate the transfer of resellers to PPA : It
automatically transfers reseller accounts while
the corresponding reseller plans
should be created in PPA manually.

4.

Import plans (templates) to PPA

(on page
31
).

Service plans are not automatically registered in PPA during transfer. Therefore,
you should either create your plans in

PPA manually or use the ppa
-
transfer tool for
this purpose.

5.

Configure the ppa
-
transfer tool

(on page
13
).

The tool is configured with the help of a configuration file. It defines various
communication parameters like server IP addre
sses, the administrator's
credentials, and so on.

6.

Create a transfer list

(on page
35
).

A transfer list is a file that specifies what objects (plans, reseller accounts, and
subscriptions) should be transferred to PPA from source server
s.

7.

Associate subscriptions and plans

(on page
37
).

Associate subscriptions with certain imported plans.

8.

Check for possible conflicts and limitations

(on page
38
).

Before moving to PPA, it is strongly recommended
that you perform a preliminary
check for possible transfer conflicts. For example, two different service plans on
different Panels may have the same name. Based on the check results, the tool
generates a report with all found conflicts.

C
H A P T E R
5

Transfer Scenario for Panel 8.6 and Later



Transfer Scenario for Panel 8.6 and Later

25


9.

Run the transfer pr
ocess

(on page
39
).

Once all preparation steps are completed, you can run the transfer. On this step,
the tool transfers all subscriptions from your existing servers to registered PPA
service nodes.

10.

Redirect DNS to the new servers

(on

page
39
).

After DNS services are relocated to PPA, you need to update all your NS records
on the registrar's DNS servers with the IP address of your PPA DNS server.

11.

Finalize the synchronization of content

(on page
39
).

Ensure that any changes to the content made by your customers during the transfer
process are transferred as well.

12.

(Optional) Create reverse DNS zones

(on page
40
).

As PPA does not automatically create reverse DNS zones for us
ed IP network
addresses, this should be done manually.


In this chapter:

1. Prepare Source Servers

................................
................................
................

26

2. Prepare Service Nodes

................................
................................
.................

28

3. I
mport Resellers to PPA

................................
................................
................

30

4. Import Plans to PPA

................................
................................
......................

31

5. Configure the Tool

................................
................................
.........................

32

6. Generate a Transfer List

................................
................................
................

35

7. Associate Subscriptions with Plans

................................
...............................

37

8. Check for Possible Conflicts

................................
................................
..........

38

9. Run Transfer

................................
................................
................................
.

39

10. Redirect DNS to the New Servers

................................
...............................

39

11. Finalize the Synchronization of Content
................................
.......................

39

12. (Optional) Create Reverse DNS Zones

................................
.......................

40




26

Transfer Scenario for Panel 8.6
and Later


1. Prepare Source Servers

The preparation of source servers for transfer consists of two main steps: checking that
the source servers meet the transfer requirements and installing the rsync software
(only for Windows servers).

Prelimi
nary Checking

Before you start the transfer, perform the following checks on your Parallels Plesk
Panel source servers:

1.

Make sure that your source servers are capable of working as slave DNS servers.
To check this, you can:

1.

Create a sample domain on your s
ource server.

2.

Select the source server's DNS server as the slave DNS server for the domain's
zone.

3.

Ensure that changes in the zone are successfully propagated from the master
DNS server to your slave DNS server.

2.

Make sure your source servers meet the follo
wing disk space requirements:



At least 1 GB of free disk space.



Additional free disk space for storing dumps of user databases. A dump may be
several times larger in size than the original database.

Installing the rsync Software (Windows Servers)

To trans
fer data from Windows
-
based servers, you need to install the rsync software
on them.



To install and configure the rsync software on the source servers:

1.

Download the installation file
cwRsyncServer_4.0.5_Installer.zip

from
https://www.itefix.no/i2/sites/default/files/cwRsyncServer_4.0.5_Installer.zip
.

2.

Unpack the file and install rsync following the installation instructions.

3.

Update the rsync configuration file
rsyn
cd.conf

with the strings given below. The
file is located in the rsync installation directory (
C:
\
Program Files
\
ICW

by
default)

uid = 0

gid = 0

hosts allow = <target_node1_IP_address>,
<target_node2_IP_address>, ...

log file = rsyncd.log

[vhosts]


path = /
cygdrive/c/inetpub/vhosts


read only = true



Transfer Scenario for Panel 8.6 and Later

27



transfer logging = yes

where

<target_node1_IP_address>, <target_node2_IP_address>, ...
are
the IP addresses of the Windows
-
based service nodes.

Important:

If your Panel's virtual hosts are located not in the de
fault directory,
change the value of the
path

variable:

1. Obtain the right path from the Windows registry:
HKLM
\
SOFTWARE
\
PLESK
\
PSA
Config
\
Config
\
HTTPD_VHOSTS_D

for 32
-
bit systems or
HKLM
\
SOFTWARE
\
Wow6432Node
\
PLESK
\
PSA
Config
\
Config
\
HTTPD_VHOSTS_D

for 64
-
b
it systems.

2. Update the value of the path variable with the path from the registry. Note that
you should convert the path to the Cygwin format. For example, if your virtual hosts
are located at
D:
\
home
\
plesk_vhosts
, the resulting path is
/cygdrive/d/home
/plesk_vhosts

4.

Create the
C:
\
migrator

directory and update the rsync configuration file
rsyncd.conf

with the strings given below.

[migrator]

path = /cygdrive/c/migrator

read only = true

transfer logging = yes

5.

Configure your firewall to allow inbound connect
ions from target Windows nodes to
the port 873.

6.

Start the rsync service on behalf of the Windows administrator:

net start RsyncServer



28

Transfer Scenario for Panel 8.6 and Later


2. Prepare Service Nodes

Before starting the transfer, you should prepare your PPA service nodes for this. These
service
nodes must be a complete replacement for your source Parallels Plesk Panel
servers: They must provide all the services provided by the source servers.

Example 1

For example, you want to migrate from two Parallels Plesk Panel servers: one for
Windows and
one for Linux. To correctly prepare for the transfer, you should:

1.

Prepare two clean servers: one with the installed Linux and one with the installed
Windows operating systems.

2.

Register both servers in PPA:



Windows server as the node with the

IIS web server

/ MS SQL Server 2008 database
server

role.



Linux server as the node with the
Apache web server / Postfix mail server / MySQL
database server

role.

3.

Install MySQL on the Windows service node.

4.

Install SSI on the Windows service node.

5.

Prepare two clean Linux
servers (for the DNS service).

6.

Register these servers as nodes with the
DNS server
role.

Example 2

For example, you want to migrate from two Parallels Plesk Panel for Windows servers.
The migration must be performed on two separate Windows service nodes. T
o
correctly prepare for the transfer, you should:

1.

Prepare two clean Windows servers (replacement for your existing servers) and
one clean Linux server (for the mail service).

2.

Register Windows servers in PPA as nodes with the

IIS web server / MS SQL Server
2008 database server

role.

3.

Register Linux server as the node with the
Postfix mail server
role.

4.

Install MySQL on the Windows service nodes.

5.

Install SSI on the Windows service nodes.

6.

Prepare two clean Linux servers (for the DNS service).

7.

Register these serv
ers as nodes with the
DNS server
role.




Transfer Scenario for Panel 8.6
and Later

29


Next in this section:

Register Service Nodes in PPA

................................
................................
.........

29

Check Disk Space on Service Nodes

................................
................................

29

Ins
tall MySQL on IIS Web Server Nodes (Windows Servers)

............................

29

Install Server Side Includes (Windows Servers)

................................
................

30



Register Service Nodes in PPA

The transfer scenario assumes that you already

have a working PPA environment with
service nodes that can be used as a replacement for your existing servers. Therefore,
before performing the data transfer, you should register these service nodes.

For the instructions on how to register service nodes
in PPA, refer to the
Parallels Plesk
Automation: Deployment Guide
, section

Adding Service Nodes
.



Check Disk Space on Service Nodes

Make sure your PPA target service nodes have the same (or more) amount of disk
space as source servers do.


Install MySQL o
n IIS Web Server Nodes (Windows
Servers)

When transferring subscriptions from Panel for Windows, you should care about how
MySQL databases will be transferred from this Panel. While Panel for Windows
provides support for MySQL databases, IIS
-
based web serv
er nodes in PPA do not do
that. This means that to transfer customer databases, you should first add the support
for MySQL to the target node.



To add the support for MySQL on the target IIS web server node:

1.

Obtain the MySQL 5.1 distribution package and in
stall it following the installation
instructions.

2.

Add the MySQL installation directory to the
PATH
environment variable.

3.

Restart the PEM service by running the following commands on behalf of the
Windows administrator:

net stop pem

net start pem




30

Transfer Scenario for Panel 8.6 and Later


Install
Server Side Includes (Windows Servers)

By default, the support for Server Side Includes (SSI) is not enabled on Windows
servers. Therefore, if SSI was enabled on your source servers, you must turn on the
support for SSI on the PPA Windows service nodes as
well.



To turn on the support for SSI on a Windows service node:

1.

Connect to the node over RDP.

2.

Log in to the node as Administrator.

3.

Add the SSI role to the server in
Server Manager > Roles > Web Server (IIS) > Add Role
Services > Server Side Includes
.

4.

Log
in to PPA.

5.

Refresh the information about installed packages on the node by clicking
Refresh
in
Infrastructure > Service Nodes > select the node > User
-
installed packages
.

3. Import Resellers to PPA

The ppa
-
transfer tool has the following limitation: It al
lows you to transfer reseller
accounts to PPA but it does not automatically transfer reseller plans. Therefore, to
seamlessly import existing reseller accounts from your servers, you should first
manually create reseller plans in PPA that correspond to the

ones on your servers, and
subscribe the resellers to these plans after the transfer. See the detailed instructions
below.



To import resellers to PPA:

1.

Create reseller plans (templates) in PPA that correspond to reseller plans
(templates) in your hosting s
olution.

If you use PPA with the Billing Panel, learn how to do this in the
Parallels Plesk
Automation: Operations Guide
, section

Employing Resellers Though the Billing Panel
.

If you use PPA without the Billing Panel, learn how to do this in the
Parallels
Plesk
Automation: Operations Guide
, section

Creating Reseller Service Templates
.

2.

Edit the transfer list file
migration
-
list

(located in your session directory) to
exclude reseller accounts that you do not want to transfer to PPA. To exclude a
certain accou
nt from transfer, comment out or delete the corresponding line from
the list.

3.

Perform the transfer of reseller accounts to the PPA management node by running
the command:

# ppa
-
transfer import
-
resellers config.ini

All resellers that exist in your hosting s
olution will be transferred to PPA.



Transfer Scenario for Panel 8.6 and Later

31


4.

Subscribe the transferred resellers to the newly created reseller plans.

If you use PPA with the Billing Panel, learn how to do this in the
Parallels Plesk
Automation: Operations Guide
, section

Employing Resellers Thou
gh the Billing Panel
.

If you use PPA without the Billing Panel, learn how to do this in the
Parallels Plesk
Automation: Operations Guide
, section

Subscribing Resellers to Templates
.



4. Import Plans to PPA

The ppa
-
transfer tool does not perform the transf
er of service plans to PPA. Therefore,
you should do this manually.



To import plans to PPA:

1.

Create service plans (templates) in PPA that correspond to hosting plans on your
Panel servers. Learn how to do this in the
Parallels Plesk Automation: Operations G
uide
,
section

Creating Shared Hosting Templates.

2.

Configure subscription provisioning by assigning proper provisioning attributes to
the templates.

The provisioning attribute is a tag that links a plan and nodes on which the services
included into the plan
should be set up. Learn more about attributes in the
Parallels
Plesk Automation: Operations Guide
, chapter

Customers and Resellers
.





32

Transfer Scenario for Panel
8.6 and Later


5. Configure the Tool

Since the ppa
-
transfer tool communicates with a number of servers, you should provide
it with serve
r IP addresses, administrators' credentials, and other information. The tool
is configured with the help of the
config.ini

file, which is not created by default. For
your convenience, the directory
/etc/ppa
-
migrator/

contains the
config.ini.plesks.template

file which you can use as a basis for creating your
own
config.ini
.



To configure the tool:

1.

Create the
config.ini

file based on the template. For example:

cp /etc/ppa
-
migrator/config.ini.plesks.template config.ini

2.

Edit the
config.ini

file to configure the
tool. The description of file sections is
provided below.

The Structure of the Configuration File

The
config.ini

file consists of several sections of two types:



Predefined
. These sections contain information about your PPA management node
and various aspe
cts of data transfer. The names of the sections
[GLOBAL]

and
[ppa]

are predefined by the tool and you should not change them.



Custom
. These sections contain information about your existing servers. You can
use arbitrary names for such sections. For exampl
e,
[plesk1]
,
[plesk2]
, and so
on.

An Example of the Configuration File

Let us take a look at the example of the
config.ini

file. In this example, we are
going to transfer data from three Panel servers (two on Linux and one on Windows).

[GLOBAL]

# Here g
o custom section definitions. Each section in sources is
responsible for one Panel server.

# Order is important: Place ahead those servers which you want to get
the priority during conflict resolution.

source
-
plesks: plesk1, plesk2, plesk3

# The source
-
t
ype defines the type of the attached server (plesk in
case if you attach a Panel server)

source
-
type: plesk

# Directory for temporary files

session
-
dir: migration
-
session


# This is the time in seconds, which the tool sets as the SOA minimum
TTL and refres
h interval on a new DNS server. On this step you can
leave the default value.

zones
-
ttl: 120

[ppa]



Transfer Scenario for Panel 8.6 and Later

33


# IP address of the PPA management node

ip: 192.168.0.1


# PPA administrator credentials

panel
-
username: admin

panel
-
password: setup


# root system user cred
entials (on the PPA management node)

ssh
-
username: root

# The tool supports two types of ssh authentication: password
-
based
and key
-
based.

# If you want to authenticate by password, uncomment the following two
lines and specify the password.

# ssh
-
auth
-
typ
e: password

# ssh
-
password:

# If you want to use key
-
based authentication, uncomment the following
two lines, and specify the correct path to the SSH key. Note that
passphrase
-
protected SSH keys are not supported.

# ssh
-
auth
-
type: key

# ssh
-
key:


# Please
list the section names of external PostgreSQL servers to be
migrated.

external
-
db
-
servers: pg1

# A directory on PPA management node and all target Unix service nodes
for temporary files. If not specified, temporary files are put into
/tmp.

unix
-
session
-
dir
: /tmp

# A directory on PPA target Windows service nodes for temporary files.
If not specified, temporary files are put into C:
\
migrator.

windows
-
session
-
dir: C:
\
migrator

[plesk1]

# Here go connection parameters for the first Panel server (Linux
-
based)

ip:

192.168.0.100

os: unix

panel
-
username: admin

panel
-
password: setup

ssh
-
username: root

ssh
-
auth
-
type: password

ssh
-
password:


# The tool supports two types of ssh authentication: password
-
based
and key
-
based.

# If you want to authenticate by password, unco
mment the following two
lines and specify the password.

# ssh
-
auth
-
type: password

# ssh
-
password:

# If you want to use key
-
based authentication, uncomment the following
two lines, and specify the correct path to the SSH key. Note that
passphrase
-
protected
SSH keys are not supported.

# ssh
-
auth
-
type: key

# ssh
-
key:


# This parameter specifies whether to copy mail content from the
server (the 'full' value) or not ('none').

# By default (if the line is commented out or removed), mail content
is copied.

copy
-
ma
il
-
content: full

# A directory for temporary files. If not specified, temporary files
are put into /tmp.


34

Transfer Scenario for Panel 8.6 and Later


session
-
dir: /tmp

[plesk2]

# Here go connection parameters for the second Panel server (Linux
-
based)

ip: 192.168.0.101

os: unix

panel
-
username: admin

p
anel
-
password:

ssh
-
username: root

ssh
-
auth
-
type: key

ssh
-
key: /root/.ssh/id_rsa

session
-
dir: /root/migrator


[pg1]

# Here go connection parameters for external PostgreSQL database
server

# 'host' must be exactly the same as you see the database server in

Plesk Panel (usually it is the same as server IP)

host: 192.168.0.107

ip: 192.168.0.107

ssh
-
username: root

ssh
-
auth
-
type: password

ssh
-
password:


[plesk3]

# Here go connection parameters for the third Panel server (Windows
-
based)

ip: 192.168.0.102

os: wi
ndows

panel
-
username: admin

panel
-
password:

windows
-
username: Administrator

windows
-
password:


# no ssh credentials for os windows, and will be ignored if specified

# Define the following two parameters if your source IMAP server does
not support the NAME
SPACE extension.

# Otherwise, comment out these lines.

# If your source IMAP server is MailEnable or SmarterMail, leave the
default values for these parameters.

mailbox
-
name
-
separator: /

mailbox
-
name
-
prefix:


# This parameter specifies what mail content sh
ould be copied from the
server:

# 'full' to copy all mail content, 'messages' to copy only messages
from the Inbox folders, and 'none' to skip copying.

# By default (if the line is commented out or removed), all mail
content is copied.

# Note that if the s
erver does not support IMAP, it is possible to
copy only Inbox messages using the 'messages' option.

copy
-
mail
-
content: full

# A directory for temporary files. If not specified temporary files
are put into C:
\
migrator.

# For MySQL database content to be co
pied, session directory should be
configured in rsync server as "migrator".

session
-
dir: C:
\
migrator





Transfer Scenario for Panel
8.6 and Later

35


6. Generate a Transfer List

A
transfer list

defines the list of objects (plans, reseller accounts, and subscriptions)
that should be transferred from sou
rce Panels to PPA. The transfer list file can be
automatically generated by the ppa
-
transfer tool. By default, after the generation, it
contains all objects that are present on assimilated servers (see the example below).



To generate the transfer list, ru
n the following command:

# ppa
-
transfer generate
-
migration
-
list config.ini

After you run the command, the tool will create the
migration
-
list

file in the
session directory defined in your
config.ini
. You will need this file during further
transfer steps.

Transfer List Structure

After generation, the list contains all service plans, subscriptions, and reseller accounts
that exist on source Panels. In addition, the file contains plans and reseller accounts
that exist in PPA. The corresponding lines are mark
ed with the comment
# exists
in PPA
.

The list consists from a number of sections
-

one section per each reseller (for
example,
[Reseller1]
). Each section consists from a number of subsections
-

one
subsection per each service plan (for example,
(Gold Hosti
ng)
). Each plan
subsection contains the list of subscriptions to that plan. Note that your hosting plans
are not grouped under a certain section: They go in the beginning of the file before the
reseller sections. Depending on the source panel type, the ini
tial content of the file may
differ:



If a source panel is Panel 10.x and later, the tool automatically determines
association between plans and subscriptions. Thus, each plan section contains the