Skip to content

Commit

Permalink
reflect core/kv splitup in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
argv0 committed Jun 7, 2010
1 parent 9b8658d commit fae48f6
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 57 deletions.
58 changes: 29 additions & 29 deletions doc/admin.org
Expand Up @@ -9,7 +9,7 @@

As always, questions are welcome on the [[http://lists.basho.com/mailman/listinfo/riak-users_lists.basho.com][Riak mailing list]],
riak-users@basho.com. The latest version of this document, and
other Riak information is available at [[http://riak.basho.com/]].
other Riak information is available at [[http://wiki.basho.com/]].


* Downloading Riak
Expand All @@ -35,8 +35,8 @@
Riak can be installed in binary form on many RPM based systems,
the current target platforms are RHEL and CentOS. Riak can be
download in both 64bit and 32bit binaries in rpm format here:
32bit: http://downloads.basho.com/riak/riak-0.9/riak-0.9.1-1.i386.rpm
64bit: http://downloads.basho.com/riak/riak-0.9/riak-0.9.1-1.x86_64.rpm
32bit: http://downloads.basho.com/riak/riak-0.11/riak-0.11.0-1.i386.rpm
64bit: http://downloads.basho.com/riak/riak-0.11/riak-0.11.0-1.x86_64.rpm

Note: On 32bit systems you may need to disable SE Linux if
it is enabled.
Expand All @@ -47,15 +47,15 @@
Debian packaging system, the current target platforms are
Ubuntu and Debian. Riak can be download in both 64bit and 32bit
binaries in deb format here:
32bit: http://downloads.basho.com/riak/riak-0.9/riak_0.9.1-1_i386.deb
64bit: http://downloads.basho.com/riak/riak-0.9/riak_0.9.1-1_amd64.deb
32bit: http://downloads.basho.com/riak/riak-0.11/riak_0.11.0-1_i386.deb
64bit: http://downloads.basho.com/riak/riak-0.11/riak_0.11.0-1_amd64.deb

*** Mac OS X

Riak can be downloaded and ran from a precompiled tarball for OS X.
You can download the 32bit and 64bit builds here:
32bit: http://downloads.basho.com/riak/riak-0.9/riak-0.9.1.osx.i386.tar.gz
64bit: http://downloads.basho.com/riak/riak-0.9/riak_0.9.1.osx.x86_64.tar.gz
32bit: http://downloads.basho.com/riak/riak-0.11/riak-0.11.0.osx.i386.tar.gz
64bit: http://downloads.basho.com/riak/riak-0.11/riak_0.11.0.osx.x86_64.tar.gz

** Source Releases
*** Prerequisites
Expand All @@ -66,7 +66,7 @@
*** Obtaining Riak Source

The source for tagged Riak releases is available as tarballs at
http://hg.basho.com/riak/get/riak-0.9.1.tar.gz. Once downloaded, unpack the
http://hg.basho.com/riak/get/riak-0.11.0.tar.gz. Once downloaded, unpack the
tarball in a convenient location.

If you prefer to follow the latest Riak development, use Mercurial
Expand Down Expand Up @@ -322,8 +322,8 @@
#+BEGIN_SRC erlang
[
{riak, [
{storage_backend, riak_dets_backend},
{riak_dets_backend_root, "data/dets"}
{storage_backend, riak_kv_dets_backend},
{riak_kv_dets_backend_root, "data/dets"}

%% More Riak settings...
]}
Expand Down Expand Up @@ -361,13 +361,13 @@
in the cluster, without worrying about underuse due to owning
too few partitions.

+ =riak_web_ip= :: the ip address on which Riak's HTTP interface
+ =web_ip= :: the ip address on which Riak's HTTP interface
should listen (default: ="127.0.0.1"=)

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

+ =riak_web_port= :: the port on which Riak's HTTP interface should
+ =web_port= :: the port on which Riak's HTTP interface should
listen (default: =8098=)

Riak's HTTP interface will not be started if
Expand All @@ -382,36 +382,36 @@
=/bar/Bucket/Key=.

+ =storage_backend= :: module name of the storage backend that
Riak should use (default: =riak_dets_backend=)
Riak should use (default: =riak_kv_bitcask_backend=)

The storage format Riak uses is configurable. Riak will
refuse to start if no storage backend is specified.

Available backends, and their additional configuration
options are:

- =riak_dets_backend= :: data is stored in DETS files
- =riak_kv_dets_backend= :: data is stored in DETS files

* =riak_dets_backend_root= :: root directory where DETS
* =riak_kv_dets_backend_root= :: root directory where DETS
files are stored (default: "data/dets")

- =riak_ets_backend= :: data is stored in ETS tables
- =riak_kv_ets_backend= :: data is stored in ETS tables
(in-memory)

- =riak_gb_trees_backend= :: data is stored in ETS tables
- =riak_kv_gb_trees_backend= :: data is stored in ETS tables
(in-memory)

- =riak_fs_backend= :: data is stored in binary files on the
- =riak_kv_fs_backend= :: data is stored in binary files on the
filesystem

* =riak_fs_backend_root= :: root directory where files
* =riak_kv_fs_backend_root= :: root directory where files
are stored

- =riak_multi_backend= :: enables storing data for different
- =riak_kv_multi_backend= :: enables storing data for different
buckets in different backends

Specify the backend to use for a bucket with
=riak_bucket:set_bucket(BucketName, [{backend, BackendName}])=
=riak_core_bucket:set_bucket(BucketName, [{backend, BackendName}])=

* =multi_backend_default= :: default backend to use if
none is specified for a bucket (one of the
Expand All @@ -429,17 +429,17 @@
a parameter that will be passed to the =start/2=
function of the backend module.

- =riak_cache_backend= :: a backend that behaves as an
- =riak_kv_cache_backend= :: a backend that behaves as an
LRU-with-timed-expiry cache

* =riak_cache_backend_memory= :: maximum amount of
* =riak_kv_cache_backend_memory= :: maximum amount of
memory to allocate, in megabytes (default: 100)

* =riak_cache_backend_ttl= :: amount by which to extend
* =riak_kv_cache_backend_ttl= :: amount by which to extend
an object's expiry lease on each access, in seconds
(default: 600)

* =riak_cache_backend_max_ttl= :: maximum allowed lease
* =riak_kv_cache_backend_max_ttl= :: maximum allowed lease
time (default: 3600)

+ =add_paths= :: a list of paths to add to the Erlang code path
Expand All @@ -452,7 +452,7 @@
default

Properties in this list will override the hardcoded defaults
in riak_bucket:defaults/0. This setting is the best way to
in riak_core_bucket:defaults/0. This setting is the best way to
set things like:

- the default N-value for Riak objects (=n_val=)
Expand All @@ -462,7 +462,7 @@
+ =riak_stat= ::
enable the statistics-aggregator (default: false)

+ =riak_handoff_port= ::
+ =handoff_port= ::
TCP port number for the handoff listener (default: 8099)

+ =handoff_concurrency= ::
Expand Down Expand Up @@ -603,9 +603,9 @@
claimed partitions by attaching to a console in the cluster and
requesting a copy of the claim ring:

: 1> {ok, R} = riak_ring_manager:get_my_ring().
: 1> {ok, R} = riak_core_ring_manager:get_my_ring().
: {ok,{chstate,...
: 2> riak_ring:all_members(R).
: 2> riak_core_ring:all_members(R).
: ['riak@10.0.0.1','riak@10.0.0.2','riak@10.0.0.3']

You should see the names of all the nodes in your cluster in the
Expand Down
21 changes: 11 additions & 10 deletions doc/architecture.txt
Expand Up @@ -59,14 +59,15 @@ vnode that "claims" the partition in which the key resides, as well as
to the next N-1 partitions. The request also specifies R (=< N), the
number of vnodes that must reply before a response is returned.

The riak node startup is defined by the riak_sup module.
The riak node startup are defined by the riak_core_sup and riak_kv_sup
modules.

The riak ring is defined by the riak_ring module.
The riak ring is defined by the riak_core_ring module.

Vnodes are defined by the riak_vnode module.
Vnodes are defined by the riak_kv_vnode module.

Gets and Puts are driven by the riak_get_fsm and riak_put_fsm modules,
respectively.
Gets and Puts are driven by the riak_kv_get_fsm and riak_kv_put_fsm
modules, respectively.


Gossiping
Expand All @@ -78,8 +79,8 @@ announces its change via this protocol. It also periodically
re-announces what it knows about the ring, in case any nodes missed
previous updates.

This gossip protocol is defined in the riak_ring_gossiper and
riak_ring_manager modules.
This gossip protocol is defined in the riak_core_gossip and
riak_core_ring_manager modules.


Vclocks
Expand Down Expand Up @@ -133,11 +134,11 @@ make decisions about how best to store them.

Four backends are packaged with Riak:

1. riak_fs_backend, which stores data directly to files in a nested
1. riak_kv_fs_backend, which stores data directly to files in a nested
directory structure on disk
2. riak_ets_backend, which stores data in ETS tables (which makes it
2. riak_kv_ets_backend, which stores data in ETS tables (which makes it
volatile storage, but great for debugging)
3. riak_dets_backend, which stores data on-disk in DETS tables
3. riak_kv_dets_backend, which stores data on-disk in DETS tables

[1] http://s3.amazonaws.com/AllThingsDistributed/sosp/amazon-dynamo-sosp2007.pdf
[2] http://portal.acm.org/citation.cfm?doid=564585.564601
Expand Down
30 changes: 15 additions & 15 deletions doc/basic-setup.txt
Expand Up @@ -53,17 +53,17 @@ file. The syntax is simply:
Normally, this will look something like:

[
{riak, [
{storage_backend, riak_dets_backend},
{riak_dets_backend_root, "data/dets"}
{riak_kv, [
{storage_backend, riak_kv_dets_backend},
{riak_kv_dets_backend_root, "data/dets"}
]},
{sasl, [
{sasl_error_logger, {file, "log/sasl-error.log"}}
]}
].

This would set the 'storage_backend' and 'riak_dets_backend_root'
options for the 'riak' application, and the 'sasl_error_logger' option
This would set the 'storage_backend' and 'riak_kv_dets_backend_root'
options for the 'riak_kv' application, and the 'sasl_error_logger' option
for the 'sasl' application.

The following parameters can be used in app.config to configure Riak
Expand Down Expand Up @@ -98,21 +98,21 @@ storage_backend: atom
riak_ets_backend, and riak_dets_backend. Some
backends have their own set of configuration parameters.

riak_fs_backend:
riak_kv_fs_backend:
A backend that uses the filesystem directly to store data. Data
are stored in Erlang binary format in files in a directory
structure on disk.

riak_fs_backend_root: string
The directory under which this backend will store its files.

riak_ets_backend:
riak_kv_ets_backend:
A backend that uses ETS to store its data.

riak_dets_backend:
riak_kv_dets_backend:
A backend that uses DETS to store its data.

riak_dets_backend_root: string
riak_kv_dets_backend_root: string
The directory under which this backend will store its files.


Expand Down Expand Up @@ -142,16 +142,16 @@ bit. Some recommended changes:
riak@VISIBLE.HOSTNAME. This will allow Riak nodes separate machines
to communicate.

* Change 'riak_web_ip' in app.config if you'll be accessing that
interface from a non-host-local client.
* Change 'web_ip' in the 'riak_core' section of app.config if you'll be
accessing that interface from a non-host-local client.

* Consider adding a 'ring_creation_size' entry to app.config, and
setting it to a number higher than the default of 64. More
partitions will allow you to add more Riak nodes later, if you need
to.

* Consider changing the 'riak_storage_backend' entry in app.config.
Depending on your use case, riak_dets_backend may not be your best
* Consider changing the 'storage_backend' entry in app.config.
Depending on your use case, riak_kv_dets_backend may not be your best
choice.

To get the cluster, up and running, first start Riak on each node with
Expand All @@ -167,10 +167,10 @@ all nodes are represented:

$ bin/riak attach
Attaching to /tmp/erlang.pipe.1 (^D to exit)
(riak@box1.example.com)1> {ok, R} = riak_ring_manager:get_my_ring().
(riak@box1.example.com)1> {ok, R} = riak_core_ring_manager:get_my_ring().
{ok,{chstate,'riak@box1.example.com',
...snip...
(riak@box1.example.com)2> riak_ring:all_members(R).
(riak@box1.example.com)2> riak_core_ring:all_members(R).
['riak@box1.example.com','riak@box2.example.com']


Expand Down
6 changes: 3 additions & 3 deletions doc/raw-http-howto.txt
@@ -1,10 +1,10 @@
How to Use the Riak HTTP Interface

Step 1 in using the Riak HTTP interface is to enable the Riak web
interface. Add these two lines to your riak config:
interface. Add these two lines to your riak config, in the 'riak_core' section:

{riak_web_ip, "127.0.0.1"}.
{riak_web_port, 8098}.
{web_ip, "127.0.0.1"}.
{web_port, 8098}.

Now start Riak with your config file, and you'll find the HTTP
interface at http://127.0.0.1:8098/riak/... If you'd rather have some
Expand Down

0 comments on commit fae48f6

Please sign in to comment.