1.. _slony-install:
2
3
4**************************************************************
5`Slony-I administration with pgAdmin III: installation`:index:
6**************************************************************
7
8.. _node:
9
10Prerequisites
11=============
12
13As a prerequisite to running Slony-I on PostgreSQL, the slony modules
14xxid and slony1_funcs must be present on all servers that have to run a
15Slony-I replication node. This is usually done by the Slony-I installation
16routine.
17
18.. _overview:
19
20Overview
21========
22
23Setting up Slony-I for the first time can be a daunting task. The
24following sections of the pgAdmin helpfile will help guide you through
25creation of your first cluster.
26
27* :ref:`Step 1 <create>`: Create the cluster on the master node.
28* :ref:`Step 2 <join>`: Add slave nodes to the cluster.
29* :ref:`Step 3 <path>`: Setup paths on each node to all other nodes.
30* :ref:`Step 4 <listen>`: Setup listens on each node to all other nodes
31  (**Note**: Not required with Slony-I v1.1 or later).
32* :ref:`Step 5 <set>`: Create a replication set.
33* :ref:`Step 6 <table>`: Add tables and sequences to the set.
34* :ref:`Step 7 <subscription>`: Subscribe the slaves to the set.
35
36**Note** At this point, the slon daemons (service engines on Windows)
37should be started.
38
39.. _create:
40
41Create cluster and first node
42=============================
43
44.. image:: images/slony-create.png
45
46To install a Slony-I cluster on the first database, the "New Slony-I
47Cluster" dialog is used. It executes the official Slony-I cluster
48creation SQL scripts, which are located in the directory configured in
49the :ref:`Options <options-browser>` dialog.
50
51pgAdmin III needs to store information how to contact each individual
52node in the cluster. To achieve this, pgAdmin III uses the concept of
53"Administrative nodes".
54
55.. _join:
56
57Join additional nodes to cluster
58================================
59
60.. image:: images/slony-join.png
61
62After the first node in the Slony-I replication cluster has been
63successfully created, all subsequent nodes take their configuration and
64procedures from the first nodes. This process is called "Joining a
65cluster" in pgAdmin III. Usually, you should also select an existing
66node as admin node, to insure later accessibility from pgAdmin III.
67
68After you added a new node to the Slony-I cluster, you need to set up
69:ref:`replication paths <slony-path>` between the nodes, to enable
70communication between the nodes.
71
72.. _upgrade:
73
74Upgrade node to new cluster software
75====================================
76
77.. image:: images/slony-upgrade.png
78
79When a cluster is to be upgraded to a new version of the Slony-I
80clustering software, the upgrade process has to be run on all nodes of
81the cluster. For each node, the slon daemon needs to be stopped, then
82the upgrade dialog is started and a node with the new software is
83selected (pgAdmin III will extract all software from that node), and
84finally the slon daemon is started again.
85
86Currently, pgAdmin III does **not** support upgrading from slony creation
87scripts. Instead, create an intermediate cluster from the creation
88scripts, use it as a source for the upgrade dialog, and drop the cluster
89after usage. You may also use the slonik tool to upgrade the first node,
90and then use it as source for subsequent node upgrades.
91