You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by an...@apache.org on 2014/05/20 15:01:11 UTC
svn commit: r1596231 - in /jackrabbit/oak/trunk/oak-doc/src/site: ./
markdown/ markdown/architecture/ markdown/nodestore/ markdown/oak_api/
Author: angela
Date: Tue May 20 13:01:10 2014
New Revision: 1596231
URL: http://svn.apache.org/r1596231
Log:
OAK-301 : oak docu
Added:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/
jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/nodestate-r1.png
- copied unchanged from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate-r1.png
jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/nodestate-r1.uxf
- copied unchanged from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate-r1.uxf
jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/nodestate-r2.png
- copied unchanged from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate-r2.png
jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/nodestate-r2.uxf
- copied unchanged from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate-r2.uxf
jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/nodestate.md
- copied unchanged from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/overview.md
- copied, changed from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/transactional-model.md
- copied, changed from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/transactional-model.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/documentmk.md
- copied unchanged from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/documentmk.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/overview.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segmentmk.md
- copied unchanged from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/segmentmk.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/
jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md
Removed:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/documentmk.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/microkernel.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate-r1.png
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate-r1.uxf
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate-r2.png
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate-r2.uxf
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestate.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/segmentmk.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/transactional-model.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md
jackrabbit/oak/trunk/oak-doc/src/site/site.xml
Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/overview.md (from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/overview.md?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/overview.md&p1=jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md&r1=1596221&r2=1596231&rev=1596231&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/overview.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/overview.md Tue May 20 13:01:10 2014
@@ -15,11 +15,23 @@
limitations under the License.
-->
-# The big picture
+Oak - The big picture
+--------------------------------------------------------------------------------
+
+TODO: Explain concepts: MVCC, Oak modules and plugins, key APIs, ...
-TODO: Explain concepts: MVCC, Oak modules and plugins, key APIs, ...
+## Main Concepts
+
+* [Node State Model](nodestate.html)
+* [Transactional Model](transactional-model.html)
+
+## The APIs
+
+* [JCR](http://www.day.com/specs/jcr/2.0/index.html)
+* [Oak API](../oak_api/overview.html)
+* [NodeStore API](../nodestore/overview.html)
## Readmes
Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/transactional-model.md (from r1596221, jackrabbit/oak/trunk/oak-doc/src/site/markdown/transactional-model.md)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/transactional-model.md?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/transactional-model.md&p1=jackrabbit/oak/trunk/oak-doc/src/site/markdown/transactional-model.md&r1=1596221&r2=1596231&rev=1596231&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/transactional-model.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/architecture/transactional-model.md Tue May 20 13:01:10 2014
@@ -25,7 +25,7 @@ when it contains operations which are in
saved successfully. This is different from the standard first committer wins strategy where failure
would occur on conflicting operations rather than on incompatible operations. Incompatible is weaker
than conflict since two write operation on the same item do conflict but are not incompatible. The
-details of what incompatible means are specified by `MicroKernel.rebase()`.
+details of what incompatible means are specified by `NodeStore.rebase()` and `MicroKernel.rebase()`.
Snapshot isolation exhibits [write skew](http://http//research.microsoft.com/apps/pubs/default.aspx?id=69541)
which can be problematic for some application level consistency requirements. Consider the following
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md?rev=1596231&r1=1596230&r2=1596231&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/differences.md Tue May 20 13:01:10 2014
@@ -45,7 +45,7 @@ In Jackrabbit 2 sessions always reflects
reflects a stable view of the repository from the time the session was acquired ([MVCC model]
(http://en.wikipedia.org/wiki/MVCC)). This is a fundamental design aspect for achieving the
distributed nature of an Oak repository. A rarely encountered side effect of this is that sessions
-expose [write skew](transactional-model.html).
+expose [write skew](architecture/transactional-model.html).
This change can cause subtle differences in behavior when two sessions perform modifications
relying on one session seeing the other session's changes. Oak requires explicit calls to
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md?rev=1596231&r1=1596230&r2=1596231&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/index.md Tue May 20 13:01:10 2014
@@ -51,4 +51,4 @@ somewhat spread over different places. I
* the [Oak development list](http://jackrabbit.markmail.org/search/+list:org.apache.jackrabbit.oak-dev),
* the [README files](https://github.com/apache/jackrabbit-oak/blob/trunk/README.md),
* the [Oak presentation](http://goo.gl/zid8V3)
- from last year's .adaptTo conference.
\ No newline at end of file
+ from the .adaptTo conference 2012.
\ No newline at end of file
Added: jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/overview.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/overview.md?rev=1596231&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/overview.md (added)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/overview.md Tue May 20 13:01:10 2014
@@ -0,0 +1,32 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ 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.
+ -->
+
+# NodeStore API and MicroKernel API
+
+A `MicroKernel` or a `NodeStore` are ultimately implementations of the
+[node state model](../architecture/nodestate.html). A `MicroKernel` exposes its functionality through a String only
+(JSON) API, which is easy to remote. In contrast a `NodeStore` exposes its functionality
+through a pure Java API, which is easier to work with and has lower performance and memory overhead.
+
+Oak comes with two flavours: [Segment](segmentmk.html) and [Document](documentmk.html). The former
+is optimised for maximal performance in standalone deployments while the latter is optimised for
+maximal scalability in clustered deployments.
+
+## See also
+
+* [MicroKernel integration tests](https://github.com/apache/jackrabbit-oak/blob/trunk/oak-it/mk/README.md)
+* [MicroKernel performance tests](https://github.com/apache/jackrabbit-oak/blob/trunk/oak-mk-perf/README.md)
\ No newline at end of file
Added: jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md?rev=1596231&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md (added)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/oak_api/overview.md Tue May 20 13:01:10 2014
@@ -0,0 +1,21 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ 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.
+ -->
+
+Oak API
+--------------------------------------------------------------------------------
+
+_todo_
\ No newline at end of file
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md?rev=1596231&r1=1596230&r2=1596231&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/osgi_config.md Tue May 20 13:01:10 2014
@@ -91,7 +91,7 @@ All the configuration related to Mongo c
mongodb://sysop:moon@localhost
* **Read Preferences and Write Concern** - These also can be spcified as part of Mongo URI. Refer to
- [Read Preference and Write Concern](documentmk.html#rw-preference) section for more details. For
+ [Read Preference and Write Concern](nodestore/documentmk.html#rw-preference) section for more details. For
e.g. following would set _readPreference_ to _secondary_ and prefer replica with tag _dc:ny,rack:1_.
It would also specify the write timeout to 10 sec
Modified: jackrabbit/oak/trunk/oak-doc/src/site/site.xml
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/site.xml?rev=1596231&r1=1596230&r2=1596231&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/site.xml (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/site.xml Tue May 20 13:01:10 2014
@@ -29,13 +29,19 @@ under the License.
<item href="license.html" name="License" />
<item href="downloads.html" name="Downloads" />
</menu>
- <menu name="Concepts and architecture">
- <item href="overview.html" name="Overview" />
- <item href="nodestate.html" name="The node state model" />
- <item href="microkernel.html" name="NodeStore and MicroKernel" />
+ <menu name="Concepts and Architecture">
+ <item href="architecture/overview.html" name="Overview" />
+ <item href="architecture/nodestate.html" name="The node state model" />
+ </menu>
+ <menu name="Main APIs">
+ <item href="http://www.day.com/specs/jcr/2.0/index.html" name="JCR API" />
+ <item href="oak_api/overview.html" name="Oak API" />
+ <item href="nodestore/overview.html" name="NodeStore and MicroKernel API" />
+ </menu>
+ <menu name="Features and Plugins">
<item href="query.html" name="Query" />
- <item href="blobstore.html" name="BlobStore" />
<item href="security/overview.html" name="Security" />
+ <item href="blobstore.html" name="BlobStore" />
<item href="clustering.html" name="Clustering" />
</menu>
<menu name="Using Oak">