RackTablesInstallHowto

From RackTables Wiki
Revision as of 19:58, 16 December 2009 by Infrastation (talk | contribs) (making PRE work)
Jump to: navigation, search

RackTables On Ubuntu 7.10 Server

originally published by Mike Fields at HowtoForge

In the words of the developers, RackTables is "A management framework for rackspace, IP addresses, servers, switches, routers and much more!". To me, it is the solution to a project that I have been working on for some time - A means of mapping out our data center at work. I have, for a long time, wanted a way to map out and make available in a web interface, our server racks. An example of what RackTables looks like can be seen below.

Rackdemolayout.png

The closest I have come is using network-weathermap and although it is a fantastic application, I don't think that the use I was trying to use it for was its intended purpose. So, when I stumbled upon !RackTables a few days ago, I was thrilled. While I was installing it on a development system, I (as usual) made notes of my steps so that if I decided to implement it on a production system, I would have my guide laid out before me. That being the case, I decided to share what I put together with you.

Now, onto the tutorial. There are two methods that you can use to implement !RackTables - a web based install and a command line install. I will cover both in this tutorial. Just as a side note, this guide works under the assumption that you have an existing and functional LAMP server. If not, then you may want to follow "The Perfect Server - Ubuntu Gutsy Gibbon (Ubuntu 7.10)" guide.

Web based installation method

The first step is to obtain the source code, unpack it and move it into a web accessible directory. Perform the following commands to prepare for the web based portion of the tutorial.

cd /tmp/
wget http://racktables.org/files/RackTables-0.14.12.tar.gz
tar -xvzf RackTables-0.14.12.tar.gz
sudo mv RackTables-0.14.12 /var/www/racktables

At this point, you will be prompted for your password, since you are issuing the 'sudo' command - type it in and press the "Enter" key.

Create Database And Database User

RackTables does use a MySQL back end to store the data, so you will need to create a database and a user for the installation to be successful. Perform the following commands to create everything that you will need to proceed.

mysql -uroot -p

You will now be prompted for the password for your 'root' MySQL user. Type it in and press the "Enter" key. Once you are at the MySQL command prompt, issue the following commands:

create database racktables;
grant all on racktables.* to root;
grant all on racktables.* to root@localhost;
grant all on racktables.* to rackuser;
grant all on racktables.* to rackuser@localhost;
set password for rackuser@localhost=password('rackpw');
exit

With that done, it is now time to proceed to the actual installation.

Open A Web Browser And Begin The Install

It is time to begin the web based portion of the install. Open your favorite web browser and point it to the installation URL.

http://your_servers_ip_address/racktables/install.php

Rackwebstep1.png

It is safe to ignore the errors as they will be taken care of during the install. Click "Proceed" to continue.

Rackwebstep2.png

Again, click "Proceed" to continue.

Rackwebstep3.png

Now we need to do a little more command line work. In your terminal, enter the following commands:

sudo touch /var/www/racktables/inc/secret.php
sudo chmod 666 /var/www/racktables/inc/secret.php

Now click on the "retry" button to proceed further with step 3.

Rackwebstep4.png

Fill in the requested data (as shown in the example above) with the database username and password that you created above. When done, again click on the "retry" button to move on with step 3.

Rackwebstep5.png

With that finally out of the way, click "Proceed" to continue to step 4.

Rackwebstep6.png

Make sure that there are no errors present and click "proceed" to continue.

Rackwebstep7.png

In this step, you will enter the password you wish to use for the "admin" login for your RackTables Web site. Enter the password that you want and click on the "retry" button.

Rackwebstep8.png

With the password set, click "proceed" to continue.

Rackwebstep9.png

Congratulations! !RackTables has now been installed. Click on the "proceed" button to be prompted for your login information. The default username is "admin" and you will use the password that you created in step 5.

Rackwebstep10.png

Terminal Based Installation Method (DOES NOT WORK in 0.17.0 and later releases)

