Skip to content

Commit b2203e6

Browse files
committed
refactor: Use nats as default and clean up of installation configurations and readme
1 parent 8893b68 commit b2203e6

File tree

5 files changed

+35
-309
lines changed

5 files changed

+35
-309
lines changed

installer/compose/README.md

Lines changed: 19 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -36,24 +36,22 @@ Go to http://localhost to finish the installation in the browser. Once finished,
3636
* Docker-Compose >= 1.17.0 (Compose file format: 3.4)
3737
* Google Chrome (recommended), Mozilla Firefox, Microsoft Edge
3838

39-
Tested on: **macOS, Linux, Windows 10** (CMD, PowerShell, GitBash)
39+
Tested on: **macOS, Linux, Windows** (CMD, PowerShell, GitBash)
4040

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).
4242

4343
> **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.
4444
4545
## Usage
46-
We provide three options to get you going:
46+
We provide several options to get you going:
4747

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
5251

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`.
5553

56-
**Starting** the **default** option is as easy as simply running:
54+
**Starting** the **default (NATS)** option is as easy as simply running:
5755
> **NOTE**: Starting might take a while since `docker-compose up` also initially pulls all Docker images from Dockerhub.
5856
5957
```bash
@@ -69,35 +67,27 @@ docker-compose down
6967
# docker-compose down -v
7068
```
7169

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:
8171

82-
Starting the **full** option is almost the same, just specify the `docker-compose.full.yml` file:
8372
```bash
84-
docker-compose -f docker-compose.full.yml up -d
73+
docker-compose -f docker-compose.kafka.yml up -d
8574
# go to `http://localhost` after all services are started
8675
```
87-
Stopping the **full** option:
76+
77+
Stopping the **kafka** option:
78+
8879
```bash
89-
docker-compose -f docker-compose.full.yml down
80+
docker-compose -f docker-compose.kafka.yml down
9081
```
9182

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:
9384
```bash
94-
docker-compose -f docker-compose.quickstart.yml build script-runner
95-
docker-compose -f docker-compose.quickstart.yml up -d
85+
docker-compose -f docker-compose.minimal.yml up -d
9686
# go to `http://localhost` after all services are started
9787
```
98-
Stopping the **quickstart** option:
88+
Stopping the **minimal** option:
9989
```bash
100-
docker-compose -f docker-compose.quickstart.yml down
90+
docker-compose -f docker-compose.minimal.yml down
10191
```
10292

10393
## Update services
@@ -118,7 +108,7 @@ SP_VERSION=<VERSION>
118108
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).
119109

120110
## 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/).
122112

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

installer/compose/docker-compose.full.yml renamed to installer/compose/docker-compose.kafka.yml

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ services:
2626
# StreamPipes services
2727
backend:
2828
image: "${SP_DOCKER_REGISTRY}/backend:${SP_VERSION}"
29+
environment:
30+
- SP_PRIORITIZED_PROTOCOL=kafka
31+
- SP_HTTP_SERVER_ADAPTER_ENDPOINT=extensions-all-jvm:8090
2932
depends_on:
3033
- couchdb
3134
volumes:
@@ -37,8 +40,6 @@ services:
3740

3841
ui:
3942
image: "${SP_DOCKER_REGISTRY}/ui:${SP_VERSION}"
40-
environment:
41-
- SP_HTTP_SERVER_ADAPTER_ENDPOINT=extensions-all-jvm:8090
4243
ports:
4344
- "80:8088"
4445
depends_on:
@@ -109,31 +110,6 @@ services:
109110
networks:
110111
spnet:
111112

112-
jobmanager:
113-
image: fogsyio/flink:1.13.5-scala_2.11
114-
command: jobmanager
115-
environment:
116-
- JOB_MANAGER_RPC_ADDRESS=jobmanager
117-
logging: *default-logging
118-
restart: unless-stopped
119-
networks:
120-
spnet:
121-
122-
taskmanager:
123-
image: fogsyio/flink:1.13.5-scala_2.11
124-
depends_on:
125-
- jobmanager
126-
command: taskmanager
127-
links:
128-
- "jobmanager:jobmanager"
129-
environment:
130-
- JOB_MANAGER_RPC_ADDRESS=jobmanager
131-
- TASK_MANAGER_NUMBER_OF_TASK_SLOTS=20
132-
logging: *default-logging
133-
restart: unless-stopped
134-
networks:
135-
spnet:
136-
137113
# Lite version pipeline elements
138114
extensions-all-jvm:
139115
image: "${SP_DOCKER_REGISTRY}/extensions-all-jvm:${SP_VERSION}"
@@ -142,6 +118,7 @@ services:
142118
networks:
143119
spnet:
144120

121+
145122
volumes:
146123
backend:
147124
connect:
@@ -151,6 +128,8 @@ volumes:
151128
influxdb2:
152129
nginx:
153130

131+
154132
networks:
155133
spnet:
156134
driver: bridge
135+

installer/compose/docker-compose.nats.yml

Lines changed: 0 additions & 114 deletions
This file was deleted.

installer/compose/docker-compose.pulsar.yml

Lines changed: 0 additions & 109 deletions
This file was deleted.

0 commit comments

Comments
 (0)