<commit_before>---
layout: global
title: Getting Started on a Cluster
group: User Guide
priority: 2
---

* Table of Contents
{:toc}

The [Quick Start Guide](Getting-Started.html) shows how to install Alluxio locally on a single machine.
In this advanced quick start guide, we will install Alluxio on a 3-node Linux cluster, configure a
AWS S3 bucket as UFS (under file system), and perform basic tasks with the data in Alluxio.

During this guide, you will:

* Download and configure Alluxio in a Linux cluster
* Configure for AWS
* Validate Alluxio environment
* Set up a distributed storage as UFS
* Start Alluxio on multiple nodes
* Perform basic tasks via Alluxio Shell
* **[Bonus]** Run sample Hadoop MapReduce job in Alluxio cluster
* **[Bonus]** Run sample Apache Spark job in Alluxio cluster
* Shutdown Alluxio

**[Required]** In this documentation, we will use AWS S3 as the example Alluxio under file system.
Please make sure you have an [AWS account with an access key id and secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys),
so you will be able to use S3 in this guide. If you don't have an S3 account, you can also use an existing HDFS cluster as the under
file system. The [Set up a distributed storage as UFS](#setupufs) section will be slightly different.

**Note**  This guide is meant for you to quickly start interacting with an Alluxio system in a distributed environment.
If you are interested in running a larger scale example which highlights the performance benefits of Alluxio,
try out the instructions in either of these two whitepapers: [Accelerating on-demand data analytics with
Alluxio](https://alluxio.com/resources/accelerating-on-demand-data-analytics-with-alluxio),
[Accelerating data analytics on ceph object storage with Alluxio](https://www.alluxio.com/blog/accelerating-data-analytics-on-ceph-object-storage-with-alluxio).

## Prerequisites

For the following quick start guide, you will need:

* 3-node Linux cluster
* [Java 7 or newer](Java-Setup.html)
* AWS account and keys

### Set up SSH (Linux)

Please make sure on all the nodes, ssh is enabled.

Optionally, setting up password-less ssh
will make distributed copy and configuration easier. In this doc, we use the example of manual
downloading and starting Alluxio on multiple nodes, for demo purpose only. The manual process here
can be much simplified and automated using `CopyDir` or Ansible scripts. Please refer to this [doc](Running-Alluxio-on-a-Cluster.html]
and [Running-Alluxio-on-EC2](Running-Alluxio-on-EC2.html] for the alternatives.

## Download Alluxio

First, [download the Alluxio release](http://www.alluxio.org/download) locally. You can
download the latest {{site.ALLUXIO_RELEASED_VERSION}} release pre-built for various versions of
Hadoop from the [Alluxio download page](http://www.alluxio.org/download).

Second, `scp` the release tarball to all the Linux nodes. Feel free to use scriptable way (such as Ansible)
to distribute the tarball and automate the following process on multiple machines. In this documentation,
manual commands are shown and most of them should be executed on all the nodes. The raw commands are described
to help user understand how Alluxio components are started individually.<commit_msg>Fix links<commit_after>---
layout: global
title: Getting Started on a Cluster
group: User Guide
priority: 2
---

* Table of Contents
{:toc}

The [Quick Start Guide](Getting-Started.html) shows how to install Alluxio locally on a single machine.
In this advanced quick start guide, we will install Alluxio on a 3-node Linux cluster, configure a
AWS S3 bucket as UFS (under file system), and perform basic tasks with the data in Alluxio.

During this guide, you will:

* Download and configure Alluxio in a Linux cluster
* Configure for AWS
* Validate Alluxio environment
* Set up a distributed storage as UFS
* Start Alluxio on multiple nodes
* Perform basic tasks via Alluxio Shell
* **[Bonus]** Run sample Hadoop MapReduce job in Alluxio cluster
* **[Bonus]** Run sample Apache Spark job in Alluxio cluster
* Shutdown Alluxio

**[Required]** In this documentation, we will use AWS S3 as the example Alluxio under file system.
Please make sure you have an [AWS account with an access key id and secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys),
so you will be able to use S3 in this guide. If you don't have an S3 account, you can also use an existing HDFS cluster as the under
file system. The [Set up a distributed storage as UFS](#setupufs) section will be slightly different.

**Note**  This guide is meant for you to quickly start interacting with an Alluxio system in a distributed environment.
If you are interested in running a larger scale example which highlights the performance benefits of Alluxio,
try out the instructions in either of these two whitepapers: [Accelerating on-demand data analytics with
Alluxio](https://alluxio.com/resources/accelerating-on-demand-data-analytics-with-alluxio),
[Accelerating data analytics on ceph object storage with Alluxio](https://www.alluxio.com/blog/accelerating-data-analytics-on-ceph-object-storage-with-alluxio).

## Prerequisites

For the following quick start guide, you will need:

* 3-node Linux cluster
* [Java 7 or newer](Java-Setup.html)
* AWS account and keys

### Set up SSH (Linux)

Please make sure on all the nodes, ssh is enabled.

Optionally, setting up password-less ssh
will make distributed copy and configuration easier. In this doc, we use the example of manual
downloading and starting Alluxio on multiple nodes, for demo purpose only. The manual process here
can be much simplified and automated using `CopyDir` or Ansible scripts. Please refer to this [doc](Running-Alluxio-on-a-Cluster.html)
and [Running-Alluxio-on-EC2](Running-Alluxio-on-EC2.html) for the alternatives.

## Download Alluxio

First, [download the Alluxio release](http://www.alluxio.org/download) locally. You can
download the latest {{site.ALLUXIO_RELEASED_VERSION}} release pre-built for various versions of
Hadoop from the [Alluxio download page](http://www.alluxio.org/download).

Second, `scp` the release tarball to all the Linux nodes. Feel free to use scriptable way (such as Ansible)
to distribute the tarball and automate the following process on multiple machines. In this documentation,
manual commands are shown and most of them should be executed on all the nodes. The raw commands are described
to help user understand how Alluxio components are started individually.
{'fraction_non_alphanumeric': 0.07075899606894466, 'fraction_numerical': 0.0030238887208950713, 'mean_word_length': 4.7421875, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 16, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5612787', 'n_tokens_mistral': 1859, 'n_tokens_neox': 1800, 'n_words': 886}