Skip to content

compose

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

compose

README.md

StreamPipes Compose - The User's Choice

StreamPipes Compose is a simple collection of user-friendly docker-compose files that easily lets gain first-hand experience with Apache StreamPipes.

Current version: 0.99.0-SNAPSHOT

NOTE: We recommend StreamPipes Compose to only use for initial try-out and testing. If you are a developer and want to develop new pipeline elements or core feature, use the StreamPipes CLI.

TL;DR: A one-liner to rule them all 🎉 🎉 🎉

docker-compose up -d

Go to http://localhost to finish the installation in the browser. Once finished, switch to the pipeline editor and start the interactive tour or check the online tour to learn how to create your first pipeline!

Prerequisite

  • Docker >= 17.06.0
  • Docker-Compose >= 1.17.0 (Compose file format: 3.4)
  • Google Chrome (recommended), Mozilla Firefox, Microsoft Edge

Tested on: macOS, Linux, Windows (CMD, PowerShell, GitBash)

macOS and Windows users can easily get Docker and Docker-Compose on their systems by installing Docker for Mac/Windows (recommended).

NOTE: On purpose, we disabled all port mappings except of http port 80 to access the StreamPipes UI to provide minimal surface for conflicting ports.

Usage

We provide several options to get you going:

  • default: the standard installation, uses NATS as internal message broker (recommended for new installations)
  • kafka: starts the Kafka-based setup via docker-compose.kafka.yml
  • minimal: contains only a minimal set of adapters, processors and sinks for iiot use cases

The NATS-based setup is the recommended default. If you previously relied on Kafka, the Kafka compose file is still available as docker-compose.kafka.yml.

Starting the default (NATS) option is as easy as simply running:

NOTE: Starting might take a while since docker-compose up also initially pulls all Docker images from Dockerhub.

docker-compose up -d
# go to `http://localhost` after all services are started

Optional: enable token-based NATS auth by setting SP_NATS_TOKEN in .env and use the auth override:

docker-compose -f docker-compose.yml -f docker-compose.nats-auth.yml up -d

After all containers are successfully started just got to your browser and visit http://localhost to finish the installation. Once finished, switch to the pipeline editor and start the interactive tour or check the documentation to learn more about StreamPipes!

Stopping the default option is similarly easy:

docker-compose down
# if you want to remove mapped data volumes, run:
# docker-compose down -v

If you need the Kafka-based setup, start it with the dedicated Kafka compose file:

docker-compose -f docker-compose.kafka.yml up -d
# go to `http://localhost` after all services are started

Stopping the kafka option:

docker-compose -f docker-compose.kafka.yml down

Starting the minimal option is almost the same, just specify the docker-compose.minimal.yml file:

docker-compose -f docker-compose.minimal.yml up -d
# go to `http://localhost` after all services are started

Optional: enable token-based NATS auth in minimal mode:

docker-compose -f docker-compose.minimal.yml -f docker-compose.minimal.nats-auth.yml up -d

Stopping the minimal option:

docker-compose -f docker-compose.minimal.yml down

Update services

To actively pull the latest available Docker images use:

docker-compose pull
# docker-compose -f docker-compose.full.yml pull

Upgrade

To upgrade to another StreamPipes version, simply edit the SP_VERSION in the .env file.

SP_VERSION=<VERSION>

Bugs and Feature Requests

If you've found a bug or have a feature that you'd love to see in StreamPipes, feel free to create an issue i on GitHub.

Get help

Since we purely leverage Docker Compose, please see their documentation in case you want to find out more about their available commands.

If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our community channels:

And don't forget to follow us on Twitter!

Contribute

We welcome contributions to StreamPipes. If you are interested in contributing to StreamPipes, let us know! You'll get to know an open-minded and motivated team working together to build the next IIoT analytics toolbox.

Here are some first steps in case you want to contribute:

  • Subscribe to our dev mailing list dev-subscribe@streampipes.apache.org
  • Send an email, tell us about your interests and which parts of StreamPipes you'd like to contribute (e.g., core or UI)!
  • Ask for a mentor who helps you to understand the code base and guides you through the first setup steps
  • Find an issue on GitHub. which is tagged with a good first issue tag
  • Have a look at our developer wiki at https://cwiki.apache.org/confluence/display/STREAMPIPES to learn more about StreamPipes development.

Have fun!

Feedback

We'd love to hear your feedback! Subscribe to users@streampipes.apache.org

License

Apache License 2.0