Skip to content

Commit

Permalink
KSQL-473: point quickstart non-docker docs to release tarballs (#601)
Browse files Browse the repository at this point in the history
* KSQL-473: point quickstart non-docker docs to release tarballs

Point the quickstart non-docker instructions to the release tarball
on s3. Release tarballs are manually generated and uploaded to the
ksql-releases s3 bucket. This change also updates the instructions
accordingly.

Point the main readme to the release-tagged documentation.

* Move the doc links back inline

* Remove git step
  • Loading branch information
rodesai committed Jan 16, 2018
1 parent 1c4199b commit 7ce4942
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 20 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Click here to watch a screencast of the KSQL demo on YouTube.
# Quick Start
If you are ready to see the power of KSQL, try out these:

- [KSQL Quick Start](/docs/quickstart#quick-start): Demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka.
- [Clickstream Analysis Demo](/ksql-clickstream-demo#clickstream-analysis): Shows how to build an application that performs real-time user analytics.
- [KSQL Quick Start](https://github.com/confluentinc/ksql/tree/v0.3/docs/quickstart#quick-start): Demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka.
- [Clickstream Analysis Demo](https://github.com/confluentinc/ksql/tree/v0.3/ksql-clickstream-demo#clickstream-analysis): Shows how to build an application that performs real-time user analytics.

# Use Cases and Examples

Expand Down Expand Up @@ -61,7 +61,7 @@ CREATE TABLE error_counts AS


# Documentation
You can [find the KSQL documentation here](/docs#ksql-documentation).
You can [find the KSQL documentation here](https://github.com/confluentinc/ksql/tree/v0.3/docs#ksql-documentation)

# Join the Community
Whether you need help, want to contribute, or are just looking for the latest news, you can find out how to [connect with your fellow Confluent community members here](https://www.confluent.io/contact-us-thank-you/).
Expand All @@ -78,4 +78,3 @@ Contributions to the code, examples, documentation, etc, are very much appreciat
The project is licensed under the Apache License, version 2.0.

*Apache, Apache Kafka, Kafka, and associated open source project names are trademarks of the [Apache Software Foundation](https://www.apache.org/).*

24 changes: 8 additions & 16 deletions docs/quickstart/quickstart-non-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ This part of the quick start will guide you through the steps to setup a Kafka c
- KSQL is in developer preview. Do not run KSQL against a production cluster.
- [Confluent Platform 4.0.0](http://docs.confluent.io/current/installation.html) is installed. This installation includes a Kafka broker, ZooKeeper, Schema Registry, REST Proxy, and Kafka Connect.
- If you installed Confluent Platform via tar or zip, navigate into the installation directory. The paths and commands used throughout this quick start assume that your are in this installation directory.
- [Maven](https://maven.apache.org/install.html)
- [Git](https://git-scm.com/downloads)
- Java: Minimum version 1.8. Install Oracle Java JRE or JDK \>= 1.8 on your local machine

## Start Kafka
Expand Down Expand Up @@ -44,24 +42,20 @@ connect is [UP]

## Start KSQL

1. Clone the Confluent KSQL repository.
1. Download the [KSQL 0.3 release tarball](https://s3-us-west-2.amazonaws.com/ksql-releases/releases/0.3/ksql.tgz).

1. Unpack the release tarball.

```bash
$ git clone git@github.com:confluentinc/ksql.git
$ tar -xzf ksql.tgz
```

1. Change directory to the `ksql` directory and compile the code.
1. Change directory to the `ksql` directory.

```bash
$ cd ksql
$ git checkout v0.3 -b 0.3
$ mvn clean compile install -DskipTests
```

> Tip: When using a Maven proxy or mirror, such as Artifactory, make sure that it is correctly configured to
> retrieve snapshot artifacts and access snapshot repositories. For more information, see
> [Could not find artifact](https://github.com/confluentinc/ksql/issues/537).
1. Start KSQL. The `local` argument starts KSQL in [standalone mode](/docs/concepts.md#modes-of-operation).

```bash
Expand All @@ -82,20 +76,18 @@ Minimally, to use the [quick start exercises](/docs/quickstart#quick-start), you
1. Produce Kafka data to the `pageviews` topic using the data generator. The following example continuously generates data with a value in DELIMITED format.

```bash
$ java -jar ksql-examples/target/ksql-examples-4.1.0-SNAPSHOT-standalone.jar \
quickstart=pageviews format=delimited topic=pageviews maxInterval=10000
$ ./bin/ksql-datagen quickstart=pageviews format=delimited topic=pageviews maxInterval=10000
```

1. Produce Kafka data to the `users` topic using the data generator. The following example continuously generates data with a value in JSON format.

```bash
$ java -jar ksql-examples/target/ksql-examples-4.1.0-SNAPSHOT-standalone.jar \
quickstart=users format=json topic=users maxInterval=10000
$ ./bin/ksql-datagen quickstart=users format=json topic=users maxInterval=10000
```

Optionally, you can return to the [main KSQL quick start page](/docs/quickstart#quick-start) to start querying the Kafka cluster. Or you can do additional testing with topic data produced from the command line tools.

1. You can produce Kafka data with the Kafka command line `kafka-console-producer`. The following example generates data with a value in DELIMITED format.
1. You can produce Kafka data with the Kafka command line `kafka-console-producer` provided with the Confluent Platform. The following example generates data with a value in DELIMITED format.

```bash
$ kafka-console-producer --broker-list localhost:9092 \
Expand Down

0 comments on commit 7ce4942

Please sign in to comment.