| Overview |  |
app.config and
vm.args files will be parsed and memoized, and lager
will be started on the console at the configured severity level.
| base_dir/0 | The base directory from which the Riak script runs. |
| cookie/0 | The Riak node's distributed Erlang cookie. |
| data_directories/0 | Determines where Riak is configured to store data. |
| etc_dir/0 | The Riak configuration directory. |
| get_app_env/1 | Get a key out of the app.config file. |
| get_app_env/2 | Get a key out of the app.config file, or if it doesn't exist, return the Default. |
| get_vm_env/1 | Get an -env flag out of the vm.args file. |
| node_name/0 | The local Riak node name. |
| prepare/0 | Prepares appropriate configuration so the riaknostic script can run. |
| user/0 | Determines the user/uid that the installed Riak runs as. |
base_dir() -> file:filename()
The base directory from which the Riak script runs.
cookie() -> atom()
The Riak node's distributed Erlang cookie.
data_directories() -> [file:filename()]
Determines where Riak is configured to store data. Returns a list of paths to directories defined by storage backends.
etc_dir() -> file:filename()
The Riak configuration directory.
get_app_env(Keys::[atom()]) -> undefined | term()
Equivalent to get_app_env(Keys, undefined).
Get a key out of the app.config file. You specify a nested
key using a list of atoms, e.g. [riak_kv, storage_backend].
get_app_env(Keys::[atom()], Default::term()) -> term()
Get a key out of the app.config file, or if it doesn't exist,
return the Default. You specify a nested key using a list of atoms,
e.g. [riak_kv, storage_backend].
See also: get_app_env/1.
get_vm_env(Key::string()) -> string() | undefined
Get an -env flag out of the vm.args file.
node_name() -> {shortnames | longnames, Name::string()}
The local Riak node name. Includes whether the node uses short or long nodenames for distributed Erlang.
prepare() -> ok | {error, iodata()}
Prepares appropriate configuration so the riaknostic script can run. This is called by the riaknostic module and you do not need to invoke it.
user() -> string()
Determines the user/uid that the installed Riak runs as.
Generated by EDoc, Feb 18 2012, 03:37:56.
