Permalink
Browse files

Doc updates for RC3

  • Loading branch information...
1 parent 036d718 commit 96938d5afe060f8213f66b3269e6c846cfc045e3 @matthieumorel matthieumorel committed Mar 18, 2013
View
@@ -53,6 +53,8 @@ <h2> Bug
</li>
<li>[<a href='https://issues.apache.org/jira/browse/S4-129'>S4-129</a>] - s4 node ignores zk parameter from the command line
</li>
+<li>[<a href='https://issues.apache.org/jira/browse/S4-130'>S4-130</a>] - csv output for metrics not working
+</li>
</ul>
<h2> Improvement
@@ -114,5 +116,4 @@ <h2> Task
</li>
<li>[<a href='https://issues.apache.org/jira/browse/S4-124'>S4-124</a>] - Update documentation for 0.6.0 release
</li>
-</ul>
-
+</ul>
View
@@ -296,6 +296,7 @@ task srcDist(dependsOn: ["javadoc"], type: Zip) {
exclude ('**/tmp/**')
exclude ('**/bin/**')
exclude ('website/**')
+ exclude ('lib/apache-rat-0.8.jar')
into (baseName+'-'+version+'-'+classifier)
}
@@ -121,7 +121,7 @@ public static void main(String[] args) {
@Parameter(names = { "-modulesClasses", "-emc", "-mc" }, description = "Fully qualified class names of custom modules")
List<String> modulesClassesNames = new ArrayList<String>();
- @Parameter(names = { "-namedStringParameters", "-p" }, description = "Comma-separated list of inline configuration parameters, taking precedence over homonymous configuration parameters from configuration files. Syntax: '-p=name1=value1,name2=value2 '", hidden = false, converter = ParsingUtils.InlineConfigParameterConverter.class)
+ @Parameter(names = { "-namedStringParameters", "-p" }, description = "Comma-separated list of inline configuration parameters. Syntax: '-p=name1=value1,name2=value2 '", hidden = false, converter = ParsingUtils.InlineConfigParameterConverter.class)
List<String> extraNamedParameters = new ArrayList<String>();
@Parameter(names = "-testMode", description = "Special mode for regression testing", hidden = true)
@@ -66,6 +66,11 @@ Therefore, for starting an S4 node on a given host, you only need to specify:
Example:
`./s4 node -c=cluster1 -zk=host.domain.com`
+## Overriding node configuration
+By default, nodes read configuration from configuration files in the classpath `default.s4.base.properties`, `default.s4.comm.properties` and `default.s4.core.properties`.
+
+It is possible to override these parameters by using the `-p` option when starting a node.
+
# Application configuration
@@ -130,7 +135,7 @@ int port
~~~
-* specifying the parameter value at node startup (using `-p` inline with the node command, or with the '`@`' syntax)
+* specifying the parameter value when deploying the application (using `-p` inline with the node command, or with the '`@`' syntax)
S4 uses an internal Guice module that automatically injects configuration parameters passed through the deploy command to matching `@Named` parameters.
@@ -140,6 +145,11 @@ Both application and platform parameters can be overriden. For instance, specify
-emc=org.apache.s4.core.ft.FileSystemBackendCheckpointingModule \
-p=s4.checkpointing.filesystem.storageRootPath=/custom/path
+
+> Make sure you pass overriding **platform** parameters through the `-p` option in the `node` command, and pass **application** parameters through the `-p` option in the `deploy` command.
+
+
+
## File-based configuration
Instead of specifying node parameters inline, you may refer to a file with the '@' notation:
@@ -5,7 +5,7 @@ title: Distributed Stream Computing Platform
#about{:class=>"span-18 last"}
#notice{:class=>"span-17 last"}
- #notice_text= "March 2013: <b>S4 0.6.0 Release Candidate</b> <a href='http://people.apache.org/~mmorel/s4-0.6.0-incubating-release-candidate-2/'>available for download</a>. Check the <a href='/doc/0.6.0'>improved documentation</a>!."
+ #notice_text= "March 2013: <b>S4 0.6.0 Release Candidate</b> <a href='http://people.apache.org/~mmorel/s4-0.6.0-incubating-release-candidate-3/'>available for download</a>. Check the <a href='/doc/0.6.0'>improved documentation</a>!."
#notice{:class=>"span-17 last"}
#notice_text= "August 2012: <b>S4 0.5.0 has been released!</b> Get it <a href='/download'>here</a>!."

0 comments on commit 96938d5

Please sign in to comment.