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
Copy file name to clipboardExpand all lines: docs/quick-start.md
+27-21Lines changed: 27 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,11 @@ At the end of this section, you should have a full end-to-end Bullet instance wi
9
9
* Setup the [Web Service](ws/setup.md) talking to the topology and serving a schema for your UI using [bullet-service-0.0.1](https://github.com/yahoo/bullet-service/releases/tag/bullet-service-0.0.1)
10
10
* Setup the [UI](ui/setup.md) talking to the Web Service using [bullet-ui-0.1.0](https://github.com/yahoo/bullet-ui/releases/tag/v0.1.0)
11
11
12
-
Prerequisites:
12
+
**Prerequisites**
13
13
14
-
* You will need to be on an Unix-based system (Mac, Ubuntu ...) for most of these commands.
15
-
* You will need enough CPU and RAM on your machine to run about about 8-10 JVMs. You will be setting up a Storm cluster with multiple components, a couple of Jetty instances and a Node server.
16
-
* You will need [git](https://git-scm.com/downloads), [Maven 3](https://maven.apache.org/install.html) and [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) installed. The example will walk you through installing [Node.js](http://nodejs.org).
14
+
* You will need to be on an Unix-based system (Mac, Ubuntu ...) for most of these commands
15
+
* You will need enough CPU and RAM on your machine to run about about 8-10 JVMs. You will be setting up a Storm cluster with multiple components, a couple of Jetty instances and a Node server
16
+
* You will need [git](https://git-scm.com/downloads), [Maven 3](https://maven.apache.org/install.html) and [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) installed. The example will walk you through installing [Node.js](http://nodejs.org)
Launch each of the following components, in order and wait for the commands to go through. You will see a JVM being launched:
49
+
Launch each of the following components, in order and wait for the commands to go through. You may have to do these one at a time. You will see a JVM being launched for each one.
50
50
51
51
```bash
52
52
storm dev-zookeeper &
@@ -57,7 +57,7 @@ storm logviewer &
57
57
storm supervisor &
58
58
```
59
59
60
-
Once everything is up without errors, visit localhost:8080 and see if the Storm UI loads.
60
+
Once everything is up without errors, visit [http://localhost:8080](http://localhost:8080) and see if the Storm UI loads.
You should get a random record from Bullet produced by the custom spout that we plugged in.
119
119
120
+
!!! note "What is this data?"
121
+
122
+
This data is produced by the [custom Storm spout](https://github.com/yahoo/bullet-docs/blob/master/examples/storm/src/main/java/com/yahoo/bullet/storm/examples/RandomSpout.java) you packaged in Step 5. See [below](#storm-topology) for details.
Visit http://localhost:8800 to query your topology with the UI. See [UI usage](ui/usage.md) for some example queries and interactions using this UI. You see what the Schema means by visiting the Schema section.
181
+
Visit [http://localhost:8800](http://localhost:8800) to query your topology with the UI. See [UI usage](ui/usage.md) for some example queries and interactions using this UI. You see what the Schema means by visiting the Schema section.
178
182
179
183
!!! note "Running it remotely?"
180
184
181
185
If you access the UI from another machine than where your UI is actually running, you will need to edit ```config/env-settings.json```. Since the UI is a client-side app, the machine that your browser is running on will fetch the UI and attempt to use these settings to talk to the Web Service. Since they point to localhost by default, your browser will attempt to connect there and fail. An easy fix is to change ```localhost``` in your env-settings.json to point to the hostname where you will hosting the UI. This will be same UI you use in the browser.
182
186
183
-
!!! note "Bringing it all down"
184
-
185
-
To kill the Bullet topology, run ```storm kill bullet```
186
187
187
-
To kill the UI, run ```ps aux | grep [e]xpress-server | awk '{print $2}' | xargs kill```
188
+
## Teardown
188
189
189
-
To kill the Web Service, run ```ps aux | grep [e]xample_context | awk '{print $2}' | xargs kill```
190
+
To cleanup all the components we bought up:
190
191
191
-
To kill Storm, run ```ps aux | grep [a]pache-storm-1.0.3 | awk '{print $2}' | xargs kill```
@@ -206,13 +212,13 @@ storm jar bullet-storm-example-1.0-SNAPSHOT-jar-with-dependencies.jar \
206
212
--bullet-spout-parallelism 1 \
207
213
...
208
214
--bullet-spout-arg 20 \
209
-
--bullet-spout-arg 100 \
215
+
--bullet-spout-arg 101 \
210
216
...
211
217
```
212
218
213
-
This command launches the jar (an uber or "fat" jar) containing the custom spout code and all dependencies you built in Step 5. We pass the name of your spout class with ```--bullet-spout com.yahoo.bullet.storm.examples.RandomSpout``` to the Bullet main class ```com.yahoo.bullet.Topology``` with two arguments ```--bullet-spout-arg 20``` and ```--bullet-spout-arg 100```. The first argument tells the Spout to generate at most 20 tuples in a period and the second argument says a period is 100 ms long.
219
+
This command launches the jar (an uber or "fat" jar) containing the custom spout code and all dependencies you built in Step 5. We pass the name of your spout class with ```--bullet-spout com.yahoo.bullet.storm.examples.RandomSpout``` to the Bullet main class ```com.yahoo.bullet.Topology``` with two arguments ```--bullet-spout-arg 20``` and ```--bullet-spout-arg 101```. The first argument tells the Spout to generate at most 20 tuples in a period and the second argument says a period is 101 ms long.
214
220
215
-
The settings defined by ```--bullet-conf bullet_settings.yaml``` and the arguments here run all components in the topology with a parallelism of 1. So there will be one spout that is producing 200 tuples per second.
221
+
The settings defined by ```--bullet-conf bullet_settings.yaml``` and the arguments here run all components in the topology with a parallelism of 1. So there will be one spout that is producing ~200 tuples per second.
216
222
217
223
!!! note "I thought you said hundreds of thousands of records..."
0 commit comments