You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Google Chrome (recommended), Mozilla Firefox, Microsoft Edge
38
38
39
-
Tested on: **macOS, Linux, Windows 10** (CMD, PowerShell, GitBash)
39
+
Tested on: **macOS, Linux, Windows** (CMD, PowerShell, GitBash)
40
40
41
-
**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).
41
+
**macOS** and **Windows** users can easily get Docker and Docker-Compose on their systems by installing **Docker for Mac/Windows** (recommended).
42
42
43
43
> **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.
44
44
45
45
## Usage
46
-
We provide three options to get you going:
46
+
We provide several options to get you going:
47
47
48
-
-**default**: the standard installation, uses Kafka as internal message broker (recommended)
49
-
-**nats**: the standard installation which uses Nats as message broker (recommended for new installations)
50
-
-**full**: contains experimental Flink wrappers
51
-
-**quickstart**: contains pre-configured sample assets, including pipelines, dashboards, and data views. We recommend first-time StreamPipes users to use the Quickstart mode to experience the convenience of StreamPipes in IIoT! (Recommended for first-time users)
48
+
-**default**: the standard installation, uses NATS as internal message broker (recommended for new installations)
49
+
-**kafka**: starts the Kafka-based setup via `docker-compose.kafka.yml`
50
+
-**minimal**: contains only a minimal set of adapters, processors and sinks for iiot use cases
52
51
53
-
The ``nats`` version will become the default version in a later release. You can already try it for new installations,
54
-
but there's not yet an automatic migration from current Kafka-based installations to Nats.
52
+
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`.
55
53
56
-
**Starting** the **default** option is as easy as simply running:
54
+
**Starting** the **default (NATS)** option is as easy as simply running:
57
55
> **NOTE**: Starting might take a while since `docker-compose up` also initially pulls all Docker images from Dockerhub.
58
56
59
57
```bash
@@ -69,35 +67,27 @@ docker-compose down
69
67
# docker-compose down -v
70
68
```
71
69
72
-
Starting the **nats** option works as follows:
73
-
```bash
74
-
docker-compose -f docker-compose.nats.yml up -d
75
-
# go to `http://localhost` after all services are started
76
-
```
77
-
Stopping the **nats** option:
78
-
```bash
79
-
docker-compose -f docker-compose.nats.yml down
80
-
```
70
+
If you need the Kafka-based setup, start it with the dedicated Kafka compose file:
81
71
82
-
Starting the **full** option is almost the same, just specify the `docker-compose.full.yml` file:
83
72
```bash
84
-
docker-compose -f docker-compose.full.yml up -d
73
+
docker-compose -f docker-compose.kafka.yml up -d
85
74
# go to `http://localhost` after all services are started
86
75
```
87
-
Stopping the **full** option:
76
+
77
+
Stopping the **kafka** option:
78
+
88
79
```bash
89
-
docker-compose -f docker-compose.full.yml down
80
+
docker-compose -f docker-compose.kafka.yml down
90
81
```
91
82
92
-
We introduce quickstart deployment that comes with a set of predefined StreamPipes assets, to use the quickstart mode, just build the Docker image and start **quickstart** option:
83
+
Starting the **minimal** option is almost the same, just specify the `docker-compose.full.yml` file:
docker-compose -f docker-compose.quickstart.yml up -d
85
+
docker-compose -f docker-compose.minimal.yml up -d
96
86
# go to `http://localhost` after all services are started
97
87
```
98
-
Stopping the **quickstart** option:
88
+
Stopping the **minimal** option:
99
89
```bash
100
-
docker-compose -f docker-compose.quickstart.yml down
90
+
docker-compose -f docker-compose.minimal.yml down
101
91
```
102
92
103
93
## Update services
@@ -118,7 +108,7 @@ SP_VERSION=<VERSION>
118
108
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](https://github.com/apache/streampipes/issues).
119
109
120
110
## Get help
121
-
Since we purely levarage Docker Compose, please see their [documentation](https://docs.docker.com/compose/) in case you want to find out more about their available [commands](https://docs.docker.com/compose/reference/overview/).
111
+
Since we purely levarge Docker Compose, please see their [documentation](https://docs.docker.com/compose/) in case you want to find out more about their available [commands](https://docs.docker.com/compose/reference/overview/).
122
112
123
113
If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our community channels:
0 commit comments