Skip to content

Commit

Permalink
0.14 app.config changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@schofield
schofield committed Jan 5, 2011
1 parent abd8ae9 commit dd31ff4
Show file tree
Hide file tree
Showing 2 changed files with 169 additions and 15 deletions.
128 changes: 128 additions & 0 deletions pages/0-14-app-config.textile
View file
@@ -0,0 +1,128 @@
h1. 0.14 app.config

This is the default app.config created by rebar for the 0.14 release of Riak.

```erlang
%% -*- tab-width: 4;erlang-indent-level: 4;indent-tabs-mode: nil -*-
%% ex: ts=4 sw=4 et
[
%% Riak Core config
{riak_core, [
%% Default location of ringstate
{ring_state_dir, "data/ring"},

%% http is a list of IP addresses and TCP ports that the Riak
%% HTTP interface will bind.
{http, [ {"127.0.0.1", 8098 } ]},

%% https is a list of IP addresses and TCP ports that the Riak
%% HTTPS interface will bind.
%{https, [{ "127.0.0.1", 8098 }]},

%% default cert and key locations for https can be overridden
%% with the ssl config variable
%{ssl, [
% {certfile, "etc/cert.pem"},
% {keyfile, "etc/key.pem"}
% ]},

%% riak_handoff_port is the TCP port that Riak uses for
%% intra-cluster data handoff.
{handoff_port, 8099 }
]},

%% Riak KV config
{riak_kv, [
%% Storage_backend specifies the Erlang module defining the storage
%% mechanism that will be used on this node.
{storage_backend, riak_kv_bitcask_backend},

%% pb_ip is the IP address that the Riak Protocol Buffers interface
%% will bind to. If this is undefined, the interface will not run.
{pb_ip, "127.0.0.1" },

%% pb_port is the TCP port that the Riak Protocol Buffers interface
%% will bind to
{pb_port, 8087 },

%% raw_name is the first part of all URLS used by the Riak raw HTTP
%% interface. See riak_web.erl and raw_http_resource.erl for
%% details.
%{raw_name, "riak"},

%% mapred_name is URL used to submit map/reduce requests to Riak.
{mapred_name, "mapred"},

%% directory used to store a transient queue for pending
%% map tasks
{mapred_queue_dir, "data/mr_queue" },

%% Each of the following entries control how many Javascript
%% virtual machines are available for executing map, reduce,
%% pre- and post-commit hook functions.
{map_js_vm_count, 8 },
{reduce_js_vm_count, 6 },
{hook_js_vm_count, 2 },

%% Number of items the mapper will fetch in one request.
%% Larger values can impact read/write performance for
%% non-MapReduce requests.
{mapper_batch_size, 5},

%% js_max_vm_mem is the maximum amount of memory, in megabytes,
%% allocated to the Javascript VMs. If unset, the default is
%% 8MB.
{js_max_vm_mem, 8},

%% js_thread_stack is the maximum amount of thread stack, in megabyes,
%% allocate to the Javascript VMs. If unset, the default is 16MB.
%% NOTE: This is not the same as the C thread stack.
{js_thread_stack, 16},

%% Number of objects 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
{map_cache_size, 10000},

%% js_source_dir should point to a directory containing Javascript
%% source files which will be loaded by Riak when it initializes
%% Javascript VMs.
%{js_source_dir, "/tmp/js_source"},

%% riak_stat enables the use of the "riak-admin status" command to
%% retrieve information the Riak node for performance and debugging needs
{riak_kv_stat, true}
]},

%% Bitcask Config
{bitcask, [
{data_root, "data/bitcask"}
]},

%% Luwak Config
{luwak, [
{enabled, false}
]},

%% Riak_err Config
{riak_err, [
%% Info/error/warning reports larger than this will be considered
%% too big to be formatted safely with the user-supplied format
%% string.
{term_max_size, 65536},

%% Limit the total size of formatted info/error/warning reports.
{fmt_max_bytes, 65536}
]},

%% SASL config
{sasl, [
{sasl_error_logger, {file, "log/sasl-error.log"}},
{errlog_type, error},
{error_logger_mf_dir, "log/sasl"}, % Log directory
{error_logger_mf_maxbytes, 10485760}, % 10 MB max file size
{error_logger_mf_maxfiles, 5} % 5 files max
]}
].

```
56 changes: 41 additions & 15 deletions pages/Configuration-Files.textile
View file
Expand Up @@ -27,17 +27,19 @@ Riak and the Erlang applications it depends on are configured by settings in the
```



<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>



<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:
* @handoff_ip@
* @handoff_port@
* @handoff_concurrency@</div>


<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.

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>

h3. riak_core settings

h4. cluster_name
Expand Down Expand Up @@ -108,17 +110,21 @@ Assuming _ring_creation_size_ is a power of 2, the ideal value for this setting

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_.

h4. web_ip
h4. http

The ip address on which Riak's HTTP interface should listen (default: "127.0.0.1"")
A list of ip addresses and ports on which Riak's HTTP interface should listen (default: {"127.0.0.1", 8091 })

Riak's HTTP interface will not be started if this setting is not defined.

h4. web_port
h4. https

The port on which Riak's HTTP interface should listen (default: 8098")
A list of ip addresses and ports on which Riak's HTTP interface should listen (default: not enabled)

Riak's HTTP interface will not be started if this setting is not defined.
Riak's HTTPS interface will not be started if this setting is not defined.

h4. ssl

You can override the default SSL key and certificate settings (default: etc/cert.pem, etc/key.pem)

h3. riak_kv settings

Expand All @@ -128,25 +134,45 @@ A list of paths to add to the Erlang code path.

This setting is especially useful for allowing Riak to use external modules during map/reduce queries.

h4. js_max_vm_mem
h4. mapred_name

The maximum amount of memory allocated to each Javascript virtual machine, in megabytes. (default: "8")
The base of the path in the URL exposing [[MapReduce]] via HTTP. (default: "mapred")

h4. js_source_dir
h4. mapred_queue_dir

The directory used to store a transient queue for pending map tasts (default: "data/mrqueue")

h4. map_js_vm_count

Where to load user-defined built in Javascript functions (default: @unset@)
The number of Javascript VMs started to handle map phases. (default: "8")

h4. reduce_js_vm_count

The number of Javascript VMs started to handle reduce phases. (default: "6")

h4. hook_js_vm_count

The number of Javascript VMs started to handle pre-commit hooks.(default: "2")

h4. mapper_batch_size

Number of items the mapper will fetch in one request. Larger values can impact read/write performance for non-MapReduce requests. (default: "5")

h4. js_max_vm_mem

The maximum amount of memory allocated to each Javascript virtual machine, in megabytes. (default: "8")

h4. js_thread_stack

The maximum amount of thread stack space to allocate to Javascript virtual machines, in megabytes. (default: "16")

h4. js_vm_count
h4. map_cache_size

How many Javascript virtual machines to start (default: "8").
Number of obect 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")

h4. mapred_name
h4. js_source_dir

The base of the path in the URL exposing [[MapReduce]] via HTTP. (default: "mapred")
Where to load user-defined built in Javascript functions (default: unset)

h4. pb_ip

Expand Down

0 comments on commit dd31ff4

Please sign in to comment.