Skip to content

Commit

Permalink
Updating docs to Bullet UI 0.4.0 and Bullet Core 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
akshaisarma committed Aug 22, 2017
1 parent 6de4225 commit c4586a8
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ This list is neither comprehensive nor in any particular order and lists some hi

| Feature | Components | Description | Status |
|-------------------- | ----------- | ------------------------- | ------------- |
| Pub-Sub Queue | BE, WS, UI | WS and BE talk through the pub/sub. Bullet Storm uses Storm DRPC for this, which is request-response. Using a pub/sub queue will let us implement Bullet on other Stream Processors, support incremental updates through WebSockets and more! | In Progress |
| Incremental updates | BE, WS, UI | Push results back to users as soon as they arrive. Monoidal operations implies additive, so progressive results can be streamed back. Micro-batching and other features come into play | In Progress |
| PubSub | BE, WS, UI | WS and BE talk through the PubSub. Bullet Storm uses Storm DRPC for this (strictly request-response) Using a pub/sub queue will let us implement Bullet on other Stream Processors, support incremental updates through WebSockets and more! | In Progress [#1](https://github.com/yahoo/bullet-core/pull/1) |
| Incremental updates | BE, WS, UI | Push results back to users as soon as they arrive. Our aggregations are additive, so progressive results can be streamed back. Micro-batching and other features come into play | In Progress |
| Security | WS, UI | The obvious enterprise security for locking down access to the data and the instance of Bullet. Considering SSL, Kerberos, LDAP etc. | Planning |
| Bullet on X | BE | With the pub/sub feature, Bullet can be implemented on other Stream Processors like Spark Streaming, Flink, Kafka Streaming, Samza etc | Open |
| SQL API | BE, WS | WS supports an endpoint that converts a SQL-like query into Bullet queries | Open |
Expand Down
3 changes: 3 additions & 0 deletions docs/about/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ The core Bullet logic (a library) that can be used to implement Bullet on differ

| Date | Release | Highlights |
| ------------ | --------------------------------------------------------------------------------- | ---------- |
| 2016-08-16 | [**0.2.0**](https://github.com/yahoo/bullet-core/releases/tag/bullet-core-0.2.0) | PubSub interfaces and classes to implement custom communication between API and backend |
| 2016-06-27 | [**0.1.2**](https://github.com/yahoo/bullet-core/releases/tag/bullet-core-0.1.2) | Changes to the BulletConfig interface previously used in Bullet Storm. Users now use BulletStormConfig instead but YAML config is the same |
| 2016-06-27 | [**0.1.1**](https://github.com/yahoo/bullet-core/releases/tag/bullet-core-0.1.1) | First stable release containing the core of Bullet as a library including parsing, implementing queries, creating results, DataSketches etc |

Expand Down Expand Up @@ -111,6 +112,8 @@ The Bullet UI that lets you build, run, save and visualize results from Bullet.

| Date | Release | Highlights |
| ------------ | -------------------------------------------------------------------------------------- | ---------- |
| 2016-08-22 | [**0.4.0**](https://github.com/yahoo/bullet-ui/releases/tag/v0.4.0) | Query sharing, collapsible Raw view, and unsaved/error indicators. Settings rename and other bug fixes|
| 2016-05-22 | [**0.3.2**](https://github.com/yahoo/bullet-ui/releases/tag/v0.3.2) | Exporting to TSV in Pivot table. Fixes unselectability bug in Raw view |
| 2016-05-15 | [**0.3.1**](https://github.com/yahoo/bullet-ui/releases/tag/v0.3.1) | Adds styles to the Pivot table. Fixes some minor UI interactions |
| 2016-05-10 | [**0.3.0**](https://github.com/yahoo/bullet-ui/releases/tag/v0.3.0) | Adds Charting and Pivoting support. Migrations enhanced. Support for overriding nested default settings |
| 2016-05-03 | [**0.2.2**](https://github.com/yahoo/bullet-ui/releases/tag/v0.2.2) | Fixes maxlength of the input for points |
Expand Down
8 changes: 4 additions & 4 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ At the end of this section, you will have:

* Setup the Bullet topology using a custom spout on [bullet-storm-0.5.0](https://github.com/yahoo/bullet-storm/releases/tag/bullet-storm-0.5.0)
* 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)
* Setup the [UI](ui/setup.md) talking to the Web Service using [bullet-ui-0.3.2](https://github.com/yahoo/bullet-ui/releases/tag/v0.3.2)
* Setup the [UI](ui/setup.md) talking to the Web Service using [bullet-ui-0.4.0](https://github.com/yahoo/bullet-ui/releases/tag/v0.4.0)

**Prerequisites**

Expand All @@ -19,7 +19,7 @@ At the end of this section, you will have:
Simply run:

```bash
curl -sLo- https://raw.githubusercontent.com/yahoo/bullet-docs/v0.3.3/examples/install-all.sh | bash
curl -sLo- https://raw.githubusercontent.com/yahoo/bullet-docs/v0.3.4/examples/install-all.sh | bash
```

This will setup a local Storm cluster, a Bullet running on it, the Bullet Web Service and a Bullet UI for you. Once everything has launched, you should be able to go to the Bullet UI running locally at [http://localhost:8800](http://localhost:8800). You can then [**continue this guide from here**](#what-did-we-do).
Expand All @@ -42,7 +42,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/yahoo/bullet-docs/releases/download/v0.3.3/examples_artifacts.tar.gz
curl -LO https://github.com/yahoo/bullet-docs/releases/download/v0.3.4/examples_artifacts.tar.gz
tar -xzf examples_artifacts.tar.gz
export BULLET_EXAMPLES=$BULLET_HOME/bullet-examples
```
Expand Down Expand Up @@ -233,7 +233,7 @@ Visit [http://localhost:8800](http://localhost:8800) to query your topology with
If you were using the [Install Script](#install-script) or if you don't want to manually bring down everything, you can run:

```bash
curl -sLo- https://raw.githubusercontent.com/yahoo/bullet-docs/v0.3.3/examples/install-all.sh | bash -s cleanup
curl -sLo- https://raw.githubusercontent.com/yahoo/bullet-docs/v0.3.4/examples/install-all.sh | bash -s cleanup
```

If you were performing the steps yourself, you can also manually cleanup **all the components and all the downloads** using:
Expand Down
4 changes: 2 additions & 2 deletions examples/install-all.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

set -euo pipefail

BULLET_EXAMPLES_VERSION=0.3.3
BULLET_UI_VERSION=0.3.2
BULLET_EXAMPLES_VERSION=0.3.4
BULLET_UI_VERSION=0.4.0
BULLET_WS_VERSION=0.0.1
JETTY_VERSION=9.3.16.v20170120
STORM_VERSION=1.0.3
Expand Down

0 comments on commit c4586a8

Please sign in to comment.