You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by th...@apache.org on 2018/08/21 10:31:38 UTC
svn commit: r1838538 [3/35] - in /jackrabbit/site/live/oak/docs: ./
architecture/ coldstandby/ features/ nodestore/ nodestore/document/
nodestore/segment/ oak-mongo-js/ oak-mongo-js/fonts/ oak-mongo-js/scripts/
oak-mongo-js/scripts/prettify/ oak-mongo-...
Modified: jackrabbit/site/live/oak/docs/index.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/index.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/index.html (original)
+++ jackrabbit/site/live/oak/docs/index.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Jackrabbit Oak - the next generation content repository</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -157,14 +156,12 @@
<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>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,8 +240,7 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- -->
-<h1>Jackrabbit Oak - the next generation content repository</h1>
+ --><h1>Jackrabbit Oak - the next generation content repository</h1>
<p>Jackrabbit Oak is an effort to implement a scalable and performant hierarchical content repository for use as the foundation of modern world-class web sites and other demanding content applications. The Oak effort is a part of the <a class="externalLink" href="http://jackrabbit.apache.org/">Apache Jackrabbit project</a>. Apache Jackrabbit is a project of the <a class="externalLink" href="http://www.apache.org/">Apache Software Foundation</a>.</p>
<div class="section">
<h2><a name="Why_Oak"></a>Why Oak</h2>
Modified: jackrabbit/site/live/oak/docs/jsop-diff.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/jsop-diff.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/jsop-diff.html (original)
+++ jackrabbit/site/live/oak/docs/jsop-diff.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<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>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -242,35 +239,28 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
--->
-<p><i>Note:</i> Below algorithms turns out to be not sufficient. The edit script for the following case is incomplete. Given S constructed from an empty tree</p>
+--><p><i>Note:</i> Below algorithms turns out to be not sufficient. The edit script for the following case is incomplete. Given S constructed from an empty tree</p>
-<div>
-<div>
-<pre class="source">S = +/s:{} +/t:{}
+<div class="source">
+<div class="source"><pre class="prettyprint">S = +/s:{} +/t:{}
</pre></div></div>
-
<p>obtain T from S by</p>
-<div>
-<div>
-<pre class="source">T = S +/s/a:{} >/s:/t/s
+<div class="source">
+<div class="source"><pre class="prettyprint">T = S +/s/a:{} >/s:/t/s
</pre></div></div>
-
<p>Running below algorithm on S and T will result in an edit script which, when applied to S, will not create child node a. I.e. it will result in</p>
-<div>
-<div>
-<pre class="source">S >/s:/t/s
+<div class="source">
+<div class="source"><pre class="prettyprint">S >/s:/t/s
</pre></div></div>
<hr />
<p>An algorithm for creating edit scripts (in JSOP format) from two trees. See <a class="externalLink" href="https://github.com/mduerig/json-diff">this GitHub repository</a> for a proof of concept implementation and <a class="externalLink" href="http://markmail.org/message/lbc3rx2p3sssvqj5">the related discussion on oak-dev@</a></p>
-<div>
-<div>
-<pre class="source">// Global variable holding the JSOP journal after the diffTree below returns.
+<div class="source">
+<div class="source"><pre class="prettyprint">// Global variable holding the JSOP journal after the diffTree below returns.
jsop = ""
-
+
/*
Create a JSOP journal, which when applied to tree S will transform
it to tree T.
Modified: jackrabbit/site/live/oak/docs/known_issues.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/known_issues.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/known_issues.html (original)
+++ jackrabbit/site/live/oak/docs/known_issues.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Known issues</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<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>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,36 +240,36 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- -->
-<h1>Known issues</h1>
-<p>All known issues are listed in the Apache <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK">JIRA</a>. Changes with respect to Jackrabbit-core are collected in [OAK-14] (<a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-14">https://issues.apache.org/jira/browse/OAK-14</a>) and its sub-tasks.</p>
-<ul>
+ --><h1>Known issues</h1>
+<p>All known issues are listed in the Apache <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK">JIRA</a>. Changes with respect to Jackrabbit-core are collected in <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-14">OAK-14</a> and its sub-tasks.</p>
+<ul>
+
<li>
-
<p>Workspace Operations:</p>
+
<ul>
-
-<li>Cross workspace operations are not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-118">OAK-118</a></li>
-<li>Workspace Management (creating/deleting workspaces) is not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-118">OAK-118</a></li>
-</ul>
-</li>
+
+<li>Cross workspace operations are not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-118">OAK-118</a></li>
+
+<li>Workspace Management (creating/deleting workspaces) is not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-118">OAK-118</a></li>
+ </ul></li>
+
<li>
-
<p>Observation queues handling</p>
+
<ul>
-
-<li>With an excessively large commit rate, the observation queues can fill up and if not prevented and the queue hits a certain threshold and/or the limit then it would result in Local events reported as external event <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-2683">OAK-2683</a>​</li>
-</ul>
-</li>
+
+<li>With an excessively large commit rate, the observation queues can fill up and if not prevented and the queue hits a certain threshold and/or the limit then it would result in Local events reported as external event <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-2683">OAK-2683</a>​</li>
+ </ul></li>
+
<li>
-
<p>Changing an observation listener’s filter:</p>
+
<ul>
-
-<li>Prefiltering of observation queues means that if an observation listener’s filter is changed, that new filter will only fully be applied to newly added changes to the observation queues. Those changes that potentially were still in the queue will have gone through both the old prefilter and the new (post-)filter. <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-5208">OAK-5208</a></li>
-</ul>
-</li>
+
+<li>Prefiltering of observation queues means that if an observation listener’s filter is changed, that new filter will only fully be applied to newly added changes to the observation queues. Those changes that potentially were still in the queue will have gone through both the old prefilter and the new (post-)filter. <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-5208">OAK-5208</a></li>
+ </ul></li>
</ul>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/license.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/license.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/license.html (original)
+++ jackrabbit/site/live/oak/docs/license.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – License</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -157,14 +156,12 @@
<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>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,8 +240,7 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- -->
-<h1>License</h1>
+ --><h1>License</h1>
<p>Jackrabbit Oak and any of its parts are licensed according to the terms listed in the <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2.0</a>.</p>
<p>For further information regarding licensing of Apache Software refer to The Apache Software Foundation <a class="externalLink" href="http://www.apache.org/licenses/">licensing information</a>.</p>
</div>
Modified: jackrabbit/site/live/oak/docs/migration.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/migration.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/migration.html (original)
+++ jackrabbit/site/live/oak/docs/migration.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Repository migration</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<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>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,47 +240,52 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- -->
-<h1>Repository migration</h1>
+ --><h1>Repository migration</h1>
<p>Oak offers a few tools which can be used to migrate the old, Jackrabbit 2 repository and also to copy content between Oak instances. <tt>oak-upgrade</tt> is a Swiss army knife for copying content between virtually any repositories. On the other hand, the <tt>SplitBlobStore</tt> allows to copy the binaries gradually, from one blob store to another, without having a long repository downtime.</p>
<div class="section">
<h2><a name="Offline_migration_using_oak-upgrade"></a>Offline migration using oak-upgrade</h2>
<p><img src="img/migration-general.png" alt="oak-upgrade chart" /></p>
<p>The <tt>oak-upgrade</tt> module allows to do an upgrade from the classic Jackrabbit 2.0 repository to the Oak node store and also to sidegrade from one nodestore type to another. Besides from that it has a number of features that can be useful in everyday system maintenance:</p>
-<ul>
+<ul>
+
<li>copying only a selcted subtree from one repository to another,</li>
+
<li>precise control over version histories migration,</li>
+
<li>migrating binaries from one blobstore to another.</li>
</ul>
<div class="section">
<h3><a name="Sidegrade"></a>Sidegrade</h3>
<p><tt>oak-upgrade</tt> module creates an executable jar file. It can be invoked like this:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar [options] source destination
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar [options] source destination
</pre></div></div>
-
<p>The <tt>source</tt> and <tt>destination</tt> are the node store paths/URIs. Following node stores are supported:</p>
-<ul>
+<ul>
+
<li><tt>SegmentNodeStore</tt> - use a path to the <tt>repository</tt> directory,</li>
+
<li>old <tt>SegmentNodeStore</tt> (Oak < 1.6) - use the <tt>segment-old:</tt> prefix and the path to the <tt>repository</tt> directory,</li>
+
<li><tt>DocumentNodeStore</tt> with MongoDB - <tt>mongodb://host:port/database</tt>,</li>
+
<li><tt>DocumentNodeStore</tt> with a RDB - <tt>jdbc:...</tt>. It requires passing user and password with separate parameters.</li>
</ul>
<p>Following parameters should be used for the JDBC node store:</p>
-<ul>
+<ul>
+
<li>Source database: <tt>--src-password=... --src-user=...</tt></li>
+
<li>Desination database: <tt>--user=... --password=...</tt></li>
</ul>
<p>Examples:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
path/to/the/repository \
mongodb://localhost:27017/oak
@@ -291,15 +293,13 @@ java -jar oak-upgrade-*.jar \
--user=sa --password=sa \
mongodb://localhost:27017/oak \
jdbc:h2:path/to/repo
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h3><a name="Upgrade"></a>Upgrade</h3>
<p>In order to upgrade Jackrabbit 2 repository to the new node store, pass the path to the <tt>repository</tt> directory as the <tt>source</tt> parameter. Optionally, you may also pass the path to the <tt>repository.xml</tt> file as a separate parameter. Examples:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
path/to/the/jr2/repository \
path/to/repository.xml \
path/to/the/new/repository
@@ -307,93 +307,144 @@ java -jar oak-upgrade-*.jar \
java -jar oak-upgrade-*.jar \
path/to/the/jr2/repository \
mongodb://localhost:27017/oak
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h3><a name="Migrating_blob_store"></a>Migrating blob store</h3>
<p>By default, the <tt>oak-upgrade</tt> only copies the binary references, so you need to reuse the same blob/data store in the new repository. However, it’s also possible to migrate binaries as well using the <tt>--copy-binaries</tt> parameter. Following migration paths are possible for the binaries. The <i>internal</i> means that the binaries are stored inside the segment or document node store:</p>
-<table border="0" class="table table-striped">
-<thead>
+<table border="0" class="table table-striped">
+ <thead>
+
<tr class="a">
-<th align="center"> From ↓ To → </th>
-<th align="center"> Internal </th>
-<th align="center"> FileBlobStore </th>
-<th align="center"> FileDataStore </th>
-<th align="center"> S3 </th></tr>
-</thead><tbody>
-
+
+<th align="center">From ↓ To → </th>
+
+<th align="center">Internal </th>
+
+<th align="center">FileBlobStore </th>
+
+<th align="center">FileDataStore </th>
+
+<th align="center">S3 </th>
+ </tr>
+ </thead>
+ <tbody>
+
<tr class="b">
-<td align="center"> Internal </td>
-<td align="center"> Yes² </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td></tr>
+
+<td align="center">Internal </td>
+
+<td align="center">Yes² </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+ </tr>
+
<tr class="a">
-<td align="center"> FileBlobStore </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes² </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td></tr>
+
+<td align="center">FileBlobStore </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes² </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+ </tr>
+
<tr class="b">
-<td align="center"> FileDataStore </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes² </td>
-<td align="center"> Yes (not recommended)¹ </td></tr>
+
+<td align="center">FileDataStore </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes² </td>
+
+<td align="center">Yes (not recommended)¹ </td>
+ </tr>
+
<tr class="a">
-<td align="center"> S3 </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes² </td></tr>
-</tbody>
+
+<td align="center">S3 </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes² </td>
+ </tr>
+ </tbody>
</table>
<p>¹ The S3DataStore will take care of this migration automatically, no need to use oak-upgrade <br /> ² The storage might be simple cloned without using oak2oak</p>
<p>Following parameters can be used to define the source and the destination blob stores:</p>
-<table border="0" class="table table-striped">
-<thead>
+<table border="0" class="table table-striped">
+ <thead>
+
<tr class="a">
-<th align="center"> Blob store type </th>
-<th align="center"> Source parameter </th>
-<th align="center"> Destination </th></tr>
-</thead><tbody>
-
+
+<th align="center">Blob store type </th>
+
+<th align="center">Source parameter </th>
+
+<th align="center">Destination </th>
+ </tr>
+ </thead>
+ <tbody>
+
<tr class="b">
-<td align="center"> FileBlobStore </td>
-<td align="center"> <tt>--src-fileblobstore=...</tt> </td>
-<td align="center"> <tt>--fileblobstore=...</tt> </td></tr>
+
+<td align="center">FileBlobStore </td>
+
+<td align="center"><tt>--src-fileblobstore=...</tt> </td>
+
+<td align="center"><tt>--fileblobstore=...</tt> </td>
+ </tr>
+
<tr class="a">
-<td align="center"> FileDataStore </td>
-<td align="center"> <tt>--src-datastore=...</tt> </td>
-<td align="center"> <tt>--datastore=...</tt> </td></tr>
+
+<td align="center">FileDataStore </td>
+
+<td align="center"><tt>--src-datastore=...</tt> </td>
+
+<td align="center"><tt>--datastore=...</tt> </td>
+ </tr>
+
<tr class="b">
-<td align="center"> S3 </td>
-<td align="center"> <tt>--src-s3config=... --src-s3datastore=...</tt> </td>
-<td align="center"> <tt>--s3config=... --s3datastore=...</tt> </td></tr>
-</tbody>
+
+<td align="center">S3 </td>
+
+<td align="center"><tt>--src-s3config=... --src-s3datastore=...</tt> </td>
+
+<td align="center"><tt>--s3config=... --s3datastore=...</tt> </td>
+ </tr>
+ </tbody>
</table>
<p>Use the <tt>--copy-binaries</tt> parameter to instruct the <tt>oak-upgrade</tt> to copy binaries.</p>
<p>Example:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
--copy-binaries \
--src-datastore=/old/repository/datastore \
--fileblobstore=/new/repository/datastore \
/old/repository \
/new/repository
</pre></div></div>
-
<div class="section">
<h4><a name="S3_configuration"></a>S3 configuration</h4>
<p>Using S3DataStore as a source or destination for binaries requires passing two arguments: <tt>s3datastore</tt> and <tt>s3config</tt>. The first one should point to the datastore directory (eg. <tt>crx-quickstart/repository/datastore</tt>). The second should be used to define the <tt>org.apache.jackrabbit.oak.plugins.blob.datastore.S3DataStore.cfg</tt> configuration file path. File should have following format:</p>
-<div>
-<div>
-<pre class="source">accessKey=...
+<div class="source">
+<div class="source"><pre class="prettyprint">accessKey=...
secretKey=...
s3Bucket=...
s3Region=eu-west-1
@@ -405,43 +456,36 @@ maxConnections=40
writeThreads=30
maxErrorRetry=10
</pre></div></div>
-
<p>For the region and endpoints please visit the <a class="externalLink" href="http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Amazon documentation</a>.</p>
-<p>Alternativly the <tt>*.config</tt> file format, described on the <a class="externalLink" href="https://sling.apache.org/documentation/bundles/configuration-installer-factory.html#configuration-files">Apache Sling website</a>, can be used as it may be convenient for re-using existing OSGi configuration files.</p></div></div>
+<p>Alternativly the <tt>*.config</tt> file format, described on the <a class="externalLink" href="https://sling.apache.org/documentation/bundles/configuration-installer-factory.html#configuration-files">Apache Sling website</a>, can be used as it may be convenient for re-using existing OSGi configuration files. </p></div></div>
<div class="section">
<h3><a name="Migrating_a_subtree"></a>Migrating a subtree</h3>
-<p><img src="img/migration-paths.png" alt="include-paths chart" /></p>
+<p><img src="img/migration-paths.png" alt="–include-paths chart" /></p>
<p>It’s possible to define a list of content subtrees to include or exclude during the migration. By default, the whole repository gets copied. In order to copy only a subtree, use the <tt>--include-paths</tt>. For example, the following command will copy only the <tt>/content/site</tt> and <tt>/content/other_site</tt> subtrees:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
--include-paths=/content/site,/content/other_site \
/old/repository \
/new/repository
</pre></div></div>
-
<p>You may also exclude specific paths from being copied. Following command will copy the whole content without the <tt>/content/redundant_site</tt>:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
--exclude-paths=/content/redundant_site \
/old/repository \
/new/repository
</pre></div></div>
-
<p>By default, the source repository replaces the destination repository (if there’s one). For instance, in the first example if the <tt>/content/site</tt> node already exists in the destination repository, it’ll be removed and replaced by the source node. It’s also possible to merge content from the source repository with <tt>--merge-paths</tt>:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
--include-paths=/content/site \
--merge-paths=/content/site \
/old/repository \
/new/repository
</pre></div></div>
-
<p>Please notice that in the last example it’s necessary to narrow the migration scope using <tt>--include-paths</tt> parameter.</p></div>
<div class="section">
<h3><a name="Version_history_copying"></a>Version history copying</h3>
@@ -449,9 +493,8 @@ maxErrorRetry=10
<p>By default, the whole version storage is migrated. This includes referenced version histories (their versionable node still exists in the repository) and orphaned ones (their versionable node no longer exists). <tt>oak-upgrade</tt> allows to skip the orphaned version histories to make the migration faster and the destination repository smaller. It’s also possible to define a maximum age for the version histories (both referenced and orphaned) to be copied.</p>
<p>There are two parameters: <tt>--copy-orphaned-versions</tt> and <tt>--copy-versions</tt>. Both accepts boolean values or a <tt>YYYY-MM-DD</tt> date. Examples:</p>
-<div>
-<div>
-<pre class="source"># only copy referenced versions
+<div class="source">
+<div class="source"><pre class="prettyprint"># only copy referenced versions
java -jar oak-upgrade-*.jar \
--copy-orphaned-versions=false \
/old/repository /new/repository
@@ -467,15 +510,17 @@ java -jar oak-upgrade-*.jar \
--copy-versions=2010-01-01 \
--copy-orphaned-versions=2011-01-01 \
/old/repository /new/repository
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h3><a name="Incremental_migration"></a>Incremental migration</h3>
<p>If an existing repository is passed as the destination, then only a diff between source and destination will be migrated. It allows to migrate the content in a few iterations. For instance, following case is possible:</p>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>migrate a large repository a week before go-live</li>
+
<li>run the migration again every night (only the recent changes are copied)</li>
+
<li>run the migration one final time before go-live</li>
</ol></div>
<div class="section">
@@ -486,18 +531,14 @@ java -jar oak-upgrade-*.jar \
<p>It’s possible to inject custom logic into the upgrade process, by implementing <a class="externalLink" href="https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/lifecycle/RepositoryInitializer.html"><tt>RepositoryInitializer</tt></a> or <a class="externalLink" href="https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/commit/CommitHook.html"><tt>CommitHook</tt></a>.</p>
<p>In order to do that, create a new Maven project, with appropriate implementation. Then create following file:</p>
-<div>
-<div>
-<pre class="source">src/main/resources/META-INF/services/org.apache.jackrabbit.oak.spi.commit.CommitHook
+<div class="source">
+<div class="source"><pre class="prettyprint">src/main/resources/META-INF/services/org.apache.jackrabbit.oak.spi.commit.CommitHook
</pre></div></div>
-
<p>The file should contain just one line - the name of the class with the <tt>CoomitHook</tt> implementation. Build the project and attach the JAR to the oak-upgrade class path:</p>
-<div>
-<div>
-<pre class="source">java -cp my-commit-hook.jar:oak-upgrade-*.jar org.apache.jackrabbit.oak.upgrade.cli.OakUpgrade [normal oak-upgrade parameters]
+<div class="source">
+<div class="source"><pre class="prettyprint">java -cp my-commit-hook.jar:oak-upgrade-*.jar org.apache.jackrabbit.oak.upgrade.cli.OakUpgrade [normal oak-upgrade parameters]
</pre></div></div>
-
<p>A custom <tt>RepositoryInitializer</tt> can be injected in a similar way.</p></div>
<div class="section">
<h3><a name="Other_parameters"></a>Other parameters</h3>
@@ -505,20 +546,20 @@ java -jar oak-upgrade-*.jar \
<div class="section">
<h3><a name="Checkpoints_migration"></a>Checkpoints migration</h3>
<p>When migrating an old SegmentMK repository (pre-Oak 1.6) to the new SegmentMK (Oak >= 1.6), the checkpoints are migrated as well. This allows to avoid reindexing when the Oak is being run for the first time on the new repository. However, the checkpoints won’t be migrated in following cases:</p>
-<ul>
+<ul>
+
<li>custom include-, exclude- or merge- paths are specified or</li>
+
<li>the binaries are copied by references, no source datastore is specified and two different checkpoints contains different binary under the same path.</li>
</ul>
<p>In the second case oak-upgrade emits following warning and breaks:</p>
-<div>
-<div>
-<pre class="source">Checkpoints won't be copied, because no external datastore has been specified. This will result in the full repository reindexing on the first start. Use --skip-checkpoints to force the migration or see https://jackrabbit.apache.org/oak/docs/migration.html#Checkpoints_migration for more info.
+<div class="source">
+<div class="source"><pre class="prettyprint">Checkpoints won't be copied, because no external datastore has been specified. This will result in the full repository reindexing on the first start. Use --skip-checkpoints to force the migration or see https://jackrabbit.apache.org/oak/docs/migration.html#Checkpoints_migration for more info.
</pre></div></div>
-
<p>The easiest way to fix this issue is specifying the source datastore in the command line options (eg. <tt>--src-datastore</tt> or <tt>--src-s3datastore</tt>).</p>
-<p>The warning may also be ignored, but in this case the repository will be fully reindexed on the first startup. It may be a long process, especially for the big instance. Repository won’t be usable until the reindexing process is done. Use <tt>--skip-checkpoints</tt> option to suppress the warning.</p></div></div>
+<p>The warning may also be ignored, but in this case the repository will be fully reindexed on the first startup. It may be a long process, especially for the big instance. Repository won’t be usable until the reindexing process is done. Use <tt>--skip-checkpoints</tt> option to suppress the warning. </p></div></div>
<div class="section">
<h2><a name="Online_blob_migration_with_SplitBlobStore"></a>Online blob migration with SplitBlobStore</h2>
<p>Oak offers one more way to migrate blob store, without turning off the instance (a few restarts might be required, but the migration process is done during normal repository operation).</p>
@@ -527,54 +568,60 @@ java -jar oak-upgrade-*.jar \
<div class="section">
<div class="section">
<h4><a name="Requirements"></a>Requirements</h4>
-<ul>
+<ul>
+
<li>An OSGi-based Oak installation (eg. Sling or AEM).</li>
</ul></div>
<div class="section">
<h4><a name="Enabling_SplitBlobStore_-_external_blob_store_case"></a>Enabling SplitBlobStore - external blob store case</h4>
<p>These steps should be followed for migration from <tt>FileBlobStore</tt>, <tt>FileDataStore</tt> or <tt>S3DataStore</tt>.</p>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>Add <tt>split.blobstore=old</tt> OSGi property to the source blob store.</li>
+
<li>Configure the destination blob store and add <tt>split.blobstore=new</tt> property to its OSGi configuration.</li>
-<li>Create a configuration for the <tt>org.apache.jackrabbit.oak.spi.blob.osgi.SplitBlobStoreService</tt>.
-
-<div>
-<div>
-<pre class="source">split.old.blobstore.type=INTERNAL
+
+<li>
+<p>Create a configuration for the <tt>org.apache.jackrabbit.oak.spi.blob.osgi.SplitBlobStoreService</tt>.</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">split.old.blobstore.type=INTERNAL
# optional:
repository.home=crx-quickstart/repository
</pre></div></div>
-
+
<ul>
-
+
<li>The directory is used to save the <tt>migrated_blobs.txt</tt> file.</li>
-</ul>
-</li>
+ </ul></li>
+
<li>Restart the instance</li>
</ol></div>
<div class="section">
<h4><a name="Enabling_SplitBlobStore_-_internal_blob_store_case"></a>Enabling SplitBlobStore - internal blob store case</h4>
<p>These steps should be followed for migration from <tt>MongoBlobStore</tt> or for blobs embedded in the <tt>SegmentNodeStore</tt>.</p>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>Configure the destination blob store and add <tt>split.blobstore=new</tt> property to its OSGi configuration.</li>
-<li>Create a configuration for the <tt>org.apache.jackrabbit.oak.spi.blob.osgi.SplitBlobStoreService</tt>.
-
-<div>
-<div>
-<pre class="source"># use DOCUMENT or SEGMENT, depending on the NodeStore type:
+
+<li>
+<p>Create a configuration for the <tt>org.apache.jackrabbit.oak.spi.blob.osgi.SplitBlobStoreService</tt>.</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint"># use DOCUMENT or SEGMENT, depending on the NodeStore type:
split.old.blobstore.type=SEGMENT
# optional:
repository.home=crx-quickstart/repository
</pre></div></div>
-
+
<ul>
-
+
<li>The directory is used to save the migrated_blobs.txt file.</li>
-</ul>
-</li>
+ </ul></li>
+
<li>Restart the instance</li>
</ol>
<p>After starting the instance, the <tt>SplitBlobStoreService</tt> will wait until blob stores with <tt>split.blobstore</tt> properties (the <tt>old</tt> and the <tt>new</tt>) are available. They will be bound and the <tt>SplitBlobStore</tt> will be registered in the OSGi. On the other hand, the <tt>NodeStoreService</tt> will ignore blob stores configured with the <tt>split.blobstore</tt> property and will wait until the <tt>SplitBlobStore</tt> is available.</p>
@@ -582,25 +629,33 @@ repository.home=crx-quickstart/repositor
<p>The <tt>split.blobstore</tt> property support was added to <tt>FileBlobStore</tt>, <tt>AbstractDataStoreService</tt> (handling all Jackrabbit data stores), <tt>DocumentNodeStoreService</tt> and <tt>SegmentNodeStoreService</tt>.</p></div>
<div class="section">
<h4><a name="Migration"></a>Migration</h4>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>Find <tt>BlobMigration</tt> JMX bean in the Felix console.</li>
+
<li>Run <tt>startBlobMigration(false)</tt> operation</li>
</ol>
<p>The migration can be stopped using <tt>stopBlobMigration()</tt> and then resumed with <tt>startBlobMigration(true)</tt>. The current stats are available via the JMX as well:</p>
-<ul>
+<ul>
+
<li>last processed path,</li>
+
<li>number of migrated nodes.</li>
</ul></div>
<div class="section">
<h4><a name="Switching_to_the_new_blob_store"></a>Switching to the new blob store</h4>
<p>When the migration is finished, it’s possible to completely switch to the new blob store:</p>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>Remove the configuration for the old blob store.</li>
+
<li>Remove the configuration for the <tt>SplitBlobStoreService</tt></li>
+
<li>Remove the <tt>split.blobstore=new</tt> OSGi property from the new blob store, so it can be find by the <tt>NodeStoreService</tt>.</li>
+
<li>Restart the instance, so there are no JCR sessions bound to the old NodeState.</li>
</ol>
<p>Migration is now complete!</p></div></div></div>
Modified: jackrabbit/site/live/oak/docs/nodestore/compositens.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/compositens.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/compositens.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/compositens.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Oak Composite NodeStore</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<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>
<ul class="nav nav-list">
<li><a href="../nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="../nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="../nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="../nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="../nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,8 +240,7 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- -->
-<h1>Oak Composite NodeStore</h1>
+ --><h1>Oak Composite NodeStore</h1>
<p><b>The documentation of the Composite NodeStore implementation is work-in-progress. Please ask on oak-dev for things that are missing or unclear.</b></p>
<div class="section">
<h2><a name="Overview"></a>Overview</h2>
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=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/metrics.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/metrics.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-17
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180817" />
<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,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-17<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,7 +155,6 @@
<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/mongo-document-store.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html?rev=1838538&r1=1838537&r2=1838538&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 Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-21
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180821" />
<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" />
@@ -137,7 +137,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -272,7 +272,7 @@
<td> 3.2.x</td></tr>
<tr class="b">
<td>1.8.x </td>
-<td> 3.4.x</td></tr>
+<td> 3.6.x</td></tr>
</tbody>
</table>
<p>For production deployments use a replica-set with at least three mongod instances and a majority write concern. Fewer than three instances (e.g. two instances and an arbiter) may lead to data loss when the primary fails.</p>
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=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/node-bundling.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/node-bundling.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-17
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180817" />
<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,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-17<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,7 +155,6 @@
<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=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/secondary-store.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/secondary-store.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<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,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<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>
<ul class="nav nav-list">
<li><a href="../../nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="../../nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="../../nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li class="active"><a href="#"><span class="none"></span>Secondary Store</a>
</li>
@@ -243,71 +240,89 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- -->
-<h1>Secondary NodeStore</h1>
-<ul>
+ --><h1>Secondary NodeStore</h1>
+<ul>
+
<li><a href="#secondary-node-store">Secondary NodeStore</a></li>
+
<li><a href="#read-flow">Read Flow</a></li>
+
<li><a href="#write-flow">Write Flow</a>
+
<ul>
-
+
<li><a href="#write-flow-local-changes">Local Changes</a></li>
+
<li><a href="#write-flow-external-changes">External Changes</a></li>
+
<li><a href="#write-flow-startup-sync">Startup Sync</a></li>
-</ul>
-</li>
+ </ul></li>
+
<li><a href="#usage">Setup </a></li>
+
<li><a href="#setup-considerations">Setup Considerations</a></li>
+
<li><a href="#administration">Administration</a>
+
<ul>
-
+
<li><a href="#secondary-store-maintenance">Maintenance</a></li>
+
<li><a href="#secondary-store-cluster">New Cluster Member</a></li>
-</ul>
-</li>
+ </ul></li>
</ul>
<p><tt>@since Oak 1.6</tt> <tt>Experimental Feature</tt></p>
-<p>Compared to SegmentNodeStore DocumentNodeStore has higher latency for reads for the data not present in the cache. This happens due to multiple round trips required to serve a hierarchical read access over remote storage. For e.g. reading content of path <i>/content/assets/nature/sunrise.jpg</i> would require around 4 remote calls if the path content is not present in local cache. <a href="../persistent-cache.html">Persistent Cache</a> helped in improving this by enabling caching lot more content off heap compared to limited inmemory cache.</p>
+<p>Compared to SegmentNodeStore DocumentNodeStore has higher latency for reads for the data not present in the cache. This happens due to multiple round trips required to serve a hierarchical read access over remote storage. For e.g. reading content of path <i>/content/assets/nature/sunrise.jpg</i> would require around 4 remote calls if the path content is not present in local cache. <a href="../persistent-cache.html">Persistent Cache</a> helped in improving this by enabling caching lot more content off heap compared to limited inmemory cache. </p>
<p>With new <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1312">Secondary NodeStore</a> support its now possible to configure a SegmentNodeStore as a secondary store to store content under certain set of paths locally. SegmentNodeStore act a local copy of remote repository (secondary store) more like a local git repo which gets updated from primary store (remote Mongo storage) via observation. Writes are still routed to primary store but reads can be served from local secondary store.</p>
<p><img src="secondary-store.png" alt="Secondary Store Setup" /></p>
<p>In above setup 2 Oak Cluser nodes connect to same Mongo server. In each Oak instance a SegmentNodeStore is configured as secondary store. This store gets updated by observer.</p>
<p><b>Experimental Feature</b></p>
<p>This feature is currently experimental. Following feature item is currently pending</p>
-<ul>
+<ul>
+
<li><a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-5352">OAK-5352</a> - Support for maintenance task for secondary NodeStore</li>
</ul>
<div class="section">
<h2><a name="Read_Flow"></a><a name="read-flow"></a> Read Flow</h2>
<p>Reading /a/b at revision r1 would happen like below</p>
-<p><img src="secondary-store-read.png" alt="Secondary Store Read Flow" /></p>
+<p><img src="secondary-store-read.png" alt="Secondary Store Read Flow" /> </p>
<p>Key points here</p>
-<ul>
+<ul>
+
<li>Secondary NodeStore can be configured to only stored content under certain paths</li>
+
<li>Read would be first attempted from any configured secondary NodeStore.
+
<ol style="list-style-type: decimal">
-
-<li>Secondary NodeStore would check if it stores content for that path. Note that it can be configured with path inclusions</li>
+
+<li>Secondary NodeStore would check if it stores content for that path. Note that it can be configured with path inclusions</li>
+
<li>It then checks whether its root revision is later than revision at which read is being requested</li>
+
<li>If NodeState at given path and revision is found then its returned</li>
-</ol>
-</li>
-<li>If read is not possible from secondary NodeStore then read is done from in memory which may in turn read from remote Mongo in case of cache miss</li>
-<li>If read is successful from Secondary NodeStore which is based on SegmentNodeStore then further child read from that path would be directly handled by SegmentNodeStore by passing DocumentNodeStore altogether. So if /a/b@r1 is found in secondary then read for /a/b/c@r1 would be directly handled by secondary store</li>
+ </ol></li>
+
+<li>If read is not possible from secondary NodeStore then read is done from in memory which may in turn read from remote Mongo in case of cache miss</li>
+
+<li>If read is successful from Secondary NodeStore which is based on SegmentNodeStore then further child read from that path would be directly handled by SegmentNodeStore by passing DocumentNodeStore altogether. So if /a/b@r1 is found in secondary then read for /a/b/c@r1 would be directly handled by secondary store</li>
</ul>
<p>Note that even if root revision of secondary store is lagging behind current head its possible that read for /a/b can be handled by secondary store if /a has not been modified recently. So those parts of repo which have not been recently modified would most likely be served from Secondary NodeStore and avoid remote calls to Mongo.</p></div>
<div class="section">
<h2><a name="Write_Flow"></a><a name="write-flow"></a> Write Flow</h2>
<p>Updates to secondary store happen in 3 ways</p>
-<p><img src="secondary-store-write.png" alt="Secondary Store Write Flow" /></p>
+<p><img src="secondary-store-write.png" alt="Secondary Store Write Flow" /> </p>
<p>Key points here</p>
-<ul>
+<ul>
+
<li>Writes done by NodeStore caller i.e. JCR layer are always done on primary store i.e. Mongo</li>
+
<li>Secondary NodeStore is updated via Oak Observation support and NodeState diff</li>
-<li>Secondary NodeStore can be configured with path filter and then it would only be interested in changes for configured paths</li>
+
+<li>Secondary NodeStore can be configured with path filter and then it would only be interested in changes for configured paths</li>
</ul>
<div class="section">
<h3><a name="Local_Changes"></a><a name="write-flow-local-changes"></a> Local Changes</h3>
@@ -326,34 +341,34 @@
<p><b>1. Configure SegmentNodeStore in secondary role</b></p>
<p>Create an OSGi config file <tt>org.apache.jackrabbit.oak.segment.SegmentNodeStoreFactory-secondary.config</tt> with following content</p>
-<div>
-<div>
-<pre class="source">role="secondary"
+<div class="source">
+<div class="source"><pre class="prettyprint">role="secondary"
</pre></div></div>
-
<p>This would create a SegmentNodeStore in secondary role and uses default <tt>segmentstore-secondary</tt> directory to store the segment files. Refer to <a href="../../osgi_config.html#config-SegmentNodeStoreService">config options</a> for more details. Note all the options for <tt>SegmentNodeStoreService</tt> are applicable for <tt>SegmentNodeStoreFactory</tt></p>
<p><b>2. Configure SecondaryStoreCacheService (optional)</b></p>
<p>By default secondary NodeStore would be activated based on previous config only. However it can be tweaked further by creating an OSGi config file <tt>org.apache.jackrabbit.oak.plugins.document.secondary.SecondaryStoreCacheService.config</tt></p>
-<div>
-<div>
-<pre class="source">includedPaths=[ \
+<div class="source">
+<div class="source"><pre class="prettyprint">includedPaths=[ \
"/libs", \
"/apps", \
"/content"
]
</pre></div></div>
-
<p>Above config would enable secondary NodeStore for paths ‘/libs, /apps and /content’</p></div>
<div class="section">
<h2><a name="Setup_Considerations"></a><a name="setup-considerations"></a> Setup Considerations</h2>
<p>While enabling secondary NodeStore feature following aspects needs to be considered</p>
-<ul>
-<li>SegmentNodeStore used as secondary NodeStore would compete with system resource like memory along with in memory caches of DocumentNodeStore and Lucene index files. So system must have sufficient memory to for all these 3 components</li>
+<ul>
+
+<li>SegmentNodeStore used as secondary NodeStore would compete with system resource like memory along with in memory caches of DocumentNodeStore and Lucene index files. So system must have sufficient memory to for all these 3 components</li>
+
<li>SegmentNodeStore can be copied from any existing cluster node to a new node.</li>
-<li>If this is being enabled for existing setup then initial sync would take some time. So take that into account while planning to enable this feature</li>
-<li>For best performance include those paths of the repository which are accessed by end user. Specially those content paths where read to write ratio is high.</li>
+
+<li>If this is being enabled for existing setup then initial sync would take some time. So take that into account while planning to enable this feature</li>
+
+<li>For best performance include those paths of the repository which are accessed by end user. Specially those content paths where read to write ratio is high.</li>
</ul></div>
<div class="section">
<h2><a name="Administration"></a><a name="administration"></a> Administration</h2>
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=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/upgrade.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/upgrade.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<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,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<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>
<ul class="nav nav-list">
<li><a href="../../nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="../../nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="../../nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="../../nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="../../nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -242,72 +239,76 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
- -->
-<h1>DocumentNodeStore upgrade instructions</h1>
+ --><h1>DocumentNodeStore upgrade instructions</h1>
<p>In general Oak aims to provide a smooth upgrade path that allows a new version of Oak to simply run on data written by an older version of Oak. In some cases additional manual steps are needed or recommended to ensure performance and reduce downtime of a system to a minimum.</p>
<div class="section">
<h2><a name="Upgrade_to_1.8"></a><a name="a1.8"></a>Upgrade to 1.8</h2>
<p>Oak 1.8 introduced some changes in the DocumentNodeStore that require an one-time sweep of the DocumentStore per cluster node. This sweep is triggered automatically on startup when Oak detects an upgrade from an older version. Depending on the size of the repository, the sweep operation may take some time and prolong the downtime of the system during an upgrade. Alternatively, the one-time sweep operation can also be triggered for an inactive cluster node with the oak-run tool while the remaining cluster nodes are active and in use by the application. This is the recommended approach because it minimizes downtime.</p>
<div class="section">
<h3><a name="Prerequisites"></a>Prerequisites</h3>
-<ul>
+<ul>
+
<li>Create a backup of the system</li>
+
<li>The new Oak version and/or application that bundles or uses Oak</li>
+
<li>The oak-run tool in the same version as used by the updated application</li>
+
<li>A successful test run of below steps on a clone of the production system before they are applied to production.</li>
</ul></div>
<div class="section">
<h3><a name="Instructions"></a>Instructions</h3>
<p>The following instructions assume a cluster with two nodes C1 and C2 running on Oak 1.6 or older.</p>
-<ul>
-
-<li>Remove documents potentially created by <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-4345">OAK-4345</a>. The issue only affected deployments based on MongoDB. Connect to the database with a MongoDB shell and then execute:
-<div>
-<div>
-<pre class="source">> db.nodes.remove({_id:{$type:7}})
-</pre></div></div>
-</li>
+<ul>
+
+<li>
+<p>Remove documents potentially created by <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-4345">OAK-4345</a>. The issue only affected deployments based on MongoDB. Connect to the database with a MongoDB shell and then execute:</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">> db.nodes.remove({_id:{$type:7}})
+</pre></div></div></li>
+
<li>Stop cluster node C1. If possible, the cluster node should be shut down gracefully because the next step can only be executed when C1 is considered inactive. A recovery of C1 is otherwise necessary if it is forcefully killed. This happens automatically when there are other active nodes in the cluster, but is only initiated after the lease of C1 timed out. The DocumentNodeStore MBean of an active cluster node can be inspected to find out whether some other cluster node is considered inactive (see InactiveClusterNodes attribute).</li>
-<li>Run the revisions sweep command using the oak-run tool for C1. A sweep can only run on an inactive cluster node, otherwise the command will refuse to run. Assuming C1 used clusterId 1, the command line would look like this:
-
-<div>
-<div>
-<pre class="source">> java -Xmx2g -jar oak-run-1.8.0.jar revisions mongodb://localhost:27017/oak sweep --clusterId 1
+
+<li>
+<p>Run the revisions sweep command using the oak-run tool for C1. A sweep can only run on an inactive cluster node, otherwise the command will refuse to run. Assuming C1 used clusterId 1, the command line would look like this:</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">> java -Xmx2g -jar oak-run-1.8.0.jar revisions mongodb://localhost:27017/oak sweep --clusterId 1
</pre></div></div>
-
<p>For larger repositories it is recommended to be more generous with the cache size, which will speed up the sweep operation: <tt>--cacheSize 1024</tt> More detailed progress is available when <tt>--verbose</tt> is added.</p>
<p>Once finished the tool will print a summary:</p>
-
-<div>
-<div>
-<pre class="source">Updated sweep revision to r15d12cb1836-0-1. Branch commit markers added to 8907 documents. Reverted uncommitted changes on 19 documents. (7.94 min)
-</pre></div></div>
-</li>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">Updated sweep revision to r15d12cb1836-0-1. Branch commit markers added to 8907 documents. Reverted uncommitted changes on 19 documents. (7.94 min)
+</pre></div></div></li>
+
<li>
-
-<p>C1 is now ready for an upgrade to Oak 1.8.</p>
-</li>
+<p>C1 is now ready for an upgrade to Oak 1.8. </p></li>
+
<li>Stop cluster node C2. This is when downtime of the system starts.</li>
+
<li>Unlock the repository for an upgrade to Oak 1.8. This step is only possible when <i>all</i> nodes of a cluster are inactive. See also <a href="../documentmk.html">unlock upgrade</a> section. At this point the previous Oak version cannot use the DocumentStore anymore. A restore from the backup will be necessary should any of the following steps fail for some reason and the upgrade needs to be rolled back.</li>
+
<li>Start cluster node C1 with the new version of Oak and the application.</li>
-<li>Run the revisions sweep command using the oak-run tool for C2 (assuming it used clusterId 2):
-
-<div>
-<div>
-<pre class="source"> > java -Xmx2g -jar oak-run-1.8.0.jar revisions mongodb://localhost:27017/oak sweep --clusterId 2
-</pre></div></div>
-</li>
+
<li>
-
-<p>Start cluster node C2 with the new version of Oak and the application.</p>
-</li>
-<li>Create recommended indexes in MongoDB and remove old ones. For a more efficient Revision GC, the existing indexes on <tt>_deletedOnce</tt> and <tt>_sdType</tt> should be replaced. Please note, the partial index on <tt>_deletedOnce</tt> and <tt>_modified</tt> requires at least MongoDB 3.2.
-
-<div>
-<div>
-<pre class="source">> db.nodes.createIndex({_sdType:1, _sdMaxRevTime:1}, {sparse:true})
+<p>Run the revisions sweep command using the oak-run tool for C2 (assuming it used clusterId 2):</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint"> > java -Xmx2g -jar oak-run-1.8.0.jar revisions mongodb://localhost:27017/oak sweep --clusterId 2
+</pre></div></div></li>
+
+<li>
+<p>Start cluster node C2 with the new version of Oak and the application.</p></li>
+
+<li>
+<p>Create recommended indexes in MongoDB and remove old ones. For a more efficient Revision GC, the existing indexes on <tt>_deletedOnce</tt> and <tt>_sdType</tt> should be replaced. Please note, the partial index on <tt>_deletedOnce</tt> and <tt>_modified</tt> requires at least MongoDB 3.2.</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">> db.nodes.createIndex({_sdType:1, _sdMaxRevTime:1}, {sparse:true})
{
"createdCollectionAutomatically" : false,
"numIndexesBefore" : 5,
@@ -326,7 +327,6 @@
> db.nodes.dropIndex("_deletedOnce_1")
{ "nIndexesWas" : 6, "ok" : 1 }
</pre></div></div>
-
<p>See also instructions how to <a class="externalLink" href="https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/#index-building-replica-sets">build indexes on a replica set</a> to minimize impact on the system.</p></li>
</ul></div></div>
</div>
Modified: jackrabbit/site/live/oak/docs/nodestore/documentmk.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/documentmk.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/documentmk.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/documentmk.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-17
| 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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180817" />
<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,7 +52,6 @@
<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>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-17<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,7 +155,6 @@
<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>