|author||Keith Turner <firstname.lastname@example.org>||Thu Sep 28 16:43:13 2017 -0400|
|committer||Christopher Tubbs <email@example.com>||Thu Sep 28 16:43:13 2017 -0400|
Add CONTRIBUTING.md (#7) * Add CONTRIBUTING.md * Update CONTRIBUTING.md * Copied Fluo contrib.md, omitting testing section
A tool for running Apache Fluo applications in Hadoop YARN.
This is currently a work in progress that depends on unreleased features of Fluo and will not be ready for use until after Fluo 1.2.0 is released. Sometime after Fluo 1.2.0 is released this project will make its first release.
|Software||Recommended Version||Minimum Version|
See the related projects page for external projects that may help in setting up these dependencies.
Before you can launch a Fluo application in YARN, you should follow Fluo's install and application instructions to install Fluo and initialize a Fluo application. After your application has been initialized, follow the insructions below to install the Fluo YARN launcher and run your application in YARN. Avoid using the
fluo command to start local oracle and worker processes if you are running in YARN.
Before you can install the Fluo YARN launcher, you will need to obtain a distribution tarball. It is recommended that you download the latest release. You can also build a distribution from the master branch by following these steps which create a tarball in
git clone https://github.com/apache/fluo-yarn.git cd fluo-yarn/ mvn package
After you obtain a Fluo YARN distribution tarball, follow these steps to install Fluo.
Choose a directory with plenty of space, untar the distribution, and run
fetch.sh to retrieve dependencies:
tar -xvzf fluo-yarn-1.0.0-bin.tar.gz cd fluo-yarn-1.0.0 ./lib/fetch.sh
The distribution contains a
fluo-yarn script in
bin/ that administers Fluo and the following configuration files in
| Configuration file | Description | |-----------------------------|-------------------------------------------------------------------------| | fluo-yarn-env.sh | Configures classpath for
fluo-yarn script. Required for all commands. | | fluo-yarn.properties | Configures how application runs in YARN. Required for
start command. | | log4j.properties | Configures logging |
FLUO_HOMEif it is not in your environment
FLUO_CONN_PROPSif you don't want use the default.
Configure fluo-yarn.properties to set how your application will be launched in YARN:
If you are managing multiple Fluo applications in YARN, you can copy this file and configure it for each application.
Follow the instructions below to start your application in YARN. If you have not done so already, you should initialize your Fluo application before following these instructions.
Run the commands below to start your Fluo application in YARN.
fluo-yarn start myapp conf/fluo-yarn.properties
The commands will retrieve your application configuration and observer jars (using your application name) before starting the application in YARN. The command will output a YARN application ID that can be used to find your application in the YARN resource manager and view its logs.
Except for stopping your application in YARN, the
fluo script can be used to manage your application using the
wait commands. See Fluo's application instructions for more information.
When you want you stop your Fluo application, use the the YARN resource manager or the
yarn application -kill <App ID> to stop the application in YARN.