!RackTables also offers a terminal based method of installation. Being a command line kind of guy, this was my initial choice (probably not the popular one). It begins exactly like the web based method.

The first step is to obtain the source code, unpack it and move it into a web accessible directory. Perform the following commands:

cd /tmp/
wget http://racktables.org/files/RackTables-0.14.12.tar.gz
tar -xvzf RackTables-0.14.12.tar.gz
sudo mv RackTables-0.14.12 /var/www/racktables

At this point, you will be prompted for your password, since you are issuing the 'sudo' command - type it in and press the "Enter" key.

Create Database And Database User

!RackTables does use a MySQL back end to store the data, so you will need to create a database and a user for the installation to be successful. Perform the following commands to create everything that you will need to proceed.

mysql -uroot -p

You will now be prompted for the password for your 'root' MySQL user. Type it in and press the "Enter" key. Once you are at the MySQL command prompt, issue the following commands:

create database racktables;
grant all on racktables.* to root;
grant all on racktables.* to root@localhost;
grant all on racktables.* to rackuser;
grant all on racktables.* to rackuser@localhost;
set password for rackuser@localhost=password('rackpw');
exit

With that done, it is now time to proceed to the actual installation.

Edit Configs

There are a few changes that need to be made to some of the configuration files, before you can proceed. The first will be to create the "secret.php" file and create your admin password. Issue the following commands:

sudo cp inc/secret-sample.php inc/secret.php
sudo nano inc/secret.php

Within the "secret.php" file you will find a section to set your database username and password as shown below:

$db_username = 'username';
$db_password = 'password';

Change it so that it resembles this:

$db_username = 'rackuser';
$db_password = 'rackpw';

Now press Ctrl-O to write out your changes and Ctrl-X to exit the editor.

You now need to edit the "init-auth.sql" file to set your admin password. Issue the following command to do so:

sudo nano install/init-auth.sql

The file will initially look like this:

INSERT INTO `UserAccount` (`user_id`, `user_name`, `user_enabled`, `user_passwo$
VALUES (1,'admin','yes',sha1(
# Uncomment and change the next line to your password, e.g.:
# 'mysecretpassword'
# ... and comment out the line below:
PLEASE_READ_THE_INSTALL_DOCUMENTATION
),'RackTables Administrator');

Change it to resemble my example below:

INSERT INTO `UserAccount` (`user_id`, `user_name`, `user_enabled`, `user_password_hash`, `user_realname`)
VALUES (1,'admin','yes',sha1(
# Uncomment and change the next line to your password, e.g.:
'some_secret_password_only_you_know'
# ... and comment out the line below:
# PLEASE_READ_THE_INSTALL_DOCUMENTATION
),'racktables Administrator');

Import SQL Files Into Your Database

You now need to import some sql files into your database to set the structure and create your admin account. Perform the following commands (keeping in mind that after each one, you will need to enter your "root" MySQL password):

mysql -uroot -p racktables < install/init-structure.sql
mysql -uroot -p racktables < install/init-auth.sql
mysql -uroot -p racktables < install/init-dictbase.sql
mysql -uroot -p racktables < install/init-dictvendors.sql

Once that is done, you are ready to log in to your newly created !RackTables web site.

Opening The Web Site

Using your favorite web browser and point it to your web site's URL.

http://your_servers_ip_address/racktables/

You will be prompted for your username and password. The default username is admin and the password will be the one that you set in the "init-auth.sql" file above.

Rackwebstep10.png

That completes the installation guide, covering both methods of the installation process. Something to keep in mind though is that even though I wrote this guide using Ubuntu 7.10 server, it is pretty generic. It should be easily adaptable to any distribution with minor difficulty. The only section that comes to mind is the command for moving the racktables directory into your web space. For example, under CentOS, you could substitute the following command and I believe everything else would be the same.

CentOS example:

sudo mv RackTables-0.14.12 /var/www/html/racktables

This is a great project and I am happy that I found it. I hope that some of you will find it useful as well and that my guide makes it a little easier for you to implement.