Merge branch 'master' of https://github.com/basho/basho_docs into ej/kv/backups

Author: erjohnson

.gitignore

@@ -24,3 +24,9 @@ static/riak/**
 static/riakcs/**
 static/riakee/**
 static/shared/**
+static/css/main.css
+static/css/main.css.map
+static/js/main.js
+
+vendor/
+.bundle/

config.yaml

@@ -73,7 +73,8 @@ params:
       releases:
         - ["2.0.0", "2.0.1", "2.0.2", "2.0.4", "2.0.5", "2.0.6", "2.0.7"]
         - ["2.1.1", "2.1.3", "2.1.4"]
-      latest: "2.1.4"
+        - ["2.2.0"]
+      latest: "2.2.0"
       lts: "2.0.7"
       archived_url: "http://docs.basho.com/riak/1.4.12/"
     riak_cs:
@@ -88,20 +89,20 @@ params:
     riak_ts:
       path: "/riak/ts"
       archived_path: "/riakts"
-      latest: "1.4.0"
       releases:
         - ["1.0.0"]
         - ["1.1.0"]
         - ["1.2.0"]
         - ["1.3.0", "1.3.1"]
         - ["1.4.0"]
-      archived_path: "riakts"
+        - ["1.5.0"]
+      latest: "1.5.0"
     dataplatform:
       path: "/dataplatform"
       archived_path: "/dataplatform"
-      latest: "1.0.0"
       releases:
         - ["1.0.0"]
+      latest: "1.0.0"
 ---
 
 

content/community/productadvisories.md

@@ -20,7 +20,7 @@ aliases:
 
 This page contains product advisories that are periodically issued for Basho products.
 
-
+* [Slight chance that AAE could stall itself or crash a Riak node](/community/productadvisories/aaestall/)
 * [Default Configuration For Handoff May Cause Data Loss in TS](/community/productadvisories/130-dataloss/)
 * [LevelDB SEGV in Riak KV 2.1.3](/community/productadvisories/leveldbsegfault/)
 * [Possibility of Code Injection on Riak Init File](/community/productadvisories/codeinjectioninitfiles/)
@@ -31,6 +31,7 @@ This page contains product advisories that are periodically issued for Basho pro
 * [SSL 3.0 Vulnerability and POODLE Attack](/community/productadvisories/sslpoodle/)
 * [Map Data Type Disk Incompatibility](/community/productadvisories/maps-204/)
 
+
 ## Questions
 
 If you have questions about any of the advisories listed above, please

content/community/productadvisories/aaestall.md

@@ -0,0 +1,156 @@
+---
+title: "Active Anti-Entropy: Slight chance that AAE could stall itself or crash a Riak node."
+description: ""
+menu:
+  community:
+    name: "AAE: Slight Chance for Stall or Crash"
+    identifier: "aaestall"
+    weight: 050
+    parent: "productadvisories"
+toc: true
+---
+
+
+Info |Value
+:----|:----
+Date issued | November 17, 2016
+Product | Riak KV 
+Affected versions | Riak KV 2.0.0+, Riak KV 2.1.0+
+
+
+## Overview
+
+There exists a highly unlikely condition where Riak KV’s active anti-entropy feature can either stall or cause a segmentation fault crash.
+
+{{% note title="Riak KV Enterprise Edition" %}}
+If you are using Riak KV Enterprise Edition, please see the Product Advisory in the Basho Support Portal for your patches and instructions.
+{{% /note %}}
+
+
+## Description
+
+The active anti-entropy feature (AAE) has a procedure known as a hash tree rebuild.  This procedure uses a LevelDB feature called an iterator.  The rebuild procedure has the potential to simultaneously instruct the iterator to retrieve the next data item and to close the iterator.  The probability of both happening is very slight, but Basho was able to create the simultaneous instructions under extremely heavy loads across many hours.
+
+
+AAE stores its metadata within a LevelDB database.  This metadata is independent of the user’s selected storage backend for Riak (LevelDB, Bitcask, memory, or multi).  Therefore all users of AAE are impacted regardless of their chosen storage backend.
+
+
+## Affected Users
+
+You could be impacted if you are running one of the listed versions of Riak KV and your riak.conf has the default setting: `entropy = active`.
+
+* Riak KV 2.0.0+
+* Riak KV 2.1.0+
+
+
+## Impact
+
+Active entropy hash tree rebuilds could stall indefinitely on a Riak node, or
+A Riak node could experience a segmentation fault that requires restarting Riak.
+
+
+## Mitigation Strategy
+
+There are two approaches you can take to mitigate this issue:
+
+* Update to the newly released Riak KV 2.2, or 
+* Patch eLevelDB to 2.0.32.
+
+
+## Patching eLevelDB to 2.0.32
+
+If an upgrade to Riak KV 2.2 is not possible in your environment, the LevelDB library can be patched. This patch contains natively-compiled code and is operating system specific.
+
+{{% note title="WARNING" %}}
+Do not apply the eleveldb.so patch to Riak TS, it will prevent it functioning correctly.
+{{% /note %}}
+
+
+#### OS specific package links:
+
+* [Debian 6](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_debian6.tar.gz)
+* [Debian 7](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_debian7.tar.gz)
+* [Fedora 19](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_fedora19.tar.gz)
+* [FreeBSD 9](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_freebsd10.tar.gz)
+* [OS X 10](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_osx10.8.tar.gz)
+* [RHEL 5](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_rhel5.tar.gz)
+* [RHEL 6](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_rhel6.tar.gz)
+* [RHEL 7](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_rhel7.tar.gz)
+* [SLES 11](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_sles11.tar.gz)
+* [SmartOS 1.8](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_smartos1.8.tar.gz)
+* [SmartOS 13.1](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_smartos13.1.tar.gz)
+* [Solaris 10](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_solaris10.tar.gz)
+* [Ubuntu Lucid](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_ubuntuLucid.tar.gz)
+* [Ubuntu Precise](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_ubuntuPrecise.tar.gz)
+* [Ubuntu Trusty](https://s3.amazonaws.com/downloads.basho.com/patches/eleveldb/2.0.32/eleveldb_2.0.32_ubuntuTrusty.tar.gz)
+
+
+### Install the Patch
+
+To install this patch, on each node in the cluster you must:
+
+
+1. Determine your eleveldb directory<a name="determining"></a>.  
+    1. Find the Riak `lib` directory
+        * RHEL/Centos/Fedora/SLES: `/usr/lib64/riak/lib/`
+        * Ubuntu/Debian: `/usr/lib/riak/lib/`
+        * FreeBSD: `/usr/local/lib/riak/lib/`
+        * SmartOS: `/opt/local/lib/riak/lib/`
+        * Solaris: `/opt/riak/lib/`
+    1. Consult the directory listing for a directory beginning with `eleveldb`, for example: `eleveldb-2.0.17-0-g973fc92` on Riak KV 2.1.4 or `eleveldb-2.0.22-0-g185e296` on Riak KV 2.0.7
+    1. Make a note of this directory name for the following steps.
+
+
+1. Stop the node by running `riak stop`.
+1. Change to the priv subdirectory of [your eleveldb directory](#determining).
+1. Rename the original eleveldb.so file to eleveldb.so.orig.
+1. Copy the provided eleveldb.so to the directory and verify correct permissions.
+1. If possible, verify that the md5sum of the eleveldb.so located in the eleveldb priv directory is correct.
+1. Change into the ebin subdirectory of [your eleveldb directory](#determining).
+1. Rename the original eleveldb.beam file to eleveldb.beam.orig.
+1. Copy the provided eleveldb.beam to the directory and verify correct permissions.
+1. If possible, verify that the md5sum of the eleveldb.beam located in the eleveldb ebin directory is correct.
+1. Start the node by running `riak start`.
+
+
+### To back out of this patch, on each node in the cluster you must:
+
+1. Determine your eleveldb directory<a name="determining2"></a>.  
+    1. Change to the Riak lib directory
+        * RHEL/Centos/Fedora/SLES: `/usr/lib64/riak/lib/`
+        * Ubuntu/Debian: `/usr/lib/riak/lib/`
+        * FreeBSD: `/usr/local/lib/riak/lib/`
+        * SmartOS: `/opt/local/lib/riak/lib/`
+        * Solaris: `/opt/riak/lib/`
+    1. Consult the directory listing for a directory beginning with `eleveldb`, for example: `eleveldb-2.0.17-0-g973fc92` on Riak KV 2.1.4 or `eleveldb-2.0.22-0-g185e296` on Riak KV 2.0.7
+    1. Make a note of this directory name for the following steps.
+
+
+1. Stop the node by running `riak stop`.
+1. Change to the priv subdirectory of [your eleveldb directory](#determining).
+1. Verify that you have an eleveldb.so.orig file present in this directory.
+1. Remove the patched eleveldb.so file.
+1. Rename `eleveldb.so.orig` to `eleveldb.so`.
+1. Change into the ebin subdirectory of [your eleveldb directory](#determining).
+1. Verify that you have an eleveldb.beam.orig file present in this directory.
+1. Remove the patched `eleveldb.beam` file.
+1. Rename `eleveldb.beam.orig` to `eleveldb.beam`.
+1. Start the node by running `riak start`.
+
+
+## Verifying the Patch Installation
+
+When the patch is installed, the LevelDB LOG files will report that version 2.0.31 is installed. 
+
+
+{{% note %}}
+**Note**:  this is eleveldb version 2.0.32 but the leveldb LOG file is expected to report 2.0.31. 
+{{% /note %}}
+
+
+The LOG files for each running vnode will have a log line similar to the following:
+
+
+```
+2016/03/17-18:42:50.544293 7ffaaf3b1700             Version: 2.0.31
+```

content/riak/kv/2.0.0/configuring/basic.md

@@ -34,6 +34,7 @@ aliases:
 [perf open files]: /riak/kv/2.0.0/using/performance/open-files-limit
 [perf index]: /riak/kv/2.0.0/using/performance
 [perf aws]: /riak/kv/2.0.0/using/performance/amazon-web-services
+[Cluster Capacity Planning]: /riak/kv/2.0.0/setup/planning/cluster-capacity/#ring-size-number-of-partitions
 
 This document covers the parameters that are commonly adjusted when
 setting up a new cluster. We recommend that you also review the detailed
@@ -97,7 +98,7 @@ be negatively impacted by the excessive number of concurrent databases
 running on each server; if the ring size is too small, the servers' other
 resources (primarily CPU and RAM) will go underutilized.
 
-See [Planning for a Riak System][plan start] and [Scaling and Operating Riak Best Practices][plan best practices] for more details on choosing a ring size.
+See [Cluster Capacity Planning] for more details on choosing a ring size.
 
 The steps involved in changing the ring size depend on whether the
 servers (nodes) in the cluster have already been joined together.

content/riak/kv/2.0.0/configuring/reference.md

@@ -453,7 +453,7 @@ When configuring buckets [using bucket types][cluster ops bucket types], the tab
 <br /><br />
 <strong>Note</strong>: See <a href="../../developing/usage/conflict-resolution">
 Conflict Resolution</a> for a discussion of siblings.</td>
-<td><code>true</code></td>
+<td><code>false</code></td>
 </tr>
 
 <tr>

content/riak/kv/2.0.0/developing/api/http/search-query.md

@@ -61,10 +61,9 @@ has no documents associated with it:
     "start": 0
   },
   "responseHeader": {
+    "status": 0,
     "QTime": 10,
-    "params": { /* internal info from the query */ },
-    "wt": "json"
-  },
-  "status": 0
+    "params": { /* internal info from the query */ }
+  }
 }
 ```

content/riak/kv/2.0.0/developing/api/protocol-buffers/dt-fetch.md

@@ -51,14 +51,13 @@ Parameter | Description
 > All of the optional parameters below have default values determined on a
 per-bucket basis. Please refer to the documentation on [setting bucket properties](/riak/kv/2.0.0/developing/api/protocol-buffers/set-bucket-props) for more information.
 
-Furthermore, you can assign an integer value to the <code>r</code> and
-<code>pr</code>, provided that that integer value is less than or equal
-to N, <em>or</em> a special value denoting <code>one</code>
-(<code>4294967295-1</code>), <code>quorum</code>
-(<code>4294967295-2</code>), <code>all</code>
-(<code>4294967295-3</code>), or <code>default</code>
-(<code>4294967295-4</code>).
-</div>
+Furthermore, you can assign an integer value to the `r` and
+`pr`, provided that that integer value is less than or equal
+to N, _or_ a special value denoting `one`
+(`4294967295-1`), `quorum`
+(`4294967295-2`), `all`
+(`4294967295-3`), or `default`
+(`4294967295-4`).
 
 Parameter | Description
 :---------|:-----------