Skip to content

Commit

Permalink
Quick start update (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
akshaisarma authored Nov 30, 2018
1 parent 5f7dc16 commit d9aae3d
Show file tree
Hide file tree
Showing 11 changed files with 37 additions and 41 deletions.
16 changes: 8 additions & 8 deletions docs/about/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ If you have any issues with any of the particular Bullet sub-components, feel fr

| | |
| ------------- | ------ |
| Storm | [https://github.com/bullet-db/bullet-storm/issues](https://github.com/bullet-db/bullet-storm/issues) |
| Spark | [https://github.com/bullet-db/bullet-spark/issues](https://github.com/bullet-db/bullet-spark/issues) |
| Web Service | [https://github.com/bullet-db/bullet-service/issues](https://github.com/bullet-db/bullet-service/issues) |
| UI | [https://github.com/bullet-db/bullet-ui/issues](https://github.com/bullet-db/bullet-ui/issues) |
| Record | [https://github.com/bullet-db/bullet-record/issues](https://github.com/bullet-db/bullet-record/issues) |
| Core | [https://github.com/bullet-db/bullet-core/issues](https://github.com/bullet-db/bullet-core/issues) |
| Kafka PubSub | [https://github.com/bullet-db/bullet-kafka/issues](https://github.com/bullet-db/bullet-kafka/issues) |
| Documentation | [https://github.com/bullet-db/bullet-docs/issues](https://github.com/bullet-db/bullet-docs/issues) |
| Storm | [https://github.com/bullet-db/bullet-storm/issues](https://github.com/bullet-db/bullet-storm/issues) |
| Spark | [https://github.com/bullet-db/bullet-spark/issues](https://github.com/bullet-db/bullet-spark/issues) |
| Web Service | [https://github.com/bullet-db/bullet-service/issues](https://github.com/bullet-db/bullet-service/issues) |
| UI | [https://github.com/bullet-db/bullet-ui/issues](https://github.com/bullet-db/bullet-ui/issues) |
| Record | [https://github.com/bullet-db/bullet-record/issues](https://github.com/bullet-db/bullet-record/issues) |
| Core | [https://github.com/bullet-db/bullet-core/issues](https://github.com/bullet-db/bullet-core/issues) |
| Kafka PubSub | [https://github.com/bullet-db/bullet-kafka/issues](https://github.com/bullet-db/bullet-kafka/issues) |
| Documentation | [https://github.com/bullet-db/bullet-db.github.io/issues](https://github.com/bullet-db/bullet-db.github.io/issues) |

## Mailing Lists

Expand Down
1 change: 0 additions & 1 deletion docs/apidocs/bullet-ui/0.6.0/index.html

This file was deleted.

1 change: 0 additions & 1 deletion docs/apidocs/bullet-ui/0.6.1/index.html

This file was deleted.

4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ Bullet queries allow you to filter, project and aggregate data. You can also spe

* See the [UI Usage section](ui/usage.md) for using the UI to build Bullet queries. This is the same UI you will build in the Quick Starts.

* See the API section ([JSON](ws/api-json.md), [BQL](ws/api-bql.md)) for building Bullet API queries
* See the API section ([BQL](ws/api-bql.md), or the more verbose, underlying query format - [JSON](ws/api-json.md)) for building Bullet API queries

* For examples using the API, see [Examples](ws/examples.md). These are actual albeit cleansed queries sourced from the instance at Yahoo.

## Termination conditions

A Bullet query terminates and returns whatever has been collected so far when:

1. A maximum duration is reached. In other words, a query runs for a defined time window.
1. A maximum duration is reached. In other words, a query runs for a defined time window (which can be infinite).
2. A maximum number of records is reached (only applicable for queries that are fetching raw data records and not aggregating).

## Filters
Expand Down
12 changes: 6 additions & 6 deletions docs/quick-start/spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ mkdir -p $BULLET_HOME/pubsub
mkdir -p $BULLET_HOME/service
mkdir -p $BULLET_HOME/ui
cd $BULLET_HOME
curl -LO https://github.com/bullet-db/bullet-db.github.io/releases/download/v0.5.2/examples_artifacts.tar.gz
curl -LO https://github.com/bullet-db/bullet-db.github.io/releases/download/v0.6.0/examples_artifacts.tar.gz
tar -xzf examples_artifacts.tar.gz
export BULLET_EXAMPLES=$BULLET_HOME/bullet-examples
```
Expand All @@ -50,7 +50,7 @@ For this instance of Bullet we will use the Kafka PubSub implementation found in

```bash
cd $BULLET_HOME/pubsub
curl -Lo bullet-kafka.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-kafka/0.3.0/bullet-kafka-0.3.0-fat.jar
curl -Lo bullet-kafka.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-kafka/0.3.2/bullet-kafka-0.3.2-fat.jar
curl -LO https://archive.apache.org/dist/kafka/0.11.0.1/kafka_2.12-0.11.0.1.tgz
tar -xzf kafka_2.12-0.11.0.1.tgz
export KAFKA_DIR=$BULLET_HOME/pubsub/kafka_2.12-0.11.0.1
Expand Down Expand Up @@ -96,7 +96,7 @@ tar -xzf spark-2.2.1-bin-hadoop2.7.tgz

```bash
cp $BULLET_HOME/bullet-examples/backend/spark/* $BULLET_SPARK
curl -Lo bullet-spark.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-spark/0.1.2/bullet-spark-0.1.2-standalone.jar
curl -Lo bullet-spark.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-spark/0.2.1/bullet-spark-0.2.1-standalone.jar
```

#### Step 8: Launch the Bullet Spark Backend
Expand All @@ -121,7 +121,7 @@ The Backend will usually be up and running usually within 5-10 seconds. Once it

```bash
cd $BULLET_HOME/service
curl -Lo bullet-service.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.2.1/bullet-service-0.2.1-embedded.jar
curl -Lo bullet-service.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.4.3/bullet-service-0.4.3-embedded.jar
cp $BULLET_EXAMPLES/web-service/example_kafka_pubsub_config.yaml $BULLET_HOME/service/
cp $BULLET_EXAMPLES/web-service/example_columns.json $BULLET_HOME/service/
```
Expand Down Expand Up @@ -174,8 +174,8 @@ nvm use v6.9.4
#### Step 13: Install the Bullet UI

```bash
curl -LO https://github.com/bullet-db/bullet-ui/releases/download/v0.5.0/bullet-ui-v0.5.0.tar.gz
tar -xzf bullet-ui-v0.5.0.tar.gz
curl -LO https://github.com/bullet-db/bullet-ui/releases/download/v0.6.1/bullet-ui-v0.6.1.tar.gz
tar -xzf bullet-ui-v0.6.1.tar.gz
cp $BULLET_EXAMPLES/ui/env-settings.json config/
```

Expand Down
16 changes: 8 additions & 8 deletions docs/quick-start/storm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ This section gets you running a mock instance of Bullet to play around with. The

At the end of this section, you will have:

* Setup the Bullet topology using a custom spout on [bullet-storm-0.8.3](https://github.com/bullet-db/bullet-storm/releases/tag/bullet-storm-0.8.3)
* Setup the [Web Service](../ws/setup.md) talking to the topology and serving a schema for your UI using [bullet-service-0.3.0](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.3.0)
* Setup the [REST PubSub](../pubsub/rest.md) talking to the topology and Web Service using [bullet-core-0.4.2](https://github.com/bullet-db/bullet-core/releases/tag/bullet-core-0.4.2).
* Setup the [UI](../ui/setup.md) talking to the Web Service using [bullet-ui-0.5.0](https://github.com/bullet-db/bullet-ui/releases/tag/v0.5.0)
* Setup the Bullet topology using a custom spout on [bullet-storm-0.8.5](https://github.com/bullet-db/bullet-storm/releases/tag/bullet-storm-0.8.5)
* Setup the [Web Service](../ws/setup.md) talking to the topology and serving a schema for your UI using [bullet-service-0.4.3](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.3)
* Setup the [REST PubSub](../pubsub/rest.md) talking to the topology and Web Service using [bullet-core-0.6.4](https://github.com/bullet-db/bullet-core/releases/tag/bullet-core-0.6.4).
* Setup the [UI](../ui/setup.md) talking to the Web Service using [bullet-ui-0.6.1](https://github.com/bullet-db/bullet-ui/releases/tag/v0.6.1)

**Prerequisites**

Expand Down Expand Up @@ -43,7 +43,7 @@ mkdir -p $BULLET_HOME/backend/storm
mkdir -p $BULLET_HOME/service
mkdir -p $BULLET_HOME/ui
cd $BULLET_HOME
curl -LO https://github.com/bullet-db/bullet-db.github.io/releases/download/v0.5.2/examples_artifacts.tar.gz
curl -LO https://github.com/bullet-db/bullet-db.github.io/releases/download/v0.6.0/examples_artifacts.tar.gz
tar -xzf examples_artifacts.tar.gz
export BULLET_EXAMPLES=$BULLET_HOME/bullet-examples
```
Expand Down Expand Up @@ -133,7 +133,7 @@ Visit the UI and see if the topology is up. You should see the ```DataSource```

```bash
cd $BULLET_HOME/service
curl -Lo bullet-service.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.3.0/bullet-service-0.3.0-embedded.jar
curl -Lo bullet-service.jar http://jcenter.bintray.com/com/yahoo/bullet/bullet-service/0.4.3/bullet-service-0.4.3-embedded.jar
cp $BULLET_EXAMPLES/web-service/example* $BULLET_HOME/service/
```

Expand Down Expand Up @@ -168,8 +168,8 @@ nvm use v6.9.4

```bash
cd $BULLET_HOME/ui
curl -LO https://github.com/bullet-db/bullet-ui/releases/download/src/bullet-ui-v0.5.0.tar.gz
tar -xzf bullet-ui-v0.5.0.tar.gz
curl -LO https://github.com/bullet-db/bullet-ui/releases/download/src/bullet-ui-v0.6.1.tar.gz
tar -xzf bullet-ui-v0.6.1.tar.gz
cp $BULLET_EXAMPLES/ui/env-settings.json config/
```

Expand Down
2 changes: 1 addition & 1 deletion docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ The Web Service implementation that can serve a static schema from a file and ta

| Date | Release | Highlights | APIDocs |
| ------------ | -------------------------------------------------------------------------------------- | ---------- | ------- |
| 2018-11-28 | [**0.4.4**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.3) | Updates bullet-bql to 0.2.1 | [JavaDocs](apidocs/bullet-service/0.4.3/index.html) |
| 2018-11-28 | [**0.4.3**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.3) | Updates bullet-bql to 0.2.1 | [JavaDocs](apidocs/bullet-service/0.4.3/index.html) |
| 2018-11-26 | [**0.4.2**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.2) | BQL to JSON endpoint, dead backend reaper, new types in Schema, bullet-core 0.6.4 | [JavaDocs](apidocs/bullet-service/0.4.2/index.html) |
| 2018-09-06 | [**0.4.1**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.1) | Max Queries limit and bullet-bql 0.1.2 | [JavaDocs](apidocs/bullet-service/0.4.1/index.html) |
| 2018-07-17 | [**0.4.0**](https://github.com/bullet-db/bullet-service/releases/tag/bullet-service-0.4.0) | Enhanced Web Service to support BQL queries | [JavaDocs](apidocs/bullet-service/0.4.0/index.html) |
Expand Down
4 changes: 1 addition & 3 deletions docs/ws/api-bql.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,7 @@ and `limit_clause` is one of

* **String**: character string which can have escapes. Example: `'this is a string'`, `'this is ''another'' string'`.

* **ColumnReference**: representation of a single column. Unquoted ColumnReference must start with a letter or `_`. Example: `column_name`.

* **Dereference**: representation of a column field. Example: `column_name.field_name`.
* **ColumnReference**: representation of a column field. Unquoted ColumnReference must start with a letter or `_`. Example: `column_name` or `column_name.foo` or `column_name.foo.bar` or `column_name.0.bar`.

* **All**: representation of all columns. Example: `*`. `column_name.*` is interpreted as `column_name`.

Expand Down
10 changes: 5 additions & 5 deletions examples/install-all-spark.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

set -euo pipefail

BULLET_EXAMPLES_VERSION=0.5.2
BULLET_UI_VERSION=0.5.0
BULLET_WS_VERSION=0.3.0
BULLET_KAFKA_VERSION=0.3.0
BULLET_SPARK_VERSION=0.1.2
BULLET_EXAMPLES_VERSION=0.6.0
BULLET_UI_VERSION=0.6.1
BULLET_WS_VERSION=0.4.3
BULLET_KAFKA_VERSION=0.3.2
BULLET_SPARK_VERSION=0.2.1
KAFKA_VERSION=0.11.0.1
SPARK_VERSION=2.2.1
NVM_VERSION=0.33.1
Expand Down
6 changes: 3 additions & 3 deletions examples/install-all-storm.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

set -euo pipefail

BULLET_EXAMPLES_VERSION=0.5.2
BULLET_UI_VERSION=0.5.0
BULLET_WS_VERSION=0.3.0
BULLET_EXAMPLES_VERSION=0.6.0
BULLET_UI_VERSION=0.6.1
BULLET_WS_VERSION=0.4.3
STORM_VERSION=1.2.2
NVM_VERSION=0.33.1
NODE_VERSION=6.9.4
Expand Down
6 changes: 3 additions & 3 deletions examples/storm/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<bullet.storm.version>0.8.3</bullet.storm.version>
<bullet.core.version>0.4.2</bullet.core.version>
<bullet.record.version>0.2.0</bullet.record.version>
<bullet.storm.version>0.8.5</bullet.storm.version>
<bullet.core.version>0.6.4</bullet.core.version>
<bullet.record.version>0.3.0</bullet.record.version>
<storm.version>1.1.3</storm.version>
</properties>

Expand Down

0 comments on commit d9aae3d

Please sign in to comment.