Skip to content

Commit

Permalink
Update README & .gitignore (linkedin#27)
Browse files Browse the repository at this point in the history
* Add prerequistes and update README

* Update .gitignore
  • Loading branch information
jogrogan authored Jun 7, 2023
1 parent f748776 commit 69014ae
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.gradle
.idea/
*/build/
*/*.iml
./models/external/
Expand Down
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ In order to deploy such a pipeline, you only need to write one SQL query, called

## Quick Start

### Prerequistes

1. `docker` is installed and docker daemon is running
2. `kubectl` is installed and cluster is running
1. `minikube` can be used for a local cluster
3. `helm` for Kubernetes is installed

### Run

```
$ make quickstart
... wait a while ...
Expand All @@ -43,7 +52,7 @@ In order to deploy such a pipeline, you only need to write one SQL query, called
Subscriptions are SQL views that are automatically materialized by a pipeline.

```
$ kubectl apply -f deploy/samples/subscription.yaml
$ kubectl apply -f deploy/samples/subscriptions.yaml
```

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

Expand Down

0 comments on commit 69014ae

Please sign in to comment.