Skip to content

Commit 036d866

Browse files
committed
Fixing quickstart and favicon
1 parent a643ad1 commit 036d866

File tree

6 files changed

+29
-28
lines changed

6 files changed

+29
-28
lines changed

docs/css/extra.css

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,3 @@
2020
.bs-sidebar .nav .nav > li > a {
2121
font-size: 100%;
2222
}
23-
24-
img {
25-
max-width: none;
26-
}
File renamed without changes.

docs/quick-start.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ At the end of this section, you should have a full end-to-end Bullet instance wi
99
* 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)
1010
* 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)
1111

12-
Prerequisites:
12+
**Prerequisites**
1313

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)
1717

1818
## Setting up Storm
1919

@@ -34,7 +34,7 @@ export BULLET_EXAMPLES=$BULLET_HOME/bullet-docs/examples
3434

3535
```bash
3636
cd $BULLET_HOME/backend
37-
wget http://apache.org/dist/storm/apache-storm-1.0.3/apache-storm-1.0.3.zip
37+
curl -O http://apache.org/dist/storm/apache-storm-1.0.3/apache-storm-1.0.3.zip
3838
unzip apache-storm-1.0.3.zip
3939
export PATH=$(pwd)/apache-storm-1.0.3/bin/:$PATH
4040
```
@@ -46,7 +46,7 @@ echo 'drpc.servers: ["127.0.0.1"]' >> apache-storm-1.0.3/conf/storm.yaml
4646

4747
#### Step 3: Launch Storm components
4848

49-
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.
5050

5151
```bash
5252
storm dev-zookeeper &
@@ -57,7 +57,7 @@ storm logviewer &
5757
storm supervisor &
5858
```
5959

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.
6161

6262
#### Step 4: Test Storm (Optional)
6363

@@ -117,21 +117,25 @@ curl -s -X POST -d '{}' http://localhost:3774/drpc/bullet
117117

118118
You should get a random record from Bullet produced by the custom spout that we plugged in.
119119

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.
123+
120124
## Setting up the Bullet Web Service
121125

122126
#### Step 7: Install Jetty
123127

124128
```bash
125129
cd $BULLET_HOME/service
126-
wget http://central.maven.org/maven2/org/eclipse/jetty/jetty-distribution/9.3.16.v20170120/jetty-distribution-9.3.16.v20170120.zip
130+
curl -O http://central.maven.org/maven2/org/eclipse/jetty/jetty-distribution/9.3.16.v20170120/jetty-distribution-9.3.16.v20170120.zip
127131
unzip jetty-distribution-9.3.16.v20170120.zip
128132
```
129133

130134
#### Step 8: Install the Bullet Web Service
131135

132136
```bash
133137
cd jetty-distribution-9.3.16.v20170120
134-
wget -O webapps/bullet-service.war http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.0.1/bullet-service-0.0.1.war
138+
curl -L0 webapps/bullet-service.war http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.0.1/bullet-service-0.0.1.war
135139
cp $BULLET_EXAMPLES/web-service/example_* $BULLET_HOME/service/jetty-distribution-9.3.16.v20170120
136140
```
137141

@@ -153,7 +157,7 @@ curl -s http://localhost:9999/bullet-service/api/columns
153157
#### Step 10: Install Node
154158

155159
```bash
156-
wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.1/install.sh | bash
160+
curl -s https://raw.githubusercontent.com/creationix/nvm/v0.33.1/install.sh | bash
157161
source ~/.bashrc
158162
nvm install v6.9.4
159163
nvm use v6.9.4
@@ -163,7 +167,7 @@ nvm use v6.9.4
163167

164168
```bash
165169
cd $BULLET_HOME/ui
166-
wget https://github.com/yahoo/bullet-ui/releases/download/v0.1.0/bullet-ui-v0.1.0.tar.gz
170+
curl -O https://github.com/yahoo/bullet-ui/releases/download/v0.1.0/bullet-ui-v0.1.0.tar.gz
167171
tar -xzf bullet-ui-v0.1.0.tar.gz
168172
cp $BULLET_EXAMPLES/ui/env-settings.json config/
169173
```
@@ -174,21 +178,23 @@ cp $BULLET_EXAMPLES/ui/env-settings.json config/
174178
PORT=8800 node express-server.js &
175179
```
176180

177-
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.
178182

179183
!!! note "Running it remotely?"
180184

181185
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.
182186

183-
!!! note "Bringing it all down"
184-
185-
To kill the Bullet topology, run ```storm kill bullet```
186187

187-
To kill the UI, run ```ps aux | grep [e]xpress-server | awk '{print $2}' | xargs kill```
188+
## Teardown
188189

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

191-
To kill Storm, run ```ps aux | grep [a]pache-storm-1.0.3 | awk '{print $2}' | xargs kill```
192+
| | |
193+
| -------------- | ------------------------------------------------------------------------ |
194+
| Storm Topology | ```storm kill bullet``` |
195+
| UI | ```ps aux | grep [e]xpress-server | awk '{print $2}' | xargs kill``` |
196+
| Web Service | ```ps aux | grep [e]xample_context | awk '{print $2}' | xargs kill``` |
197+
| Storm | ```ps aux | grep [a]pache-storm-1.0.3 | awk '{print $2}' | xargs kill``` |
192198

193199
## What did we do?
194200

@@ -206,13 +212,13 @@ storm jar bullet-storm-example-1.0-SNAPSHOT-jar-with-dependencies.jar \
206212
--bullet-spout-parallelism 1 \
207213
...
208214
--bullet-spout-arg 20 \
209-
--bullet-spout-arg 100 \
215+
--bullet-spout-arg 101 \
210216
...
211217
```
212218

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.
214220

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.
216222

217223
!!! note "I thought you said hundreds of thousands of records..."
218224

examples/storm/bin/launch.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ storm jar bullet-storm-example-1.0-SNAPSHOT-jar-with-dependencies.jar \
1414
--bullet-spout-on-heap-memory-load 128.0 \
1515
--bullet-spout-off-heap-memory-load 196.0 \
1616
--bullet-spout-arg 20 \
17-
--bullet-spout-arg 100 \
17+
--bullet-spout-arg 101 \
1818
-c topology.acker.executors=1 \
1919
-c topology.max.spout.pending=1000 \
2020
-c topology.backpressure.enable=false

examples/storm/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<snapshots>
1717
<enabled>false</enabled>
1818
</snapshots>
19-
<id>central</id>
19+
<id>jcenter</id>
2020
<name>bintray</name>
2121
<url>http://jcenter.bintray.com</url>
2222
</repository>

mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
theme: cinder
22

33
site_name: Bullet
4-
site_favicon: favicon.ico
54
repo_url: https://github.com/yahoo/bullet-docs
65

76
pages:

0 commit comments

Comments
 (0)