Author: tolusha Date: 2011-04-13 08:55:17 -0400 (Wed, 13 Apr 2011) New Revision: 4233 Added: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/use-external-backup-tool.xml jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/resources/images/repository-suspend-controller-online.png jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/resources/images/repository-suspend-controller-suspended.png jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/resources/images/repository-suspend-controller.png Removed: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/search-index-backup.xml Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr.xml Log: EXOJCR-1301: [DOC] Allow to use external backup tools in a secure manner Deleted: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/search-index-backup.xml =================================================================== --- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/search-index-backup.xml 2011-04-13 11:19:32 UTC (rev 4232) +++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/search-index-backup.xml 2011-04-13 12:55:17 UTC (rev 4233) @@ -1,84 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" -"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> -<chapter id="JCR.SearchIndexBackup"> - <?dbhtml filename="ch-search-index-backup.html"?> - - <title>Searching index backup</title> - - <section> - <title>Manual backup (file copy)</title> - - <para>It can be useful for some reasons. The backup may be performed - manually or using third part software.</para> - - <para>You can make a copy of the search index ($AS_HOME/temp/jcrlucenedb) - and use it to replace the current index by this copy in case of an index - damaged or lost.</para> - - <para>All repository changes that are applied between the index backup and - the point of time when the backup index is restored, are not in the index - and those modifications will not be found when searching. The - modifications exist in the repository, but do not exist in the search - index. <emphasis role="bold">And those changes will not be automatically - reindexed.</emphasis></para> - - <para>For example: You have configured the workspace index to be in the - "/index/workspace" directory.<itemizedlist> - <listitem> - <para>Make a backup of the search index - copy the content of the - "/index" directory;</para> - </listitem> - - <listitem> - <para>Add the node "/anynode" to the workspace. Now this node exists - in the workspace database and the search index has information about - this node, so you can find it using query <code>select * from - nt:base where jcr:path="/anynode"</code>;</para> - </listitem> - - <listitem> - <para>Rollback to the last backup - replace current - "/index/workspace" directory by the backup;</para> - </listitem> - - <listitem> - <para>Node "/anynode" still exists and is accessible in the - workspace (Session.getItem("/anynode")), but you can't find it via - the search query<code> select * from nt:base where - jcr:path="/anynode"</code>;</para> - </listitem> - </itemizedlist></para> - - <para>If you want to find changes made after updating, you have to reindex - the whole workspace content. The way to do this is to stop the repository - container and delete the "/index/workspace" folder. The workspace database - content will be reindexed on repository startup.</para> - </section> - - <section> - <title>Consistency Requirements</title> - - <para>To have the workspace content consistent with the search index, the - workspace database and the index directory should correspond to the same - state. In case of an external (manual) backup <emphasis>the database - backup and the index directory backup should be performed on a - stopped/unmodifiable repository</emphasis>.</para> - - <para><emphasis role="bold">Only in that case the repository content and - the search index will be consistent.</emphasis></para> - </section> - - <section> - <title>JCR Backup Service</title> - - <para>To get a hot-backup, which is executed on the fly, it's possible to - use the <link linkend="JCR.BackupService">Backup service</link> which is - available as a JCR Extension.</para> - - <note> - <para>Backup service supports full and incremental backup types. A - Scheduler is available.</para> - </note> - </section> -</chapter> Added: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/use-external-backup-tool.xml =================================================================== --- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/use-external-backup-tool.xml (rev 0) +++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr/backup/use-external-backup-tool.xml 2011-04-13 12:55:17 UTC (rev 4233) @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<chapter id="JCR.SearchIndexBackup"> + <?dbhtml filename="ch-search-index-backup.html"?> + + <title>Use external backup tool</title> + + <section> + <title>Repository suspending</title> + + <para>To have the repository content consistent with the search index and + value storate, the repository should be suspened. It means all working + threads are suspended until resume operation performed. Index will be + flushed.</para> + + <para>JCR provides ability to suspend repository via JMX.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/repository-suspend-controller.png" /> + </imageobject> + </mediaobject> + + <para>To suspend repository just need to invoke suspend() operation. The + returned result will be "suspended" if everything passed + successfully.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/repository-suspend-controller-suspended.png" /> + </imageobject> + </mediaobject> + </section> + + <section> + <title>Backup</title> + + <para>Now we can backup content manually or using third part software. We + need to backup:</para> + + <itemizedlist> + <listitem> + <para>Database</para> + </listitem> + + <listitem> + <para>Lucene index</para> + </listitem> + + <listitem> + <para>Value storage (if configured)</para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Repository resuming</title> + + <para>Once backup is done need to invoke resume() operation to resume + repository. The returned result will be "online" </para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/repository-suspend-controller-online.png" /> + </imageobject> + </mediaobject> + </section> +</chapter> Modified: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr.xml =================================================================== --- jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr.xml 2011-04-13 11:19:32 UTC (rev 4232) +++ jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/docbook/en-US/modules/jcr.xml 2011-04-13 12:55:17 UTC (rev 4233) @@ -121,7 +121,7 @@ <xi:include href="jcr/backup/backup-client.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="jcr/backup/search-index-backup.xml" + <xi:include href="jcr/backup/use-external-backup-tool.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <!-- other --> Added: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/resources/images/repository-suspend-controller-online.png =================================================================== (Binary files differ) Property changes on: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/resources/images/repository-suspend-controller-online.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/resources/images/repository-suspend-controller-suspended.png =================================================================== (Binary files differ) Property changes on: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/resources/images/repository-suspend-controller-suspended.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/resources/images/repository-suspend-controller.png =================================================================== (Binary files differ) Property changes on: jcr/trunk/exo.jcr.docs/exo.jcr.docs.developer/en/src/main/resources/images/repository-suspend-controller.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream