Baremetal

Getting Started with VoltSP on Bare Metal¶

This guide will walk you through setting up and running a VoltSP streaming pipeline on a non-containerized, bare metal, or virtual machine environment using the voltsp command-line tool.

Prerequisites¶

Before you begin, ensure you have the following:

Java 21 or later
A valid VoltSP license file
VoltSP installed or VoltSP installation tarball.

Step 0: Setup VoltSP installation¶

If you do not have VoltSP installation setup yet unpack it from the tar package:

tar -xzf voltsp-1.5.4.tar.gz

This command will create voltsp directory with roughly the following contents:

voltsp
├── docs
│   ├── index.html
│   └── ...
├── lib
│   └── voltsp.jar
├── log4j2.xml
├── plugins
│   └── ...
├── voltsp
└── ...

The voltsp file is the main launch script for the product. You can launch it from the installation directory:

cd voltsp
./voltsp --help

or add it to PATH so it is available from anywhere in the system:

cd voltsp
export PATH="${PATH}:$(pwd)"

Step 1: Verify Your Environment¶

VoltSP includes a built-in test pipeline to verify that your environment is set up correctly. Run the VerifyEnvironment pipeline and point to your license file using the -l option.

voltsp -l /path/to/your/license.xml org.volt.stream.test.pipeline.VerifyEnvironment

You should see the following output, confirming your license and Java version are valid:

License is OK
Java version is OK

Step 2: Run an Interactive Example Pipeline¶

VoltSP comes with several example pipelines you can run to see it in action. Let's run the Echo pipeline, which simply reads lines from standard input and prints them back to standard output.

Execute the pipeline:

voltsp -l /path/to/your/license.xml org.volt.stream.test.pipeline.Echo

Provide input: The pipeline is now running and waiting for input. Type any text and press Enter.
```
Hello VoltSP!
```
View the output: The pipeline will immediately "echo" your input back to the console.
```
Hello VoltSP!
```
You can continue entering lines. To stop the pipeline, press Ctrl+C.

Step 3: Running Your Own Pipeline¶

To run a custom pipeline, you need to make sure the voltsp tool can find your compiled pipeline code (the JAR file).

Package your pipeline into a JAR file (e.g., my-pipeline.jar).
Set the Classpath: Use the CP environment variable to point to your JAR file.
```
export CP=/path/to/my-pipeline.jar
```
If your pipeline has multiple dependency JARs, you can point the classpath to a directory containing all of them.
```
export CP=/path/to/your/libs/*
```
Run your pipeline: Now, execute the voltsp command, specifying the fully qualified name of your main pipeline class.
```
voltsp -l /path/to/license.xml com.yourcompany.YourPipeline
```

Next Steps¶

Explore all options: For a full list of command-line options, including memory configuration, logging, and parallelism, run voltsp --help.
Enable Shell Completion: For easier use, enable shell completion for the voltsp command.
```
. voltsp_completion.sh
```
Add this command to your ~/.bashrc or ~/.zshrc to make the change permanent.
See how to develop pipelines in Java.