From d361870a65c84d277331dd53024f6408e9a046e4 Mon Sep 17 00:00:00 2001 From: Jim Plush Date: Mon, 18 Apr 2011 15:53:21 -0700 Subject: [PATCH] Updating the docs for installing using the tarball source and getting your master and nodes up and running --- src/docs/UserGuide/Installation | 51 ++++++++++++++++++++++++++++++-------- 1 files changed, 40 insertions(+), 11 deletions(-) diff --git a/src/docs/UserGuide/Installation b/src/docs/UserGuide/Installation index 1045dba..91b2ecb 100644 --- a/src/docs/UserGuide/Installation +++ b/src/docs/UserGuide/Installation @@ -35,11 +35,15 @@ and a DEB file. The only prerequisite to running Flume is Java 1.6. The tarball is a self-contained package containing everything needed to do get Flume up and running on a Unix-like system. Installing from the tarball is as easy as unpacking it in an appropriate - directory. For instance on most Linux based systems this can be - achieved by typing: + directory and setting some environment variables. For instance on most Linux based systems this can be + achieved by typing the following commands: ---- -$ (cd /usr/local/ && sudo tar -zxvf ) +$ cd /usr/local +$ sudo wget http://archive.cloudera.com/cdh/3/flume-0.9.3-cdh3u0.tar.gz (change this to your appropriate version) +$ sudo tar -xzvf flume-0.9.3-cdh3u0.tar.gz +$ sudo ln -s flume-0.9.3-cdh3u0 flume +$ cd /usr/local/flume ---- To complete the configuration of a tarball-based installation, you need to set the environment variable +$FLUME_CONF_DIR+ to be the +conf/+ subdirectory of the location that you installed Flume into - e.g. @@ -48,15 +52,40 @@ To complete the configuration of a tarball-based installation, you need to set t $ export FLUME_CONF_DIR=/usr/local/flume/conf ---- -//If a user is running older bin tools you can achieve the same objective by typing: -//---- -//$ ( cd /opt && mkdir flume && cd flume && gzip -cd | tar -xvf - ) -//---- +It also recommended to set the +$FLUME_HOME+ environment variable as well + +---- +$ export FLUME_HOME=/usr/local/flume +---- + +==== Starting the Master + +To run the master node as a daemon script you can run these commands at once as: (notice the -E setting for sudo which will preserve the environment variables) + +---- +$ export FLUME_CONF_DIR=/usr/local/flume/conf; export FLUME_HOME=/usr/local/flume; sudo -E bin/flume-daemon.sh start master +---- + +To verify, direct your browser to: http://masterhost:35871/flumemaster.jsp (change masterhost to the hostname you installed flume on) + +==== Starting a Node (collector or agent) + +To run the node as a daemon script you can run these commands at once as: (notice the -E setting for sudo which will preserve the environment variables) + +---- +$ export FLUME_CONF_DIR=/usr/local/flume/conf; export FLUME_HOME=/usr/local/flume; sudo -E bin/flume-daemon.sh start node +---- + +To stop your node you can now use + +---- +$ sudo bin/flume-daemon.sh stop node +---- + +After your node is up and running you need to continue with the UserGuide so that your node knows where the master can be found. + +By default the debug logs will be available in +/var/log/flume+ so make sure that directory exists and is writeable by the flume process -The tarball does not come with any scripts suitable for running Flume -as a service or daemon. This makes the tarball distribution -appropriate for ad-hoc installations and preliminary testing, but a -more complete installation is provided by the binary packages. === RPM or Deb Based install The RPMs and DEBs are much more convenient than a tarball based install in that they: -- 1.7.4.1