This is an automated email from the ASF dual-hosted git repository. riemer pushed a commit to branch dev in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-website.git
commit 444e3555c187ecfbe917064a850f3843320d9b75 Author: Dominik Riemer <[email protected]> AuthorDate: Sun May 2 21:58:42 2021 +0200 [STREAMPIPES-197] Copy docker-compose documentation from Github readme --- documentation/docs/05_deploy-docker.md | 68 +++++++++++++++++++++++++++++++++- 1 file changed, 67 insertions(+), 1 deletion(-) diff --git a/documentation/docs/05_deploy-docker.md b/documentation/docs/05_deploy-docker.md index 4ba8127..16b6ce1 100644 --- a/documentation/docs/05_deploy-docker.md +++ b/documentation/docs/05_deploy-docker.md @@ -4,4 +4,70 @@ title: Docker Deployment sidebar_label: Docker Deployment --- -tbd +StreamPipes Compose is a simple collection of user-friendly `docker-compose` files that easily lets gain first-hand experience with Apache StreamPipes. + +> **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](../cli). + +#### TL;DR: A one-liner to rule them all :-) + +```bash +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](https://streampipes.apache.org/docs/docs/user-guide-tour/) to learn how to create your first pipeline! + +## Prerequisites +* 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 10** (CMD, PowerShell, GitBash) + +**macOS** and **Windows 10** (Pro, Enterprise, Education) 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 two options to get you going: + +- **default**: a light-weight option with few pipeline elements, needs less memory +- **full**: contains more pipeline elements, requires **>16 GB RAM** (recommended) + +**Starting** the **default** 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. + +```bash +docker-compose up -d +# go to after all services are started http://localhost +``` +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 [online tour](https://streampipes.apache.org/docs/docs/user-guide-tour/) to learn how to create your first pipeline! + +**Stopping** the **default** option is similarly easy: +```bash +docker-compose down +# if you want to remove mapped data volumes, run: +# docker-compose down -v +``` + +Starting the **full** option is almost the same, just specify the `docker-compose.full.yml` file: +```bash +docker-compose -f docker-compose.full.yml up -d +# go to after all services are started http://localhost +``` +Stopping the **full** option: +```bash +docker-compose -f docker-compose.full.yml down +#docker-compose -f docker-compose.full.yml down -v +``` + +## Update services +To actively pull the latest available Docker images use: +```bash +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> +```
