Skip to content

Before You Start

The Getting Started guides that follows leverages the standalone punchplatform. Make sure you get the latest one from our download area.

In minutes you will be able to run, operate, test and develop various use cases. The standalone punchplatform is also very useful in operation, coupled with your production platform, to run prototype or test setups either in sandbox mode or directly on the production traffic.

ATTENTION !

What you cannot do is to go production with the standalone, that is not its purpose. For production, use the official deployment packages. They take care of properly installing the punchplatform components. The PunchPlatform team will provide production support only on versions installed using the official deployment packages.

Mandatory requirements to install/run standalone

At least 12 GB of RAM memory and 30 GB of free storage on your hard drive. In general, memory requirement will depends on the number and the complexity of storm topologies/spark applications you will be running at a time (e.g. input and output channels, tenants, ...).

Below is a list of supported OS and required application to have before installing the standalone

Requirements for installation MacOS Sierra 10.12+ Ubuntu 18.04 LTS+ (64 bits) Debian 7+ (64 bits) CentOS/RHEL 7+ (64 bits)
unzip
jq
curl
python 3.6.8
bash
java 1.8 (jdk & jre)
wget

Installation instructions

We provide a list of instructions for installing our required dependencies. Please, follow them accordingly to the OS you plan on running the standalone version ! Skip this part if your system already meets the above requirements !

Classic installation
brew install python3.6
Recommended way by using pyenv

if you want to use Punch, you also need to install python version 3.6.8. We recommend using Pyenv for installing the right target of python. Check our Pyenv instructions to make sure you have a clean and proper installation.

Classic installation
brew tap AdoptOpenJDK/openjdk
brew cask install adoptopenjdk8
Recommended way by using jenv

we have a number of applications which depends on java 1.8, so you better install it ! check out our documentation on how to install java using jenv.

# we assume that [HomeBrew](https://brew.sh/) is already install on your machine
brew install jq curl
Classic installation
sudo apt update
sudo apt install python3.6
Recommended way by using pyenv

if you want to use Punch, you also need to install python version 3.6.8. We recommend using Pyenv for installing the right target of python. Check our Pyenv instructions to make sure you have a clean and proper installation.

Classic installation
sudo apt update
sudo apt install openjdk-8-jdk
Recommended way by using jenv

we have a number of applications which depends on java 1.8, so you better install it ! check out our documentation on how to install java using jenv.

sudo apt update
sudo apt install curl unzip jq
Classic installation
sudo yum install python3
Recommended way by using pyenv

if you want to use Punch, you also need to install python version 3.6.8. We recommend using Pyenv for installing the right target of python. Check our Pyenv instructions to make sure you have a clean and proper installation.

Classic installation
sudo yum install java-1.8.0-openjdk-devel
Recommended way by using jenv

we have a number of applications which depends on java 1.8, so you better install it ! check out our documentation on how to install java using jenv.

sudo yum install zip unzip wget
sudo wget https://github.com/stedolan/jq/releases/download/jq-1.5/jq-linux64 -O /usr/bin/jq && sudo chmod +x /usr/bin/jq

Congratulation, now we can get started using the PunchPlatform !

Execution

This chapter assumes you have already downloaded the standalone punchplatform archive from our download area. Simply unzip it, you should have a punchplatform-standalone-x.y.z directory on your filesystem.

Important

Install the Standalone as a non-root user. I.e. use it under your standard user account. A troubleshooting procedure for the standalone is available at Troubleshooting your standalone

Installation command

unzip punchplatform-standalone-x.y.z.zip
cd punchplatform-standalone-x.y.z
./install.sh

This unarchives all our friends (Kafka, Storm, Elasticsearch, Spark etc...), and patches their configuration files (cleanly) so that you have a simple local PunchPlatform setup. All Punch binary and configuration files will be installed under this directory, nowhere else on your machine. When a prompt ask you to patch your environment, if you answer "yes", it will only add a few lines at the end of your ~/.bashrc (on linux) or ~/.bash_profile (on MacOS) to update your path variable. You then only need to start a new terminal.

If you prefer not impacting your environment, just say no. To setup your environment you must then execute the following command every time you start a new terminal:

Useful commands to know

source ./activate.sh

Assuming you are happy with a local setup, you can start all of the standalone platform components (Zookeeper, Storm, Elasticsearch, Kibana, Spark).

punchplatform-standalone.sh start

Check if your standalone version is running properly:

punchplatform-standalone.sh status

Check a summary your standalone UI:

punchplatform-standalone.sh --summary