Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Merge branch 'master' into sdc-0.14-key-filters

  • Loading branch information...
commit 19c8af88384091324fd7ff2f012bb56f571c14f6 2 parents 45a14e7 + e9bcb94
Daniel Reverri dreverri authored

Showing 2 changed files with 169 additions and 15 deletions. Show diff stats Hide diff stats

  1. +128 0 pages/0-14-app-config.textile
  2. +41 15 pages/Configuration-Files.textile
128 pages/0-14-app-config.textile
Source Rendered
... ... @@ -0,0 +1,128 @@
  1 +h1. 0.14 app.config
  2 +
  3 +This is the default app.config created by rebar for the 0.14 release of Riak.
  4 +
  5 +```erlang
  6 +%% -*- tab-width: 4;erlang-indent-level: 4;indent-tabs-mode: nil -*-
  7 +%% ex: ts=4 sw=4 et
  8 +[
  9 + %% Riak Core config
  10 + {riak_core, [
  11 + %% Default location of ringstate
  12 + {ring_state_dir, "data/ring"},
  13 +
  14 + %% http is a list of IP addresses and TCP ports that the Riak
  15 + %% HTTP interface will bind.
  16 + {http, [ {"127.0.0.1", 8098 } ]},
  17 +
  18 + %% https is a list of IP addresses and TCP ports that the Riak
  19 + %% HTTPS interface will bind.
  20 + %{https, [{ "127.0.0.1", 8098 }]},
  21 +
  22 + %% default cert and key locations for https can be overridden
  23 + %% with the ssl config variable
  24 + %{ssl, [
  25 + % {certfile, "etc/cert.pem"},
  26 + % {keyfile, "etc/key.pem"}
  27 + % ]},
  28 +
  29 + %% riak_handoff_port is the TCP port that Riak uses for
  30 + %% intra-cluster data handoff.
  31 + {handoff_port, 8099 }
  32 + ]},
  33 +
  34 + %% Riak KV config
  35 + {riak_kv, [
  36 + %% Storage_backend specifies the Erlang module defining the storage
  37 + %% mechanism that will be used on this node.
  38 + {storage_backend, riak_kv_bitcask_backend},
  39 +
  40 + %% pb_ip is the IP address that the Riak Protocol Buffers interface
  41 + %% will bind to. If this is undefined, the interface will not run.
  42 + {pb_ip, "127.0.0.1" },
  43 +
  44 + %% pb_port is the TCP port that the Riak Protocol Buffers interface
  45 + %% will bind to
  46 + {pb_port, 8087 },
  47 +
  48 + %% raw_name is the first part of all URLS used by the Riak raw HTTP
  49 + %% interface. See riak_web.erl and raw_http_resource.erl for
  50 + %% details.
  51 + %{raw_name, "riak"},
  52 +
  53 + %% mapred_name is URL used to submit map/reduce requests to Riak.
  54 + {mapred_name, "mapred"},
  55 +
  56 + %% directory used to store a transient queue for pending
  57 + %% map tasks
  58 + {mapred_queue_dir, "data/mr_queue" },
  59 +
  60 + %% Each of the following entries control how many Javascript
  61 + %% virtual machines are available for executing map, reduce,
  62 + %% pre- and post-commit hook functions.
  63 + {map_js_vm_count, 8 },
  64 + {reduce_js_vm_count, 6 },
  65 + {hook_js_vm_count, 2 },
  66 +
  67 + %% Number of items the mapper will fetch in one request.
  68 + %% Larger values can impact read/write performance for
  69 + %% non-MapReduce requests.
  70 + {mapper_batch_size, 5},
  71 +
  72 + %% js_max_vm_mem is the maximum amount of memory, in megabytes,
  73 + %% allocated to the Javascript VMs. If unset, the default is
  74 + %% 8MB.
  75 + {js_max_vm_mem, 8},
  76 +
  77 + %% js_thread_stack is the maximum amount of thread stack, in megabyes,
  78 + %% allocate to the Javascript VMs. If unset, the default is 16MB.
  79 + %% NOTE: This is not the same as the C thread stack.
  80 + {js_thread_stack, 16},
  81 +
  82 + %% Number of objects held in the MapReduce cache. These will be
  83 + %% ejected when the cache runs out of room or the bucket/key
  84 + %% pair for that entry changes
  85 + {map_cache_size, 10000},
  86 +
  87 + %% js_source_dir should point to a directory containing Javascript
  88 + %% source files which will be loaded by Riak when it initializes
  89 + %% Javascript VMs.
  90 + %{js_source_dir, "/tmp/js_source"},
  91 +
  92 + %% riak_stat enables the use of the "riak-admin status" command to
  93 + %% retrieve information the Riak node for performance and debugging needs
  94 + {riak_kv_stat, true}
  95 + ]},
  96 +
  97 + %% Bitcask Config
  98 + {bitcask, [
  99 + {data_root, "data/bitcask"}
  100 + ]},
  101 +
  102 + %% Luwak Config
  103 + {luwak, [
  104 + {enabled, false}
  105 + ]},
  106 +
  107 +%% Riak_err Config
  108 +{riak_err, [
  109 + %% Info/error/warning reports larger than this will be considered
  110 + %% too big to be formatted safely with the user-supplied format
  111 + %% string.
  112 + {term_max_size, 65536},
  113 +
  114 + %% Limit the total size of formatted info/error/warning reports.
  115 + {fmt_max_bytes, 65536}
  116 + ]},
  117 +
  118 + %% SASL config
  119 + {sasl, [
  120 + {sasl_error_logger, {file, "log/sasl-error.log"}},
  121 + {errlog_type, error},
  122 + {error_logger_mf_dir, "log/sasl"}, % Log directory
  123 + {error_logger_mf_maxbytes, 10485760}, % 10 MB max file size
  124 + {error_logger_mf_maxfiles, 5} % 5 files max
  125 + ]}
  126 +].
  127 +
  128 +```
