You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by jm...@apache.org on 2017/02/23 19:27:57 UTC
[11/13] samza git commit: SAMZA-1099: Documentation updates for Samza
0.12 release (for master branch)
SAMZA-1099: Documentation updates for Samza 0.12 release (for master branch)
Project: http://git-wip-us.apache.org/repos/asf/samza/repo
Commit: http://git-wip-us.apache.org/repos/asf/samza/commit/b5ea8776
Tree: http://git-wip-us.apache.org/repos/asf/samza/tree/b5ea8776
Diff: http://git-wip-us.apache.org/repos/asf/samza/diff/b5ea8776
Branch: refs/heads/samza-fluent-api-v1
Commit: b5ea8776ee5565cf12ef4bd4a0b1a0fde11154a4
Parents: eab1800
Author: vjagadish1989 <jv...@linkedin.com>
Authored: Wed Feb 22 10:53:12 2017 -0800
Committer: vjagadish1989 <jv...@linkedin.com>
Committed: Wed Feb 22 12:45:13 2017 -0800
----------------------------------------------------------------------
docs/_config.yml | 2 +-
docs/_layouts/default.html | 1 +
docs/archive/index.html | 8 ++++
.../versioned/jobs/split-deployment.md | 4 +-
.../versioned/deploy-samza-job-from-hdfs.md | 2 +-
.../tutorials/versioned/deploy-samza-to-CDH.md | 4 +-
.../versioned/remote-debugging-samza.md | 2 +-
.../versioned/run-in-multi-node-yarn.md | 16 ++++----
.../versioned/samza-rest-getting-started.md | 4 +-
docs/startup/download/index.md | 39 +++++++++++++-------
docs/startup/hello-samza/versioned/index.md | 2 +-
11 files changed, 52 insertions(+), 32 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index 2b5bf05..29e3d42 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -25,4 +25,4 @@ exclude: [_docs]
baseurl: http://samza.apache.org
version: latest
# this is the version you will go if you click 'switch version' in "latest" pages.
-latest-release: '0.11'
+latest-release: '0.12'
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/_layouts/default.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index dfcb6d0..b9a05fa 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -102,6 +102,7 @@
<h1><i class="fa fa-history"></i> Archive</h1>
<ul>
<li><a href="/archive/index.html#latest">latest</a></li>
+ <li><a href="/archive/index.html#12">0.12</a></li>
<li><a href="/archive/index.html#11">0.11</a></li>
<li><a href="/archive/index.html#10">0.10</a></li>
<li><a href="/archive/index.html#09">0.9</a></li>
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/archive/index.html
----------------------------------------------------------------------
diff --git a/docs/archive/index.html b/docs/archive/index.html
index e92f50e..549495b 100644
--- a/docs/archive/index.html
+++ b/docs/archive/index.html
@@ -27,6 +27,14 @@ title: Documentation
<li><a href="../startup/hello-samza/latest">Hello Samza</a></li>
</ul>
+<h4 id="12">0.12 Release</h4>
+
+<ul class="documentation-list">
+ <li><a href="../learn/documentation/0.12">Documentation</a></li>
+ <li><a href="../learn/tutorials/0.12">Tutorials</a></li>
+ <li><a href="../startup/hello-samza/0.12">Hello Samza</a></li>
+</ul>
+
<h4 id="11">0.11 Release</h4>
<ul class="documentation-list">
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/learn/documentation/versioned/jobs/split-deployment.md
----------------------------------------------------------------------
diff --git a/docs/learn/documentation/versioned/jobs/split-deployment.md b/docs/learn/documentation/versioned/jobs/split-deployment.md
index ebab670..fa3e7ae 100644
--- a/docs/learn/documentation/versioned/jobs/split-deployment.md
+++ b/docs/learn/documentation/versioned/jobs/split-deployment.md
@@ -50,10 +50,10 @@ Each deployment will now consist of two separate packages:<p>
To run a job in split deployment mode:
1. **Deploy the framework**:
-The Samza framework package should be deployed to ALL the machines of a cluster into a predefined, fixed location. This could be done by merely copying the jars, or creating a meta package that would deploy all of them. Let's assume that 'samza-framework' package is installed into the '/.../samza-fwk/0.11.0' directory.
+The Samza framework package should be deployed to ALL the machines of a cluster into a predefined, fixed location. This could be done by merely copying the jars, or creating a meta package that would deploy all of them. Let's assume that 'samza-framework' package is installed into the '/.../samza-fwk/0.12.0' directory.
2. **Create symbolic link**:
-A symbolic link needs to be created for the **stable** version of the framework to point to the framework location, e.g.: {% highlight bash %} ln -s /.../samza-fwk/0.11.0 /.../samza-fwk/STABLE' {% endhighlight %}
+A symbolic link needs to be created for the **stable** version of the framework to point to the framework location, e.g.: {% highlight bash %} ln -s /.../samza-fwk/0.12.0 /.../samza-fwk/STABLE' {% endhighlight %}
3. **Deploy user job**:
In the job's config, the following property is required to enable split deployment, e.g. for Samza framework path at '/.../samza-fwk': {% highlight jproperties %} samza.fwk.path=/.../samza-fwk {% endhighlight %} By default Samza will look for the **stable** link inside the folder to find the framework. You can also override the version by configuring: {% highlight jproperties %} samza.fwk.version=0.11.1 {% endhighlight %} In this case Samza will pick '/.../samza-fwk/0.11.1' as the framework location. This way users can perform canary, upgrade and rollback their jobs easily by changing version in the config.
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/learn/tutorials/versioned/deploy-samza-job-from-hdfs.md
----------------------------------------------------------------------
diff --git a/docs/learn/tutorials/versioned/deploy-samza-job-from-hdfs.md b/docs/learn/tutorials/versioned/deploy-samza-job-from-hdfs.md
index 6f7dcc1..68b7658 100644
--- a/docs/learn/tutorials/versioned/deploy-samza-job-from-hdfs.md
+++ b/docs/learn/tutorials/versioned/deploy-samza-job-from-hdfs.md
@@ -24,7 +24,7 @@ This tutorial uses [hello-samza](../../../startup/hello-samza/{{site.version}}/)
### Upload the package
{% highlight bash %}
-hadoop fs -put ./target/hello-samza-0.11.0-dist.tar.gz /path/for/tgz
+hadoop fs -put ./target/hello-samza-0.12.0-dist.tar.gz /path/for/tgz
{% endhighlight %}
### Add HDFS configuration
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/learn/tutorials/versioned/deploy-samza-to-CDH.md
----------------------------------------------------------------------
diff --git a/docs/learn/tutorials/versioned/deploy-samza-to-CDH.md b/docs/learn/tutorials/versioned/deploy-samza-to-CDH.md
index fff209f..b764a57 100644
--- a/docs/learn/tutorials/versioned/deploy-samza-to-CDH.md
+++ b/docs/learn/tutorials/versioned/deploy-samza-to-CDH.md
@@ -34,7 +34,7 @@ mvn clean package -Dhadoop.version=cdh5.4.0
There are a few ways of uploading the package to the cluster's HDFS. If you do not have the job package in your cluster, **scp** from you local machine to the cluster. Then run
{% highlight bash %}
-hadoop fs -put path/to/hello-samza-0.11.0-dist.tar.gz /path/for/tgz
+hadoop fs -put path/to/hello-samza-0.12.0-dist.tar.gz /path/for/tgz
{% endhighlight %}
### Get Deploying Scripts
@@ -42,7 +42,7 @@ hadoop fs -put path/to/hello-samza-0.11.0-dist.tar.gz /path/for/tgz
Untar the job package (assume you will run from the current directory)
{% highlight bash %}
-tar -xvf path/to/samza-job-package-0.11.0-dist.tar.gz -C ./
+tar -xvf path/to/samza-job-package-0.12.0-dist.tar.gz -C ./
{% endhighlight %}
### Add Package Path to Properties File
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/learn/tutorials/versioned/remote-debugging-samza.md
----------------------------------------------------------------------
diff --git a/docs/learn/tutorials/versioned/remote-debugging-samza.md b/docs/learn/tutorials/versioned/remote-debugging-samza.md
index 7cc3a0e..3d8f069 100644
--- a/docs/learn/tutorials/versioned/remote-debugging-samza.md
+++ b/docs/learn/tutorials/versioned/remote-debugging-samza.md
@@ -83,7 +83,7 @@ Once the grid starts, you can start the wikipedia-feed Samza job.
{% highlight bash %}
mvn clean package
mkdir -p deploy/samza
-tar -xvf ./target/hello-samza-0.11.0-dist.tar.gz -C deploy/samza
+tar -xvf ./target/hello-samza-0.12.0-dist.tar.gz -C deploy/samza
deploy/samza/bin/run-job.sh --config-factory=org.apache.samza.config.factories.PropertiesConfigFactory --config-path=file://$PWD/deploy/samza/config/wikipedia-feed.properties
{% endhighlight %}
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/learn/tutorials/versioned/run-in-multi-node-yarn.md
----------------------------------------------------------------------
diff --git a/docs/learn/tutorials/versioned/run-in-multi-node-yarn.md b/docs/learn/tutorials/versioned/run-in-multi-node-yarn.md
index 7e7ba8d..e36f438 100644
--- a/docs/learn/tutorials/versioned/run-in-multi-node-yarn.md
+++ b/docs/learn/tutorials/versioned/run-in-multi-node-yarn.md
@@ -74,18 +74,18 @@ The goal of these steps is to configure YARN to read http filesystem because we
{% highlight bash %}
cd /tmp
-curl http://www.scala-lang.org/files/archive/scala-2.10.4.tgz > scala-2.10.4.tgz
-tar -xvf scala-2.10.4.tgz
+curl http://www.scala-lang.org/files/archive/scala-2.11.8.tgz > scala-2.11.8.tgz
+tar -xvf scala-2.11.8.tgz
{% endhighlight %}
5\. Add Scala, its log jars, and Samza's HttpFileSystem implementation.
{% highlight bash %}
-cp /tmp/scala-2.10.4/lib/scala-compiler.jar $HADOOP_YARN_HOME/share/hadoop/hdfs/lib
-cp /tmp/scala-2.10.4/lib/scala-library.jar $HADOOP_YARN_HOME/share/hadoop/hdfs/lib
+cp /tmp/scala-2.11.8/lib/scala-compiler.jar $HADOOP_YARN_HOME/share/hadoop/hdfs/lib
+cp /tmp/scala-2.11.8/lib/scala-library.jar $HADOOP_YARN_HOME/share/hadoop/hdfs/lib
curl -L http://search.maven.org/remotecontent?filepath=org/clapper/grizzled-slf4j_2.10/1.0.1/grizzled-slf4j_2.10-1.0.1.jar > $HADOOP_YARN_HOME/share/hadoop/hdfs/lib/grizzled-slf4j_2.10-1.0.1.jar
-curl -L http://search.maven.org/remotecontent?filepath=org/apache/samza/samza-yarn_2.10/0.11.0/samza-yarn_2.10-0.11.0.jar > $HADOOP_YARN_HOME/share/hadoop/hdfs/lib/samza-yarn_2.10-0.11.0.jar
-curl -L http://search.maven.org/remotecontent?filepath=org/apache/samza/samza-core_2.10/0.11.0/samza-core_2.10-0.11.0.jar > $HADOOP_YARN_HOME/share/hadoop/hdfs/lib/samza-core_2.10-0.11.0.jar
+curl -L http://search.maven.org/remotecontent?filepath=org/apache/samza/samza-yarn_2.11/0.12.0/samza-yarn_2.11-0.12.0.jar > $HADOOP_YARN_HOME/share/hadoop/hdfs/lib/samza-yarn_2.11-0.12.0.jar
+curl -L http://search.maven.org/remotecontent?filepath=org/apache/samza/samza-core_2.11/0.12.0/samza-core_2.11-0.12.0.jar > $HADOOP_YARN_HOME/share/hadoop/hdfs/lib/samza-core_2.11-0.12.0.jar
{% endhighlight %}
6\. Add http configuration in core-site.xml (create the core-site.xml file and add content).
@@ -145,7 +145,7 @@ vi src/main/config/wikipedia-feed.properties
Change the yarn.package.path property to be:
{% highlight jproperties %}
-yarn.package.path=http://yourHostname:8000/target/hello-samza-0.11.0-dist.tar.gz
+yarn.package.path=http://yourHostname:8000/target/hello-samza-0.12.0-dist.tar.gz
{% endhighlight %}
3\. Compile hello-samza.
@@ -153,7 +153,7 @@ yarn.package.path=http://yourHostname:8000/target/hello-samza-0.11.0-dist.tar.gz
{% highlight bash %}
mvn clean package
mkdir -p deploy/samza
-tar -xvf ./target/hello-samza-0.11.0-dist.tar.gz -C deploy/samza
+tar -xvf ./target/hello-samza-0.12.0-dist.tar.gz -C deploy/samza
{% endhighlight %}
4\. Deploy Samza job package to Http server..
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/learn/tutorials/versioned/samza-rest-getting-started.md
----------------------------------------------------------------------
diff --git a/docs/learn/tutorials/versioned/samza-rest-getting-started.md b/docs/learn/tutorials/versioned/samza-rest-getting-started.md
index c0e1cf5..91f3dd6 100644
--- a/docs/learn/tutorials/versioned/samza-rest-getting-started.md
+++ b/docs/learn/tutorials/versioned/samza-rest-getting-started.md
@@ -31,7 +31,7 @@ Take note of the path where you cloned hello-samza. You will need this to config
#### Build the Samza REST Service package
-The source code for Samza REST is in the samza-rest module of the Samza repository. It To build it, execute the following gradle task from the root of the project.
+The source code for Samza REST is in the samza-rest module of the Samza repository. To build it, execute the following gradle task from the root of the project.
{% highlight bash %}
./gradlew samza-rest:clean releaseRestServiceTar
{% endhighlight %}
@@ -48,7 +48,7 @@ Run the following commands:
{% highlight bash %}
cd samza-rest/build/distributions/
mkdir -p deploy/samza-rest
-tar -xvf ./samza-rest-0.11.1-SNAPSHOT.tgz -C deploy/samza-rest
+tar -xvf ./samza-rest-0.13.0-SNAPSHOT.tgz -C deploy/samza-rest
{% endhighlight %}
#### Configure the Installations Path
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/startup/download/index.md
----------------------------------------------------------------------
diff --git a/docs/startup/download/index.md b/docs/startup/download/index.md
index 7dfdfda..53fa299 100644
--- a/docs/startup/download/index.md
+++ b/docs/startup/download/index.md
@@ -29,6 +29,7 @@ Starting from 2016, Samza will begin requiring JDK8 or higher. Please see [this
### Source Releases
+ * [samza-sources-0.12.0.tgz](http://www.apache.org/dyn/closer.lua/samza/0.12.0)
* [samza-sources-0.11.0.tgz](http://www.apache.org/dyn/closer.lua/samza/0.11.0)
* [samza-sources-0.10.1.tgz](http://www.apache.org/dyn/closer.lua/samza/0.10.1)
* [samza-sources-0.10.0.tgz](http://www.apache.org/dyn/closer.lua/samza/0.10.0)
@@ -49,12 +50,12 @@ A Maven-based Samza project can pull in all required dependencies Samza dependen
<dependency>
<groupId>org.apache.samza</groupId>
<artifactId>samza-api</artifactId>
- <version>0.11.0</version>
+ <version>0.12.0</version>
</dependency>
<dependency>
<groupId>org.apache.samza</groupId>
- <artifactId>samza-core_2.10</artifactId>
- <version>0.11.0</version>
+ <artifactId>samza-core_2.11</artifactId>
+ <version>0.12.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
@@ -62,41 +63,51 @@ A Maven-based Samza project can pull in all required dependencies Samza dependen
<artifactId>samza-shell</artifactId>
<classifier>dist</classifier>
<type>tgz</type>
- <version>0.11.0</version>
+ <version>0.12.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.apache.samza</groupId>
- <artifactId>samza-yarn_2.10</artifactId>
- <version>0.11.0</version>
+ <artifactId>samza-yarn_2.11</artifactId>
+ <version>0.12.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.apache.samza</groupId>
- <artifactId>samza-kv_2.10</artifactId>
- <version>0.11.0</version>
+ <artifactId>samza-kv_2.11</artifactId>
+ <version>0.12.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.apache.samza</groupId>
- <artifactId>samza-kv-rocksdb_2.10</artifactId>
- <version>0.11.0</version>
+ <artifactId>samza-kv-rocksdb_2.11</artifactId>
+ <version>0.12.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.apache.samza</groupId>
- <artifactId>samza-kv-inmemory_2.10</artifactId>
- <version>0.11.0</version>
+ <artifactId>samza-kv-inmemory_2.11</artifactId>
+ <version>0.12.0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.apache.samza</groupId>
- <artifactId>samza-kafka_2.10</artifactId>
- <version>0.11.0</version>
+ <artifactId>samza-kafka_2.11</artifactId>
+ <version>0.12.0</version>
<scope>runtime</scope>
</dependency>
{% endhighlight %}
+Samza versions less than 0.12 should use artifacts with scala version 2.10 as suffix. For example,
+
+{% highlight xml %}
+<dependency>
+ <groupId>org.apache.samza</groupId>
+ <artifactId>samza-yarn_2.10</artifactId>
+ <version>0.11.0</version>
+</dependency>
+{% endhighlight %}
+
Samza versions less than 0.9 should include this additional dependency.
{% highlight xml %}
http://git-wip-us.apache.org/repos/asf/samza/blob/b5ea8776/docs/startup/hello-samza/versioned/index.md
----------------------------------------------------------------------
diff --git a/docs/startup/hello-samza/versioned/index.md b/docs/startup/hello-samza/versioned/index.md
index d0aca54..89b7ab9 100644
--- a/docs/startup/hello-samza/versioned/index.md
+++ b/docs/startup/hello-samza/versioned/index.md
@@ -61,7 +61,7 @@ Then, you can continue w/ the following command in hello-samza project:
{% highlight bash %}
mvn clean package
mkdir -p deploy/samza
-tar -xvf ./target/hello-samza-0.11.1-SNAPSHOT-dist.tar.gz -C deploy/samza
+tar -xvf ./target/hello-samza-0.13.0-SNAPSHOT-dist.tar.gz -C deploy/samza
{% endhighlight %}
### Run a Samza Job