Skip to content

Latest commit

 

History

History
218 lines (160 loc) · 8.83 KB

README.md

File metadata and controls

218 lines (160 loc) · 8.83 KB
Raw

Pravega Examples

Set of example applications to demonstrate the features and APIs of Pravega as well as potential use-case scenarios.

Pre-requisites

  1. Pravega running (see here for instructions)
  2. Build pravega-samples repository

Please note that after building pravega-samples, all the executables used here are located in:

pravega-samples/pravega-client-examples/build/install/pravega-client-examples

Examples Catalog

gettingstarted

This example consists of two applications, a HelloWorldReader that reads from a Stream, and a HelloWorldWriter that writes to a Stream.

Execution

First, execute HelloWorldWriterin a console:

$ bin/helloWorldWriter [-scope myScope] [-name myStream] [-uri tcp://127.0.0.1:9090] [-routingkey myRK] [-message 'hello world']

All args are optional, if not included, the defaults are:

  • scope - "examples"
  • name - "helloStream"
  • uri - "tcp://127.0.0.1" (the URI to one of the controller nodes
  • routingKey - "helloRoutingKey"
  • message - "hello world"

The program writes the given message with the given routing key to the Stream with given scope/stream name.

Then, execute HelloWorldReaderin another console:

$ bin/helloWorldReader [-scope myScope] [-name myStream] [-uri tcp://127.0.0.1:9090]

All args are optional, if not included, the defaults are:

  • scope - "examples"
  • name - "helloStream"
  • uri - "tcp://127.0.0.1" (the URI to one of the controller nodes

The program reads all the events from the Stream with given scope/stream name and prints each event to the console.

consolerw

This example includes two applications, a ConsoleReader and a ConsoleWriter. On the one hand, ConsoleReader continuously reads from a Stream and emits all of the events onto the console. Moreover, it allows you to select a StreamCut at a particular point, and then re-read existing events either from the head of the Stream until that point, or from that point to the end of the Stream.

On the other hand, ConsoleWriter can write to Streams or Transactions, and manage Transactions. This application uses the console to present an interactive DSL environment that presents operations to write events to a Stream or into a Transaction. In addition, it presents operations to begin, commit, abort, ping, check status on and retrieve the id of a Transaction.

Execution

You might want to run ConsoleReader in one window and ConsoleWriter in another window. To run ConsoleReader, you can execute the following command:

$ bin/consoleReader [-scope myScope] [-name myStream] [-uri tcp://127.0.0.1:9090]

All args are optional, if not included, the defaults are:

  • scope - "examples"
  • name - "someStream"
  • uri - "tcp://127.0.0.1" (the URI to one of the controller nodes

To run ConsoleWriter, please execute:

$ bin/consoleWriter [-scope myScope] [-name myStream] [-uri tcp://127.0.0.1:9090]

All args are optional, if not included, the defaults are:

  • scope - "examples"
  • name - "someStream"
  • uri - "tcp://127.0.0.1" (the URI to one of the controller nodes

noop

An example of a simple reader that continually reads the contents of any Stream. A binary serializer is used so it works against any event types. The sample emits basic information about number of events/bytes read every 30 seconds.

Execution

$ bin/noopReader [--uri tcp://127.0.0.1:9090] [--stream <SCOPE>/<STREAM>]

statesynchronizer

This example illustrates the use of the Pravega StateSynchronizer API. The application implements a SharedMap object using StateSynchronizer. We implement a SharedConfig object using the SharedMap. The SharedConfig simulates the idea of a properties configuration that needs to be kept in sync across multiple processes.

Execution

To demonstrate manipulating the properties of the SharedConfig object, we provide a CLI.

$ bin/sharedConfigCli [-scope myScope] [-name myStream] [-uri tcp://127.0.0.1:9090]

Use the simple DSL to GET, PUT, REMOVE keys from the SharedConfig object identified by scope and name. It is worthwhile to launch two or more separate CLIs in separate windows using the same settings and observe how changes in one CLI process are not visible in another CLI process until that other CLI process invokes REFRESH.

streamcuts

This application aims at demonstrating the use of StreamCuts for bounded processing on multiple Streams. At the moment, the application contains two examples accessible via command line interface: i) Simple example: The user decides which Stream slices s/he wants to read from all the Streams by specifying indexes, and the application prints these slices using ReaderGroupConfig methods for bounded processing. ii) Time series example: Streams are filled with events that are supposed to belong to a certain day with a given value: "day1:5". There is a variable number of events per day in each Stream. The user selects a day number, and the program makes use of BatchClient and StreamCuts to sum all the values from events in all Streams belonging to that day.

Execution

To demonstrate the use of StreamCuts, we provide a CLI. To use it, please execute:

$ bin/streamCutsCli [-scope myScope] [-name myStream] [-uri tcp://127.0.0.1:9090]

tables (ChatApplication)

This application aims to demonstrate the use of KeyValueTables, Streams andStreamCuts for implementing a "serverless" chat application (with Pravega being used as the sole "server" - there is no specialized chat server). The sample application allows defining users, chat channels and let users subscribe to those channels; it also enables uses to send messages to each other. Users receive messages in near-realtime and, upon logging in, get all the messages that they received while offline. Please refer to the ChatClientCli Javadoc for all supported commands within the application.

Execution

The ChatApplication can be run by means of a CLI. To use it, please execute:

$ bin/chatClientCli

secure

This example includes three applications SecureReader, SecureWriter and a SecureBatchReader which instantiate the corresponding Pravega clients on the data path. These applications illustrate how to setup clients connecting to a security-enabled Pravega cluster. Specifically, they show how to:

  • Enable SSL/TLS (HTTPS) communications with a Pravega cluster for data-in-transit encryption and server authentication.
  • Pass credentials to a Pravega cluster for client authentication and authorization.

Execution

First, ensure that the Pravega cluster that the applications are going to work with, has both TLS and Auth (authentication and authorization) enabled. See Pravega documentation for how to enable TLS and Auth.

Now, you might want to run SecureWriter in one window, SecureReader in another window and finally SecureBatchReader To run SecureWriter, you can execute the following command:

$ bin/secureWriter [-scope "myScope"] [-stream "myStream"] [-uri "tls://localhost:9090"] \
              [-routingkey "myKey"] [-message "hello world!"] \
              [-truststore "conf/cert.pem"] [-validatehost] \
              [-username "admin"] [-password "1111_aaaa"]

All args are optional. If not included, the defaults are:

  • scope - "myscope"
  • name - "mystream"
  • uri - "tls://localhost:9090" (the URI to one of the controller nodes)
  • routingkey - "myroutingkey"
  • message - "hello secure world!"
  • truststore - "conf/cert.pem"
  • username - "admin"
  • password - "1111_aaaa"

Note that, by default TLS host name verification is disabled. This is because the default server certificate for standalone mode, which is provided in the source, is not assigned to any specific server: enabling TLS host name verification when using that certificate will result in failure to communicate with the server. If your server(s) is/are using a CA-signed certificate which has the servers' DNS name or IP addresses, you may copy and use the CA's certificate as the truststore and enable hostname verification by specifying the flag [-validateHost].

To run SecureReader, you can execute:

$ bin/secureReader [-scope "myScope"] [-stream "myStream"] [-uri "tls://localhost:9090"] \
              [-truststore "conf/cert.pem"] [-validatehost] \
              [-username "admin"] [-password "1111_aaaa"]

To run SecureBatchReader, you can execute:

$ bin/secureBatchReader [-scope "myScope"] [-stream "myStream"] [-uri "tls://localhost:9090"] \
              [-truststore "conf/cert.pem"] [-validatehost] \
              [-username "admin"] [-password "1111_aaaa"]

All args are optional. If not included, the default values are same as the defaults mentioned earlier for bin\secureWriter.