Skip to content

Commit 69014ae

Browse files
authored
Update README & .gitignore (#27)
* Add prerequistes and update README * Update .gitignore
1 parent f748776 commit 69014ae

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.gradle
2+
.idea/
23
*/build/
34
*/*.iml
45
./models/external/

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ In order to deploy such a pipeline, you only need to write one SQL query, called
3030

3131
## Quick Start
3232

33+
### Prerequistes
34+
35+
1. `docker` is installed and docker daemon is running
36+
2. `kubectl` is installed and cluster is running
37+
1. `minikube` can be used for a local cluster
38+
3. `helm` for Kubernetes is installed
39+
40+
### Run
41+
3342
```
3443
$ make quickstart
3544
... wait a while ...
@@ -43,7 +52,7 @@ In order to deploy such a pipeline, you only need to write one SQL query, called
4352
Subscriptions are SQL views that are automatically materialized by a pipeline.
4453

4554
```
46-
$ kubectl apply -f deploy/samples/subscription.yaml
55+
$ kubectl apply -f deploy/samples/subscriptions.yaml
4756
```
4857

4958
In response, the operator will deploy a Flink job and other resources:
@@ -60,7 +69,7 @@ You can verify the job is running by inspecting the output:
6069
```
6170
$ ./bin/hoptimator
6271
> !tables
63-
> SELECT * FROM RAWKAFKA."sample-subscription-1" LIMIT 5;
72+
> SELECT * FROM RAWKAFKA."products" LIMIT 5;
6473
> !q
6574
```
6675

0 commit comments

Comments
 (0)