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