# Alluxio Assembly

This module is to unify the different alluxio modules into a release package;
typically a tarball.

## Building

The defaults are set up so that the following command will generate the tarball

    mvn package assembly:single

This command will output the tar at `target/alluxio-$VERSION.tar.gz` along with
a `target/alluxio-$VERSION` directory that has the same content as the tar.

## Contents

Inside this tar should be all the artifacts that need to be in the release: bin,
conf, libexec, jars, src, ...

All content should work out of the box, so `conf` should reference the tar's
structure, `bin` should execute based off this structure, and all needed jars
should be included.

## Usage

For more details on how to use the generated tar, go
[to the docs](https://docs.alluxio.io/os/user/stable/en/overview/Getting-Started.html).