56 pages/Configuration-Files.textile
Source Rendered
@@ -27,17 +27,19 @@ Riak and the Erlang applications it depends on are configured by settings in the
27 27 ```
28 28
29 29
30   -
31 30 <div class="note"><div class="title">Configuration changes in 0.10</div>Many configuration settings changed names and sections in the 0.10 release. Please backup your @app.config@ file when upgrading and then copy your previous customizations to the proper places in the new file. See [[the transition notes|http://hg.basho.com/riak/raw/efc290fd9c23/TRANSITION]] for more information.</div>
32 31
33 32
34   -
35 33 <div class="note"><div class="title">Configuration changes in 0.12</div>The settings related to handoff moved from @riak_kv@ to @riak_core@ in the 0.12 release. These are:
36 34 * @handoff_ip@
37 35 * @handoff_port@
38 36 * @handoff_concurrency@</div>
39 37
40 38
  39 +<div class="note"><div class="title">Configuration changes in 0.14</div>The settings for web_ip and web_port are deprecated. The new configuration mechanism is to use a list of IPs and ports in the http{} section of riak_core of app.config.
  40 +
  41 +The configuration for parameters for the Javascript VMs in the riak_kv section of app.config have changed and should be edited if your previous configuration didn't use the default parameters. You can see the new default configuration parameters for the 0.14 app.config [[here|0-14-app-config]].</div>
  42 +
41 43 h3. riak_core settings
42 44
43 45 h4. cluster_name
@@ -108,17 +110,21 @@ Assuming _ring_creation_size_ is a power of 2, the ideal value for this setting
108 110
109 111 The default value is _4_. For this to be effective at preventing hotspots, your cluster size (number of physical nodes) must be equal to or larger than _target_n_val_.
110 112
111   -h4. web_ip
  113 +h4. http
112 114
113   -The ip address on which Riak's HTTP interface should listen (default: "127.0.0.1"")
  115 +A list of ip addresses and ports on which Riak's HTTP interface should listen (default: {"127.0.0.1", 8091 })
114 116
115 117 Riak's HTTP interface will not be started if this setting is not defined.
116 118
117   -h4. web_port
  119 +h4. https
118 120
119   -The port on which Riak's HTTP interface should listen (default: 8098")
  121 +A list of ip addresses and ports on which Riak's HTTPS interface should listen (default: not enabled)
120 122
121   -Riak's HTTP interface will not be started if this setting is not defined.
  123 +Riak's HTTPS interface will not be started if this setting is not defined.
  124 +
  125 +h4. ssl
  126 +
  127 +You can override the default SSL key and certificate settings (default: etc/cert.pem, etc/key.pem)
122 128
123 129 h3. riak_kv settings
124 130
@@ -128,25 +134,45 @@ A list of paths to add to the Erlang code path.
128 134
129 135 This setting is especially useful for allowing Riak to use external modules during map/reduce queries.
130 136
131   -h4. js_max_vm_mem
  137 +h4. mapred_name
132 138
133   -The maximum amount of memory allocated to each Javascript virtual machine, in megabytes. (default: "8")
  139 +The base of the path in the URL exposing [[MapReduce]] via HTTP. (default: "mapred")
134 140
135   -h4. js_source_dir
  141 +h4. mapred_queue_dir
  142 +
  143 +The directory used to store a transient queue for pending map tasks (default: "data/mrqueue")
  144 +
  145 +h4. map_js_vm_count
136 146
137   -Where to load user-defined built in Javascript functions (default: @unset@)
  147 +The number of Javascript VMs started to handle map phases. (default: "8")
  148 +
  149 +h4. reduce_js_vm_count
  150 +
  151 +The number of Javascript VMs started to handle reduce phases. (default: "6")
  152 +
  153 +h4. hook_js_vm_count
  154 +
  155 +The number of Javascript VMs started to handle pre-commit hooks.(default: "2")
  156 +
  157 +h4. mapper_batch_size
  158 +
  159 +Number of items the mapper will fetch in one request. Larger values can impact read/write performance for non-MapReduce requests. (default: "5")
  160 +
  161 +h4. js_max_vm_mem
  162 +
  163 +The maximum amount of memory allocated to each Javascript virtual machine, in megabytes. (default: "8")
138 164
139 165 h4. js_thread_stack
140 166
141 167 The maximum amount of thread stack space to allocate to Javascript virtual machines, in megabytes. (default: "16")
142 168
143   -h4. js_vm_count
  169 +h4. map_cache_size
144 170
145   -How many Javascript virtual machines to start (default: "8").
  171 +Number of object held in the MapReduce cache. These will be ejected when the cache runs out of room or the bucket/key pair for that entry changes. (default: "10000")
146 172
147   -h4. mapred_name
  173 +h4. js_source_dir
148 174
149   -The base of the path in the URL exposing [[MapReduce]] via HTTP. (default: "mapred")
  175 +Where to load user-defined built in Javascript functions (default: unset)
150 176
151 177 h4. pb_ip
152 178

0 comments on commit 19c8af8

Please sign in to comment.
Something went wrong with that request. Please try again.