2dc79905c4112aa29d072a9b571a783d412e87dd
[racktables] / README
1 Thank you for selecting RackTables as your datacenter management
2 solution. Feel free to address your questions to the mailing list
3 before contacting the authors directly. The project web-site
4 (http://racktables.org/) is usually kept up to date with the
5 current version and URLs.
6
7 Mailing list: <racktables-users/=@=/freelists.org>
8 Bug tracker and Wiki: http://racktables.org/trac
9 Authors: <info/=@=/racktables.org>
10
11 *******************************************************
12 * *
13 * INSTALLING RACKTABLES *
14 * *
15 *******************************************************
16
17 I. Dependencies.
18
19 For database you must have a MySQL server installation version 4.x or 5.x:
20 Fedora 8/9: yum install mysql-server mysql
21 ALTLinux Compact 3.0: apt-get install MySQL-server MySQL-client
22 ALTLinux Desktop 4.0: apt-get install MySQL-server
23
24 For web-frontend you must have Apache and PHP 5 with PDO and multibyte
25 extensions:
26 Fedora 8/9: yum install httpd php php-mysql php-pdo php-gd php-snmp php-mbstring
27 ALTLinux Server 4.0: apt-get install apache2-httpd-prefork php5-gd2 \
28 php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
29
30 II. Prepare the server.
31 1. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
32 or http://racktables.mysite.org.
33 2. mysql> create database_name; grant all privileges on database_name.* to XXX@YYY identified by 'ZZZ';
34
35
36 There are two mutually exclusive ways to install RackTables, they are described as III-A and III-B.
37
38
39 III-A. HTTP installation (starting with 0.14.12 release)
40 Open your RackTables URL and follow the instructions. In a suitable
41 environment everything should take a minute or so.
42
43
44 III-B. Manual installation.
45 1. Edit install/init-auth.sql and change admin password
46
47 2. Init database.
48 mysql> use database_name;
49 mysql> source install/init-structure.sql
50 mysql> source install/init-auth.sql
51 $ rm -f install/init-auth.sql
52 mysql> source install/init-dictbase.sql
53 mysql> source install/init-dictvendors.sql
54
55 3. Edit inc/secret.php
56
57 4. $ rm -f install/init-auth.sql
58 (Just to be sure you did.)
59
60 *******************************************************
61 * *
62 * UPGRADING RACKTABLES *
63 * *
64 *******************************************************
65 RackTables now provides an automatic database upgrade feature.
66 If you already have a working installation, the following
67 procedure should be sufficient:
68
69 0. BACKUP YOUR DATABASE
70 1. Remove all existing files except inc/secret.php and gateways'
71 configuration (in the gateways directory).
72 2. Unpack the new tarball into the place.
73 3. Open the RackTables page in your browser.
74 4. Follow instructions. Normally, everything should be Ok. If it
75 is not so, write down the failed quieries for further investigation.
76
77 *******************************************************
78 * *
79 * RELEASE NOTES *
80 * *
81 *******************************************************
82
83 *** Upgrading to 0.14.12 ***
84
85 The upgrade may show a failed query "alter database character set utf8", in
86 this case the user should issue the query manually from the mysql command
87 line.
88
89 *** Upgrading to 0.16.0 ***
90
91 This release features a completely new authorization system, RackCode,
92 which brings the tags feature (introduced in 0.15.0) to its full potential.
93 The old-style user permissions are converted during upgrade automatically,
94 but the result may appear not what you would expect. Review the RackCode
95 after upgrade (Main page -> Configuration -> Permissions) and adjust,
96 if necessary.
97
98 Another important change is a new dependency on "multibyte string" PHP
99 extension. Normally one should get it working before starting the upgrade,
100 this is typically achieved by installing a particular PHP RPM from the
101 standard package repository (and restarting Apache after that):
102
103 Fedora: yum install php-mbstring
104 ALTLinux: apt-get install php5-mbstring
105
106 *** Upgrading to 0.16.1 ***
107 This release fixes a missing UNIQUE key in the database. However, this fix
108 may sometimes fail, if the table contains duplicate records. If the
109 0.16.0-0.16.1 upgrade batch completed without errors, no action needs to be
110 taken. If you see a failed ADD UNIQUE query during upgrade, the only solution
111 is to delete the duplicates manually. To do this, open a MySQL console and
112 issue the failed query again:
113
114 mysql> alter table IPVirtualService ADD UNIQUE endpoint (vip, vport, proto);
115
116 The IP address of the duplicate VS will be known from the "Duplicate entry"
117 message. For example, to decode "Duplicate entry '180879877-80-TCP' for key
118 2" error message, issue:
119
120 mysql> select inet_ntoa(180879877);
121
122 Then go to "virtual services" web-interface page and adjust the data as
123 necessary. You would need to get rid of the duplicates accurately one by
124 one, repeating the ADD UNIQUE query until it succeeds.