You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by al...@apache.org on 2018/08/10 21:42:35 UTC
svn commit: r1837837 [2/5] - in /jackrabbit/site/live/oak/docs: ./
architecture/ coldstandby/ features/ nodestore/ nodestore/document/
nodestore/segment/ oak-mongo-js/ oak_api/ plugins/ query/ security/
security/accesscontrol/ security/authentication/ ...
Modified: jackrabbit/site/live/oak/docs/nodestore/document/metrics.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/document/metrics.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/metrics.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/metrics.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Metrics</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
@@ -248,7 +250,6 @@
<ul>
<li>Counter: a monotonically increasing number. Though, the value will be reset to zero when Oak is restarted.</li>
-<li>Gauge: an instantaneous measurement of a value. E.g. the current length of a queue.</li>
<li>Meter: measures the rate of an event or action per second.</li>
<li>Timer: measures the rate of an event or action per second and provides information on the distribution of the duration (percentiles).</li>
</ul>
@@ -422,34 +423,38 @@
</thead><tbody>
<tr class="b">
+<td>DOCUMENT_NS_BGR_LAG </td>
+<td> The approximate lag in milliseconds of external changes the async background reader pulls in from other cluster nodes. </td>
+<td> average lag in milliseconds</td></tr>
+<tr class="a">
<td>DOCUMENT_NS_BGR_NUM_CHANGES_RATE </td>
<td> The number of changes the async background reader pulls in from other cluster nodes. This does not necessarily mean a cluster node reads the documents for all those changes, but it must at least invalidate the affected documents in the cache.</td>
<td> changes per second</td></tr>
-<tr class="a">
+<tr class="b">
<td>DOCUMENT_NS_BGW_NUM_WRITE_RATE </td>
<td> The number of documents the async background writer updates and pushes to the DocumentStore. </td>
<td> updates per second</td></tr>
-<tr class="b">
+<tr class="a">
<td>DOCUMENT_NS_BRANCH_COMMIT_COUNT </td>
<td> The number of branch commits performed by this DocumentNodeStore. </td>
<td> branch commits per second</td></tr>
-<tr class="a">
+<tr class="b">
<td>DOCUMENT_NS_MERGE_BRANCH_COMMIT_COUNT </td>
<td> The number of branch commits merged. This count can be lower than the branch commit count because some branch commits have not yet been merged or never will be merged. </td>
<td> branch commits merged per second</td></tr>
-<tr class="b">
+<tr class="a">
<td>DOCUMENT_NS_MERGE_FAILED_EXCLUSIVE </td>
<td> The number of failed merges while holding the merge lock exclusively. </td>
<td> failed merges per second</td></tr>
-<tr class="a">
+<tr class="b">
<td>DOCUMENT_NS_MERGE_SUCCESS_COUNT </td>
<td> The number of successful merges </td>
<td> merges per second</td></tr>
-<tr class="b">
+<tr class="a">
<td>DOCUMENT_NS_MERGE_SUCCESS_EXCLUSIVE </td>
<td> The number of successful merges while holding the merge lock exclusively. </td>
<td> merges per second</td></tr>
-<tr class="a">
+<tr class="b">
<td>DOCUMENT_NS_MERGE_SUCCESS_SUSPENDED </td>
<td> The number of successful merges that previously had to be suspended because of a not yet visible conflict from another cluster node. </td>
<td> merges per second</td></tr>
@@ -502,6 +507,9 @@
<td>DOCUMENT_NS_BGW_TOTAL_TIME </td>
<td> The total time of a background write operation.</td></tr>
<tr class="a">
+<td>DOCUMENT_NS_LEASE_UPDATE </td>
+<td> The time it takes to update the lease.</td></tr>
+<tr class="b">
<td>DOCUMENT_NS_MERGE_SUCCESS_TIME </td>
<td> The time it takes a successful merge to complete. This does not include merge attempts that failed.</td></tr>
</tbody>
@@ -1010,6 +1018,8 @@
<ul>
<li>Background read and write operations. These operations are scheduled to run every second. If this interval gets too long, changes from other cluster nodes will get picked up with a delay, which can result in failed merges because of conflicts. As a general rule of thumb, background operations that take longer than ten seconds should be analyzed. Possible reasons for an unusually long background operation may be increased load on the system with many changes to write to or read from the <tt>DocumentStore</tt>, general slow down of the JVM because of increased Java GC activity or an overloaded backend store.</li>
+<li>Background read lag rate. This is similar to the schedule of the background read and write operations. The one minute rate is usually below 1000 milliseconds and should be analyzed when this rate is higher than ten seconds.</li>
+<li>Lease update rate and duration. The <tt>DocumentNodeStore</tt> updates the lease roughly every 10 seconds. A lease update is a lightweight operation and should usually complete quickly. An increased update time may indicate a network problem or an overloaded backend store. A system should be analyzed when the lease update rate drops below 3 updates per minute and requires immediate attention when the rate is at one update per minute or lower. Please note, the <tt>DocumentNodeStore</tt> will shut itself down when the lease expires (the default lease time is two minutes).</li>
<li>Revision GC rate and duration. Starting with Oak 1.8, Revision GC on MongoDB runs every five seconds. This is also known as Continuous Revision GC. This rate and the duration of a Revision GC cycle should be monitored and analyzed if the duration is more than five seconds for a couple of cycles.</li>
<li>Revision GC failure. These should not occur and require immediate attention. The log files should provide details in this case why the Revision GC failed.</li>
<li>Number of merges under an exclusive lock or that were suspended. Periods of increased merges with exclusive locks or suspended merges indicate conflicts usually caused by the application when multiple sessions try to write conflicting changes. The application should be analyzed to prevent such write patterns.</li>
Modified: jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – MongoDB DocumentStore</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/document/node-bundling.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/document/node-bundling.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/node-bundling.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/node-bundling.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Bundling Nodes</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/document/secondary-store.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/document/secondary-store.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/secondary-store.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/secondary-store.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Secondary NodeStore</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/document/upgrade.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/document/upgrade.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/upgrade.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/upgrade.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – DocumentNodeStore upgrade instructions</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/documentmk.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/documentmk.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/documentmk.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/documentmk.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Oak Document Storage</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
@@ -274,6 +276,7 @@
<ul>
<li><a href="#acquire-a-cluster-node-id">Acquire a Cluster Node ID</a></li>
+<li><a href="#update-lease-for-a-cluster-node-id">Update Lease for a Cluster Node ID</a></li>
<li><a href="#recovery-for-a-cluster-node-id">Recovery for a Cluster Node ID</a></li>
<li><a href="#rw-preference">Specifying the Read Preference and Write Concern</a></li>
</ul>
@@ -674,7 +677,6 @@ settings
</pre></div></div>
<p>In the above example, there are two active cluster nodes running with IDs <tt>1</tt> and <tt>2</tt>. The <tt>_id</tt> corresponds to the last part of the revisions generated by a cluster node. Please note, the <tt>_id</tt> representation is base 10, while the ID part of a revision is base 16! The <tt>instance</tt> is the current working directory and the <tt>machine</tt> is the lowest number of an active network adapter’s MAC address. If no active network adapter is available, then the value for the <tt>machine</tt> field will be a random UUID. The <tt>info</tt> field contains the same info as a string, plus additional information like the process ID.</p>
-<p>Each running cluster node updates the <tt>leaseEnd</tt> time of the cluster node ID every ten seconds, to ensure each cluster node uses a different cluster node ID. The time is the number of milliseconds since 1970 and with every update is set two minutes ahead of the current time. This lease mechanism allows other cluster nodes to identify active, inactive and crashed cluster nodes.</p>
<p>The diagram shows the different states a cluster node entry can be in.</p>
<p><img src="document/cluster-node-lease.png" alt="Cluster node ID state diagram" /></p>
<div class="section">
@@ -685,6 +687,13 @@ settings
<p>Immediately restarting a crashed cluster node will lead to a somewhat delayed startup, because the cluster node will find a matching and active cluster node ID. In this case, the cluster node will wait until the lease expires (up to two minutes if the process crashed right after the lease was extended) and then run the recovery process for the cluster node ID. Depending on timing, the recovery may also be started by another active cluster node. In this case, the starting cluster node would wait up to one minute for the recovery to finish. Either way, if the recovery was successful, the cluster node ID will have transitioned to the inactive state and can be acquired again as described before.</p>
<p>When a new cluster node is started and there is an inactive entry, then the cluster node will try to acquire it, even when its environment does not match the <tt>machine</tt> and <tt>instance</tt> fields. This behaviour is new and was introduced with Oak 1.10. Previous versions ignore entries that do not match the environment and would create a new entry.</p></div>
<div class="section">
+<h3><a name="Update_lease_for_a_cluster_node_ID"></a><a name="update-lease-for-a-cluster-node-id"></a> Update lease for a cluster node ID</h3>
+<p>Each running cluster node updates the <tt>leaseEnd</tt> time of the cluster node ID every ten seconds, to ensure each cluster node uses a different cluster node ID. The time is the number of milliseconds since 1970 and with every update the <tt>leaseEnd</tt> is set two minutes ahead of the current time. This lease mechanism allows other cluster nodes to identify active, inactive and crashed cluster nodes.</p>
+<p>Starting with Oak 1.4 the DocumentNodeStore will invoke a lease failure handler when it was unable to renew the lease in time. When deployed in an OSGi container, the <tt>DocumentNodeStoreService</tt> implements a lease failure handler that will stop the bundle with the DocumentNodeStore implementation. At this point appropriate monitoring of the system should detect this situation and restart the process. In addition to calling the lease failure handler, the DocumentNodeStore will also reject all future access to the underlying <tt>DocumentStore</tt> with a <tt>DocumentStoreException</tt>.</p>
+<p>The initial lease update mechanism implemented with Oak 1.4 is somewhat lenient. The implementation allows a lease update when it actually knows the lease expired. The reason for this decision was developer friendliness. Debugging a system often means the JVM is suspended for a while, which may result in an expired lease. In this situation, the DocumentNodeStore gives the background lease update thread a chance to still update the lease.</p>
+<p>With Oak 1.10 a new lease update mode was introduced: <tt>STRICT</tt>. This is the new default and immediately rejects access to the DocumentStore and calls the failure handler, when it detects an expired lease. The previous behaviour is still available with the <tt>LENIENT</tt> mode. See also OSGi <a href="../osgi_config.html#document-node-store">configuration</a> for the <tt>DocumentNodeStoreService</tt>.</p>
+<p>For testing purposes is it also possible to disable the lease check entirely with a system property: <tt>-Doak.documentMK.disableLeaseCheck=true</tt>.</p></div>
+<div class="section">
<h3><a name="Recovery_for_a_cluster_node_ID"></a><a name="recovery-for-a-cluster-node-id"></a> Recovery for a cluster node ID</h3>
<p>Recovery becomes necessary when the lease on a cluster node ID entry expires. This usually happens when the process that acquired the cluster node ID crashes, but the lease may also expire if the cluster node fails to extend the lease in time. In the latter case, the cluster node is obligated to stop any further operations on the document store. The current implementation does this by blocking operations on the document store level and stopping the oak-store-document bundle when it detects an outdated lease. Other active cluster nodes or the restarted cluster node are then responsible for running recovery for the relevant cluster node ID and setting the state back to inactive.</p>
<p>Before a cluster node can run the recovery process, the recovery lock on the cluster node ID entry must be acquired. This lock again is protected with a lease to detect a crashed cluster node that was performing recovery and left behind a recovery lock. Other cluster nodes will therefore check whether the cluster node ID identified by <tt>recoveryBy</tt> is still active and try to break the recovery lock if the recovering cluster node is considered inactive or expired.</p>
Modified: jackrabbit/site/live/oak/docs/nodestore/overview.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/overview.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/overview.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/overview.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Node Storage</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li class="active"><a href="#"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/persistent-cache.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/persistent-cache.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/persistent-cache.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/persistent-cache.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Persistent Cache</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/segment/changes.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/segment/changes.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/segment/changes.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/segment/changes.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Changes in the data format</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/segment/classes.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/segment/classes.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/segment/classes.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/segment/classes.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Design of Oak Segment Tar</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/segment/overview.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/segment/overview.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/segment/overview.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/segment/overview.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Oak Segment Tar</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
@@ -259,6 +261,7 @@
<li><a href="#tools">Tools</a>
<ul>
+<li><a href="#segment-copy">Segment-Copy</a></li>
<li><a href="#backup">Backup</a></li>
<li><a href="#restore">Restore</a></li>
<li><a href="#check">Check</a></li>
@@ -847,6 +850,25 @@ TarMK GC #2: compacting root.
<p>Oak Segment Tar exposes a number of command line tools that can be used to perform different tasks on the repository.</p>
<p>The tools are exposed as sub-commands of <a class="externalLink" href="https://github.com/apache/jackrabbit-oak/tree/trunk/oak-run">Oak Run</a>. The following sections assume that you have built this module or that you have a compiled version of it.</p>
<div class="section">
+<h3><a name="Remote_Segment_Stores"></a><a name="remote-segment-stores"></a> Remote Segment Stores</h3>
+<p>Besides the local storage in TAR files (previously known as TarMK), support for remote Segment Store(s) was introduced in Apache Oak. For connecting to a remote Segment Store, a <tt>cloud-prefix:URI</tt> argument needs to be provided. This applies wherever a <tt>PATH</tt> to the Segment Store was needed.</p>
+<p><b>Connection Instructions</b>:</p>
+<ul>
+
+<li><b>Microsoft Azure</b> The <tt>cloud-prefix</tt> for MS Azure is <tt>az</tt>, therefore a valid connection argument would be <tt>az:https://myaccount.blob.core.windows.net/container/repository</tt>, where the part after <tt>:</tt> is the Azure URL identifier for the <i>repository</i> directory inside the specified <i>container</i> of the <i>myaccount</i> Azure storage account. The last missing piece is the secret key which will be supplied as an environment variable, i.e. <tt>AZURE_SECRET_KEY</tt>.</li>
+</ul></div>
+<div class="section">
+<h3><a name="Segment-Copy"></a><a name="segment-copy"></a> Segment-Copy</h3>
+
+<div>
+<div>
+<pre class="source">java -jar oak-run.jar segment-copy [--verbose] SOURCE DESTINATION
+</pre></div></div>
+
+<p>The <tt>segment-copy</tt> command allows the “translation” of the Segment Store at <tt>SOURCE</tt> from one persistence type (e.g. local TarMK Segment Store) to a different persistence type (e.g. remote Azure Segment Store), saving the resulted Segment Store at <tt>DESTINATION</tt>. Unlike a sidegrade peformed with <tt>oak-upgrade</tt> (see <a href="#a....migration.md">Repository Migration</a>) which includes only the current head state, this translation includes <b>all previous revisions persisted in the Segment Store</b>, therefore retaining the entire history.</p>
+<p><tt>SOURCE</tt> must be a valid path/uri to an existing Segment Store. <tt>DESTINATION</tt> must be a valid path/uri for the resulting Segment Store. Both are specified as <tt>PATH | cloud-prefix:URI</tt>. Please refer to the <a href="#remote-segment-stores">Remote Segment Stores</a> section for details on how to correctly specify connection URIs.</p>
+<p>If the <tt>--verbose</tt> option is specified, the command will print detailed progress information messages. These include individual segments being transfered from <tt>SOURCE</tt> to <tt>DESTINATION</tt> at a certain point in time. If not specified, progress information messages will be disabled.</p></div>
+<div class="section">
<h3><a name="Backup"></a><a name="backup"></a> Backup</h3>
<div>
@@ -895,10 +917,10 @@ TarMK GC #2: compacting root.
<div>
<div>
-<pre class="source">java -jar oak-run.jar compact [--force] [--mmap] PATH
+<pre class="source">java -jar oak-run.jar compact [--force] [--mmap] PATH | cloud-prefix:URI
</pre></div></div>
-<p>The <tt>compact</tt> command performs offline compaction of the Segment Store at <tt>PATH</tt>. <tt>PATH</tt> must be a valid path to an existing Segment Store.</p>
+<p>The <tt>compact</tt> command performs offline compaction of the local/remote Segment Store at <tt>PATH</tt>/<tt>URI</tt>. <tt>PATH</tt>/<tt>URI</tt> must be a valid path/uri to an existing Segment Store. Currently, Azure Segment Store is the only supported remote Segment Store. Please refer to the <a href="#remote-segment-stores">Remote Segment Stores</a> section for details on how to correctly specify connection URIs.</p>
<p>If the optional <tt>--force [Boolean]</tt> argument is set to <tt>true</tt> the tool ignores a non matching Segment Store version. <i>CAUTION</i>: this will upgrade the Segment Store to the latest version, which is incompatible with older versions. <i>There is no way to downgrade an accidentally upgraded Segment Store</i>.</p>
<p>The optional <tt>--mmap [Boolean]</tt> argument can be used to control the file access mode. Set to <tt>true</tt> for memory mapped access and <tt>false</tt> for file access. If not specified, memory mapped access is used on 64 bit systems and file access is used on 32 bit systems. On Windows, regular file access is always enforced and this option is ignored.</p>
<p>To enable logging during offline compaction a Logback configuration file has to be injected via the <tt>logback.configurationFile</tt> property. In addition the <tt>compaction-progress-log</tt> property controls the number of compacted nodes that will be logged. The default value is 150000.</p>
Modified: jackrabbit/site/live/oak/docs/nodestore/segment/records.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/segment/records.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/segment/records.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/segment/records.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Segments and records</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/segment/tar.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/segment/tar.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/segment/tar.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/segment/tar.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Structure of TAR files</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/nodestore/segmentmk.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/segmentmk.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/segmentmk.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/segmentmk.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Segment Storage Design Overview</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/oak_api/error_codes.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak_api/error_codes.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak_api/error_codes.html (original)
+++ jackrabbit/site/live/oak/docs/oak_api/error_codes.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Error Codes</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/oak_api/overview.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak_api/overview.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak_api/overview.html (original)
+++ jackrabbit/site/live/oak/docs/oak_api/overview.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Oak API</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li class="active"><a href="#"><span class="none"></span>Oak API</a>
</li>
<li class="nav-header">Features and Plugins</li>
Modified: jackrabbit/site/live/oak/docs/osgi_config.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/osgi_config.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/osgi_config.html (original)
+++ jackrabbit/site/live/oak/docs/osgi_config.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Repository OSGi Configuration</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
@@ -354,91 +356,138 @@
<div class="section">
<h4><a name="DocumentNodeStore"></a>DocumentNodeStore</h4>
<p><i>PID <tt>org.apache.jackrabbit.oak.plugins.document.DocumentNodeStoreService</tt></i></p>
-<dl>
+<table border="0" class="table table-striped">
+<thead>
-<dt>mongouri</dt>
-<dd>Default - <a class="externalLink" href="mongodb://localhost:27017">mongodb://localhost:27017</a></dd>
-<dd>Specifies the <a class="externalLink" href="http://docs.mongodb.org/manual/reference/connection-string/">MongoURI</a> required to connect to Mongo Database</dd>
-<dt>db</dt>
-<dd>Default - oak</dd>
-<dd>Name of the database in Mongo</dd>
-<dt>socketKeepAlive</dt>
-<dd>Default - true (was ‘false’ before 1.10)</dd>
-<dd>Enables socket keep-alive for MongoDB connections</dd>
-<dd>Since 1.8.0, 1.6.2, 1.4.16</dd>
-<dt>cache</dt>
-<dd>Default - 256</dd>
-<dd>Cache size in MB. This is distributed among various caches used in DocumentNodeStore</dd>
-<dt>changesSize</dt>
-<dd>Default - 256</dd>
-<dd>Size in MB of capped collection used in Mongo for caching the diff output.</dd>
-<dt>customBlobStore</dt>
-<dd>Default false</dd>
-<dd>Boolean value indicating that custom <tt>BlobStore</tt> to use. By default it uses <tt>MongoBlobStore</tt>.</dd>
-<dt>maxReplicationLagInSecs</dt>
-<dd>Default 21600 (6 hours)</dd>
-<dd>Determines the duration beyond which it can be safely assumed that state on secondary would be consistent with primary and its safe to read from them. (See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1645">OAK-1645</a>)</dd>
-<dt>blobGcMaxAgeInSecs</dt>
-<dd>Default 86400 (24 hrs)</dd>
-<dd>Blob Garbage Collector (GC) logic would only consider those blobs for GC which are not accessed recently (currentTime - lastModifiedTime > blobGcMaxAgeInSecs). For example as per default only those blobs which have been created 24 hrs ago would be considered for GC. It is strongly advised to not set this property to a very low value of say a few minutes but only set it to a hour at a minimum. This is to ensure that the NodeStore(s) have had the time to flush out its internal data structures to persistence and the references to recently added blobs are accounted.</dd>
-<dt>versionGcMaxAgeInSecs</dt>
-<dd>Default 86400 (24 hrs)</dd>
-<dd>Oak uses MVCC model to store the data. So each update to a node results in new version getting created. This duration controls how much old revision data should be kept. For example if a node is deleted at time T1 then its content would only be marked deleted at revision for T1 but its content would not be removed. Only when a Revision GC is run then its content would removed and that too only after (currentTime -T1 > versionGcMaxAgeInSecs)</dd>
-<dt>versionGCExpression</dt>
-<dd>Default ""</dd>
-<dd>A cron expression that defines when the Revision GC is scheduled. If this configuration entry is left empty, the default behaviour depends on the <tt>documentStoreType</tt>. For <tt>MONGO</tt> the default is to schedule a run every five seconds (also known as Continuous Revision Garbage Collection). For <tt>RDB</tt> the default is no scheduled GC. It must be enabled explicitly with a cron expression. E.g. the following expression triggers a GC run every night at 2 AM: <tt>0 0 2 * * ?</tt>.</dd>
-<dd>Since 1.7.11</dd>
-<dt>versionGCTimeLimitInSecs</dt>
-<dd>Default 10800</dd>
-<dd>A Revision GC run is canceled after this number of seconds. The default is three hours.</dd>
-<dd>Since 1.7.11</dd>
-<dt>journalGCMaxAge</dt>
-<dd>Default 86400000 (24 hrs, was 6 hrs until 1.7.4)</dd>
-<dd>Journal entries older than <tt>journalGCMaxAge</tt> can be removed by the journal garbage collector. The maximum age is specified in milliseconds.</dd>
-<dd>Since 1.0.19, 1.2.3, 1.4</dd>
-<dt>journalGCInterval</dt>
-<dd>Default 300000 (5 min)</dd>
-<dd>The interval in milliseconds with which the journal garbage collector removes old journal entries.</dd>
-<dd>Since 1.0.19, 1.2.3, 1.4</dd>
-<dt>blobCacheSize</dt>
-<dd>Default 16 (MB)</dd>
-<dd>DocumentNodeStore when running with Mongo would use <tt>MongoBlobStore</tt> by default unless a custom <tt>BlobStore</tt> is configured. In such scenario the size of in memory cache for the frequently used blobs can be configured via <tt>blobCacheSize</tt>.</dd>
-<dt>persistentCache</dt>
-<dd>Default “cache,binary=0” (prior to 1.6, the persistent cache was disabled by default)</dd>
-<dd>The <a href="./nodestore/persistent-cache.html">persistent cache</a>, which is stored in the local file system.</dd>
-<dt><a name="cache-allocation"></a></dt>
-<dt>nodeCachePercentage</dt>
-<dd>Default 35 (was 25 until 1.5.14)</dd>
-<dd>Percentage of <tt>cache</tt> allocated for <tt>nodeCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a></dd>
-<dt>prevDocCachePercentage</dt>
-<dd>Default 4</dd>
-<dd>Percentage of <tt>cache</tt> allocated for <tt>prevDocCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a></dd>
-<dd>Since 1.3.15</dd>
-<dt>childrenCachePercentage</dt>
-<dd>Default 15 (was 10 until 1.5.14)</dd>
-<dd>Percentage of <tt>cache</tt> allocated for <tt>childrenCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a></dd>
-<dt>diffCachePercentage</dt>
-<dd>Default 30 (was 5 until 1.5.14)</dd>
-<dd>Percentage of <tt>cache</tt> allocated for <tt>diffCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a></dd>
-<dt>docChildrenCachePercentage</dt>
-<dd>Default 3</dd>
-<dd>Percentage of <tt>cache</tt> allocated for <tt>docChildrenCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a></dd>
-<dd>Removed since 1.5.6</dd>
-<dt>cacheSegmentCount</dt>
-<dd>Default 16</dd>
-<dd>The number of segments in the LIRS cache</dd>
-<dd>Since 1.0.15, 1.2.3, 1.3.0</dd>
-<dt>cacheStackMoveDistance</dt>
-<dd>Default 16</dd>
-<dd>The delay to move entries to the head of the queue in the LIRS cache</dd>
-<dd>Since 1.0.15, 1.2.3, 1.3.0</dd>
-<dt>sharedDSRepoId (From Oak 1.2.11, valid for Oak 1.2.x)</dt>
-<dd>Default ""</dd>
-<dd>Custom SharedDataStore repositoryId. Used when custom blobstore configured. Should be unique among the repositories sharing the datastore.</dd>
-<dt>blobTrackSnapshotIntervalInSecs</dt>
-<dd>Default 43200 (12 hrs)</dd>
-<dd>The blob ids cached/tracked locally are synchronized with the DataStore at this interval. Any additions and deletions will be visible to other cluster nodes or repositories connected to the shared DatStore after this. This should be less than the blobGcMaxAgeInSecs parameter above and the frequency of blob gc. See <a href="./plugins/blobstore.html#blobid-tracker">Blob tracker</a>.</dd>
-</dl>
+<tr class="a">
+<th>Name </th>
+<th> Default </th>
+<th> Description </th>
+<th> Since</th></tr>
+</thead><tbody>
+
+<tr class="b">
+<td>mongouri </td>
+<td> <a class="externalLink" href="mongodb://localhost:27017">mongodb://localhost:27017</a> </td>
+<td> Specifies the <a class="externalLink" href="http://docs.mongodb.org/manual/reference/connection-string/">MongoURI</a> required to connect to Mongo Database </td>
+<td> 1.0</td></tr>
+<tr class="a">
+<td>db </td>
+<td> oak </td>
+<td> Name of the database in Mongo </td>
+<td> 1.0</td></tr>
+<tr class="b">
+<td>socketKeepAlive </td>
+<td> true (was ‘false’ before 1.10) </td>
+<td> Enables socket keep-alive for MongoDB connections </td>
+<td> 1.8.0, 1.6.2, 1.4.16</td></tr>
+<tr class="a">
+<td>cache </td>
+<td> 256 </td>
+<td> Cache size in MB. This is distributed among various caches used in DocumentNodeStore </td>
+<td> 1.0</td></tr>
+<tr class="b">
+<td>customBlobStore </td>
+<td> false </td>
+<td> Boolean value indicating that custom <tt>BlobStore</tt> to use. </td>
+<td> 1.0</td></tr>
+<tr class="a">
+<td>maxReplicationLagInSecs </td>
+<td> 21600 (6 hours) </td>
+<td> Determines the duration beyond which it can be safely assumed that state on secondary would be consistent with primary and its safe to read from them. (See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1645">OAK-1645</a>) </td>
+<td> 1.0.2</td></tr>
+<tr class="b">
+<td>blobGcMaxAgeInSecs </td>
+<td> 86400 (24 hrs) </td>
+<td> Blob Garbage Collector (GC) logic would only consider those blobs for GC which are not accessed recently (currentTime - lastModifiedTime > blobGcMaxAgeInSecs). For example as per default only those blobs which have been created 24 hrs ago would be considered for GC. It is strongly advised to not set this property to a very low value of say a few minutes but only set it to a hour at a minimum. This is to ensure that the NodeStore(s) have had the time to flush out its internal data structures to persistence and the references to recently added blobs are accounted. </td>
+<td> 1.0</td></tr>
+<tr class="a">
+<td>versionGcMaxAgeInSecs </td>
+<td> 86400 (24 hrs) </td>
+<td> Oak uses MVCC model to store the data. So each update to a node results in new version getting created. This duration controls how much old revision data should be kept. For example if a node is deleted at time T1 then its content would only be marked deleted at revision for T1 but its content would not be removed. Only when a Revision GC is run then its content would removed and that too only after (currentTime -T1 > versionGcMaxAgeInSecs) </td>
+<td> 1.0</td></tr>
+<tr class="b">
+<td>versionGCExpression </td>
+<td> "" </td>
+<td> A cron expression that defines when the Revision GC is scheduled. If this configuration entry is left empty, the default behaviour depends on the <tt>documentStoreType</tt>. For <tt>MONGO</tt> the default is to schedule a run every five seconds (also known as Continuous Revision Garbage Collection). For <tt>RDB</tt> the default is no scheduled GC. It must be enabled explicitly with a cron expression. E.g. the following expression triggers a GC run every night at 2 AM: <tt>0 0 2 * * ?</tt>. </td>
+<td> 1.7.11</td></tr>
+<tr class="a">
+<td>versionGCTimeLimitInSecs </td>
+<td> 10800 </td>
+<td> A Revision GC run is canceled after this number of seconds. The default is three hours. </td>
+<td> 1.7.11</td></tr>
+<tr class="b">
+<td>journalGCMaxAge </td>
+<td> 86400000 (24 hrs, was 6 hrs until 1.7.4) </td>
+<td> Journal entries older than <tt>journalGCMaxAge</tt> can be removed by the journal garbage collector. The maximum age is specified in milliseconds. </td>
+<td> 1.0.19, 1.2.3, 1.4</td></tr>
+<tr class="a">
+<td>journalGCInterval </td>
+<td> 300000 (5 min) </td>
+<td> The interval in milliseconds with which the journal garbage collector removes old journal entries. </td>
+<td> 1.0.19, 1.2.3, 1.4</td></tr>
+<tr class="b">
+<td>blobCacheSize </td>
+<td> 16 (MB) </td>
+<td> DocumentNodeStore when running with Mongo will use <tt>MongoBlobStore</tt> by default unless a custom <tt>BlobStore</tt> is configured. In such scenario the size of in memory cache for the frequently used blobs can be configured via <tt>blobCacheSize</tt>. </td>
+<td> 1.0</td></tr>
+<tr class="a">
+<td>persistentCache </td>
+<td> “cache,binary=0” (prior to 1.6, the persistent cache was disabled by default) </td>
+<td> The <a href="./nodestore/persistent-cache.html">persistent cache</a>, which is stored in the local file system. </td>
+<td> 1.0.8</td></tr>
+<tr class="b">
+<td><a name="cache-allocation"></a> nodeCachePercentage </td>
+<td> 35 (was 25 until 1.5.14) </td>
+<td> Percentage of <tt>cache</tt> allocated for <tt>nodeCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a> </td>
+<td> 1.0.12</td></tr>
+<tr class="a">
+<td>prevDocCachePercentage </td>
+<td> 4 </td>
+<td> Percentage of <tt>cache</tt> allocated for <tt>prevDocCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a> </td>
+<td> 1.3.15</td></tr>
+<tr class="b">
+<td>childrenCachePercentage </td>
+<td> 15 (was 10 until 1.5.14) </td>
+<td> Percentage of <tt>cache</tt> allocated for <tt>childrenCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a> </td>
+<td> 1.0.12</td></tr>
+<tr class="a">
+<td>diffCachePercentage </td>
+<td> 30 (was 5 until 1.5.14) </td>
+<td> Percentage of <tt>cache</tt> allocated for <tt>diffCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a> </td>
+<td> 1.0.12</td></tr>
+<tr class="b">
+<td>docChildrenCachePercentage </td>
+<td> 0 (was 3 until 1.5.6) </td>
+<td> Percentage of <tt>cache</tt> allocated for <tt>docChildrenCache</tt>. See <a href="./nodestore/documentmk.html#cache">Caching</a> (Removed since 1.5.6) </td>
+<td> 1.0.12</td></tr>
+<tr class="a">
+<td>cacheSegmentCount </td>
+<td> 16 </td>
+<td> The number of segments in the LIRS cache </td>
+<td> 1.0.15, 1.2.3, 1.3.0</td></tr>
+<tr class="b">
+<td>cacheStackMoveDistance </td>
+<td> 16 </td>
+<td> The delay to move entries to the head of the queue in the LIRS cache </td>
+<td> 1.0.15, 1.2.3, 1.3.0</td></tr>
+<tr class="a">
+<td>sharedDSRepoId </td>
+<td> "" </td>
+<td> Custom SharedDataStore repositoryId. Used when custom blobstore configured. Should be unique among the repositories sharing the datastore. </td>
+<td> 1.2.11</td></tr>
+<tr class="b">
+<td>blobTrackSnapshotIntervalInSecs </td>
+<td> 43200 (12 hrs) </td>
+<td> The blob ids cached/tracked locally are synchronized with the DataStore at this interval. Any additions and deletions will be visible to other cluster nodes or repositories connected to the shared DatStore after this. This should be less than the blobGcMaxAgeInSecs parameter above and the frequency of blob gc. See <a href="./plugins/blobstore.html#blobid-tracker">Blob tracker</a>. </td>
+<td> 1.5.6</td></tr>
+<tr class="a">
+<td>leaseCheckMode </td>
+<td> STRICT </td>
+<td> The lease check mode. <tt>STRICT</tt> is the default and will stop the DocumentNodeStore as soon as the lease expires. <tt>LENIENT</tt> will give the background lease update a chance to renew the lease even when the lease expired. This mode is only recommended for development, e.g. when debugging an application and the lease may expire when the JVM is stopped at a breakpoint. </td>
+<td> 1.9.6</td></tr>
+</tbody>
+</table>
<p>Example config file</p>
<div>
@@ -512,6 +561,25 @@ db=oak
<p><i>PID <tt>org.apache.jackrabbit.oak.plugins.blob.datastore.S3DataStore</tt></i></p>
<dl>
+<dt>accessKey</dt>
+<dd>AWS access key to be used for accessing the S3 bucket. Not required if IAM roles configured.</dd>
+<dt>secretKey</dt>
+<dd>AWS secret key to be used for accessing the S3 bucket. Not required if IAM roles configured.</dd>
+<dt>s3Bucket/container</dt>
+<dd>Default - <tt>us-standard</tt></dd>
+<dd>S3 Bucket name to be used for storing the binaries/blobs.</dd>
+<dt>s3Region</dt>
+<dd>Region where the S3 bucket is located or to be created if not present.</dd>
+<dt>s3EndPoint</dt>
+<dd>S3 rest API endpoint. Can help reduce latency of redirection from standard endpoint if a different region configured.</dd>
+<dt>connectionTimeout</dt>
+<dd>S3 connection timeout. See <a class="externalLink" href="https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/section-client-configuration.html">AWS S3 documentation</a>.</dd>
+<dt>socketTimeout</dt>
+<dd>S3 socket timeout. See <a class="externalLink" href="https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/section-client-configuration.html">AWS S3 documentation</a>.</dd>
+<dt>maxConnections</dt>
+<dd>Maximum connections to S3. See <a class="externalLink" href="https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/section-client-configuration.html">AWS S3 documentation</a>.</dd>
+<dt>maxErrorRetry</dt>
+<dd>Max error retries. See <a class="externalLink" href="https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/section-client-configuration.html">AWS S3 documentation</a>.</dd>
<dt>maxCachedBinarySize</dt>
<dd>Default - 17408 (17 KB)</dd>
<dd>Size in bytes. Binaries with size less than or equal to this size would be stored in in memory cache</dd>
@@ -520,7 +588,7 @@ db=oak
<dd>Size in MB. In memory cache for storing small files whose size is less than <tt>maxCachedBinarySize</tt>. This helps in better performance when lots of small binaries are accessed frequently.</dd>
</dl></div>
<div class="section">
-<h4><a name="Oak_-_SharedS3DataStore_Since_Oak_1.2.0"></a>Oak - SharedS3DataStore (Since Oak 1.2.0)</h4>
+<h4><a name="Oak_-_SharedS3DataStore_Oak_1.2.x__Oak_1.4.x"></a>Oak - SharedS3DataStore (Oak 1.2.x & Oak 1.4.x)</h4>
<p>Supports shared S3 DataStore</p>
<p><i>PID <tt>org.apache.jackrabbit.oak.plugins.blob.datastore.SharedS3DataStore</tt></i></p>
<dl>
@@ -544,6 +612,8 @@ db=oak
</ul>
<dl>
+<dt>path</dt>
+<dd>The local file system path used to cache binaries and stage binaries for asynchronous uploads.</dd>
<dt>cacheSize</dt>
<dd>Default - 68719476736</dd>
<dd>Size in bytes of DataStore cache. Cache is disabled when cacheSize <= 0.</dd>
Modified: jackrabbit/site/live/oak/docs/participating.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/participating.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/participating.html (original)
+++ jackrabbit/site/live/oak/docs/participating.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Participating</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
Modified: jackrabbit/site/live/oak/docs/plugins/blobstore.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/plugins/blobstore.html?rev=1837837&r1=1837836&r2=1837837&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/plugins/blobstore.html (original)
+++ jackrabbit/site/live/oak/docs/plugins/blobstore.html Fri Aug 10 21:42:33 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20180709" />
+ <meta name="Date-Revision-yyyymmdd" content="20180810" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – The Blob Store</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,6 +52,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -136,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -155,6 +156,7 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
<li class="nav-header">Main APIs</li>
<li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
@@ -612,7 +614,12 @@ public class GetGCStats {
</ul>
</li>
<li>Remove other files corresponding to the particular repositoryId e.g. <tt>markedTimestamp-[repositoryId]</tt> or <tt>references-[repositoryId]</tt>.</li>
-</ul>
+</ul></div>
+<div class="section">
+<h5><a name="Reset_Repository_ID"></a>Reset Repository ID</h5>
+<p>If any of the repositories sharing a DataStore is cloned then it would have the same <tt>repositoryId</tt> registered in the datastore as the repository from which cloned and running a shared DSGC would lead to data loss/missing blobs. So, care must be taken to reset the <tt>repositoryId</tt>.</p>
+<p><a class="externalLink" href="http://mvnrepository.com/artifact/org.apache.jackrabbit/oak-run/">oak-run</a> cli utility has a <tt>resetclusterid</tt> command to reset the repository id. The command can be executed as below and more details can be found at the <a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/oak-run/README.md">readme</a> for oak-run:</p>
+<p><tt>java -jar oak-run.jar resetclusterid < repository path | Mongo URI ></tt></p>
<p><a name="consistency-check"></a></p></div></div>
<div class="section">
<h4><a name="Consistency_Check"></a>Consistency Check</h4>