[GitHub] storm pull request: STORM-561: Add flux as an external module

[HeartSaVioR <gi...@git.apache.org>]

Github user HeartSaVioR commented on a diff in the pull request:

    https://github.com/apache/storm/pull/546#discussion_r31396529
  
    --- Diff: external/flux/flux-examples/README.md ---
    @@ -0,0 +1,68 @@
    +# Flux Examples
    +A collection of examples illustrating various capabilities.
    +
    +## Building From Source and Running
    +
    +Checkout the projects source and perform a top level Maven build (i.e. from the `flux` directory):
    +
    +```bash
    +git clone https://github.com/apache/storm.git
    +cd storm
    +mvn install -DskipTests=true
    +```
    +
    +This will create a shaded (i.e. "fat" or "uber") jar in the `external/flux/flux-examples/target` directory that can run/deployed with
    +the `storm` command:
    +
    +```bash
    +cd flux-examples
    +storm jar ./target/flux-examples-*-SNAPSHOT.jar org.apache.storm.flux.Flux --local ./src/main/resources/simple_wordcount.yaml
    +```
    +
    +The example YAML files are also packaged in the examples jar, so they can also be referenced with Flux's `--resource`
    +command line switch:
    +
    +```bash
    +storm jar ./target/flux-examples-*.jar org.apache.storm.flux.Flux --local --resource /simple_wordcount.yaml
    +```
    +
    +## Available Examples
    +
    +### [simple_wordcount.yaml](src/main/resources/simple_wordcount.yaml)
    +
    +This is a very basic wordcount example using Java spouts and bolts. It simply logs the running count of each word
    +received.
    +
    +### [multilang.yaml](src/main/resources/multilang.yaml)
    +
    +Another wordcount example that uses a spout written in JavaScript (node.js), a bolt written in Python, and two bolts
    +written in java.
    +
    +### [kafka_spout.yaml](src/main/resources/kafka_spout.yaml)
    +This example illustrates how to configure Storm's `storm-kafka` spout using Flux YAML DSL `components`, `references`,
    +and `constructor arguments` constructs.
    +
    +### [simple_hdfs.yaml](src/main/resources/simple_hdfs.yaml)
    +
    +This example demonstrates using Flux to setup a storm-hdfs bolt to write to an HDFS cluster. It also demonstrates Flux's
    +variable substitution/filtering feature.
    +
    +To run the `simple_hdfs.yaml` example, copy the `hdfs_bolt.properties` file to a convenient location and change, at
    +least, the property `hdfs.url` to point to a HDFS cluster. Then you can run the example something like:
    +
    +```bash
    +storm jar ./target/flux-examples-*.jar org.apache.storm.flux.Flux --local ./src/main/resources/simple_hdfs.yaml --filter my_hdfs_bolt.properties
    +```
    +
    +### [simple_hbase.yaml](src/main/resources/simple_hbase.yaml)
    +
    +This example illustrates how to use Flux to setup a storm-hbase bolt to write to HBase.
    +
    +In order to use this example, you will need to edit the `src/main resrouces/hbase-site.xml` file to reflect your HBase
    --- End diff --
    
    @ptgoetz Just a reminder, you may want to check it since it contains typo (resrouces) and hbase-site.xml file is not on directory. And actually we can run simple_hbase.yaml with similar steps from simple_hdfs.yaml.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---