Install Guide - rambabu-chamakuri/PSTL-DOC GitHub Wiki

If you are not familiar with the basics of building Jaguar, please refer to the Jaguar Build Guide. This guide assumes you have build artifacts available for installation.

TIP: Jaguar is typically installed on edge nodes in a cluster(ed) environment, there is no need to install artifacts on all nodes. If you are familiar with Hortonworks, think of Jaguar as an assigned client role to edge node(s).

TIP: RPM is the preferred installation medium for most environments. Tarball installation medium is maintained for alternative environments and packaging tests.

Prerequisites

TODO: Spark

RPM

Installing the Jaguar RPM is as simple as any other RPM installation:

Chriss-MacBook-Pro-4:~ cbowden$ docker run -v ~/docker_mount:/mnt/jaguar -it centos:centos7
[root@201e22e36ddf /]$ ls /mnt/jaguar/
pstl-assembly-rpm_2.11-1.0.0.rpm
[root@201e22e36ddf /]$ rpm -ivh /mnt/jaguar/pstl-assembly-rpm_2.11-1.0.0.rpm 
Preparing...                          ################################# [100%]
Updating / installing...
   1:pstl-assembly-rpm_2.11-1.0.0-SNAP################################# [100%]

In this installation example, we:

Launch a centos7 docker container, with the Jaguar RPM mounted at /mnt/jaguar
Install the Jaguar RPM, using the standard command: rpm -ivh my.rpm

The installation directory defaults to /usr/share/pstl. With Jaguar installed, let's take a look at the installation directory:

[root@201e22e36ddf /]$ cd /usr/share/pstl
[root@201e22e36ddf pstl]$ ls -l
total 12
drwxr-xr-x 2 root root 4096 Jan  4 17:51 bin
drwxr-xr-x 4 root root 4096 Jan  4 17:51 conf
drwxr-xr-x 2 root root 4096 Jan  4 17:51 lib

As you probably suspect, the bin directory contains necessary "binaries" for Jaguar. We quote "binaries", as these are typically shell scripts which properly invoke our JVM application(s). Important binaries are automatically symlinked to /usr/bin, so they are typically available on the existing PATH environment variable. The conf directory contains necessary configuration files, etc. for Jaguar to function. The conf directory is also symlinked to /etc/pstl, which is typically where users will look to modify configuration(s), etc. The lib directory contains necessary dependencies for Jaguar to function. These dependencies typically come in the form of compiled JAR(s), both internal and third party.

Once you have installed the RPM, please consult the Post Install Configuration steps. After completing the post install configuration you will be ready to begin deploying jobs on your new Jaguar installation!

Tarball

Installing the Jaguar Tarball is as simple as any other Tarball installation:

Chriss-MacBook-Pro-4:~ cbowden$ docker run -v ~/docker_mount:/mnt/jaguar -it centos:centos7
[root@f6de2096f213 /]$ mkdir -p /usr/share/pstl
[root@f6de2096f213 /]$ tar zxvf /mnt/jaguar/pstl-assembly_2.11-1.0.0.tar.gz -C /usr/share/pstl

In this installation example, we:

Launch a centos7 docker container, with the Jaguar Tarball mounted at /mnt/jaguar
Create the directory /usr/share/pstl, this is where we would like to extract the Jaguar Tarball
Install the Jaguar Tarball, using the standard command: tar zxvf my.tar.gz. We also specify the target directory to expand the Jaguar Tarball into with the -C option.

With the Jaguar Tarball installed, let's take a look at the installation directory:

[root@f6de2096f213 /]$ cd /usr/share/pstl
[root@f6de2096f213 pstl]$ ls -l
total 12
drwxr-xr-x 2 root root 4096 Jan  4 18:14 bin
drwxr-xr-x 4 root root 4096 Jan  4 18:14 conf
drwxr-xr-x 2 root root 4096 Jan  4 18:14 lib

As you probably suspect, the bin directory contains necessary "binaries" for Jaguar. We quote "binaries", as these are typically shell scripts which properly invoke our JVM application(s). The conf directory contains necessary configuration files, etc. for Jaguar to function. The lib directory contains necessary dependencies for Jaguar to function. These dependencies typically come in the form of compiled JAR(s), both internal and third party.

Once you have installed the Jaguar Tarball, please consult the Post Install Configuration steps. After completing the post install configuration you will be ready to begin deploying jobs on your new Jaguar installation!

Post Install Configuration

After installing Jaguar, there are a few post-install configuration steps