updated
Project: http://git-wip-us.apache.org/repos/asf/curator/repo Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/a2b0ffd7 Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/a2b0ffd7 Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/a2b0ffd7 Branch: refs/heads/curator-rpc Commit: a2b0ffd7066bfc7a457460d197adb8c3196a0ff3 Parents: bdc595a Author: randgalt <randg...@apache.org> Authored: Sat May 31 09:45:15 2014 -0500 Committer: randgalt <randg...@apache.org> Committed: Sat May 31 09:45:15 2014 -0500 ---------------------------------------------------------------------- .../src/main/resources/curator/help.txt | 70 ++++++++++++++++++-- 1 file changed, 64 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/curator/blob/a2b0ffd7/curator-x-rpc/src/main/resources/curator/help.txt ---------------------------------------------------------------------- diff --git a/curator-x-rpc/src/main/resources/curator/help.txt b/curator-x-rpc/src/main/resources/curator/help.txt index 086654e..53e751f 100644 --- a/curator-x-rpc/src/main/resources/curator/help.txt +++ b/curator-x-rpc/src/main/resources/curator/help.txt @@ -2,12 +2,70 @@ Curator RPC - an RPC server for using Apache Curator APIs and recipes from non J Arguments: <none> show this help - <path> path to a JSON or YAML configuration file - <string> JSON or YAML object for configuration + <config> either a path to a JSON or YAML configuration file or a JSON/YAML object for + configuration -Curator RPC uses Dropwizard for configuration. The format is JSON or YAML (your choice). +Curator RPC uses Dropwizard for configuration. The format is JSON or YAML (your choice). Here is +the model configuration shown in JSON with added comments. Required fields have "*" in the comment. -Curator also uses Dropwizard's logging module. The configuration for it is described here: -http://dropwizard.readthedocs.org/en/latest/manual/configuration.html#logging +{ + "thrift": { // * Thrift server configuration + "bindAddress": "string", // address to bind to. Default is "localhost" + "port": int, // * port to listen on + "acceptBacklog": int, // default is 1024 + "connectionLimit": int, // max concurrent connections. Default is unlimited. + "acceptorThreadCount": int, // default is 1 + "ioThreadCount": int, // default is 2 * number of processors + "idleConnectionTimeout": "Duration", // default is 60 seconds + "transportName": "string", // default is "framed" + "protocolName": "string" // default is "binary" + }, -TODO - more details to follow + "projectionExpiration": "Duration", // time for projections to expire if unused. Default is 3 + // minutes. + + "pingTime": "Duration", // time that the EventService will return PING if no other events. + // Default is 5 seconds. + + "connections": [ // * list of ZooKeeper connections + "name": "string", // * unique name for the connection + "sessionLength": "Duration", // duration for the session. Default is 1 minute. + "connectionTimeout": "Duration", // duration for connecting. Default is 15 seconds. + "authorization": { // Authorization spec. Default is NULL. + "scheme": "string", // * the authorization scheme + "auth": "string" // * the authorization auth + }, + "namespace": "string", // Curator namespace. Default is NULL. + "retry": { // Retry policy. Default is an exponential-backoff policy. + "type": "string", // Policy type. Either "exponential-backoff", + // "bounded-exponential-backoff" or "ntimes" + -- Remaining values depending on type. See below -- + }, + ], + + "logging": { // logging config - Dropwizard's logging library is used + See http://dropwizard.readthedocs.org/en/latest/manual/configuration.html#logging + } +} + +"Duration" is a string. E.g. "1s" (1 second), "10m" (10 minutes) + +Retry Policy Specs: + For type: "exponential-backoff" + { + "baseSleepTime": "Duration", // default is 100 milliseconds + "maxRetries": int // default is 3 + } + + For type: "bounded-exponential-backoff" + { + "baseSleepTime": "Duration", // default is 100 milliseconds + "maxSleepTime": "Duration", // default is 30 seconds + "maxRetries": int // default is 3 + } + + For type: "ntimes" + { + "sleepBetweenRetries": "Duration", // default is 100 milliseconds + "n": int // default is 3 + }