Skip to main content
Jump to: navigation, search

Difference between revisions of "Orion/Metadata migration"

(Notes: Warn about orphan file removal)
Line 1: Line 1:
 
=== Orion 3.0 (CompatibilityMetaStore) ===
 
=== Orion 3.0 (CompatibilityMetaStore) ===
  
The legacy server metadata is organized as follows:
+
The legacy server metadata was organized as follows:
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
 
|-{{BMTHStyle}}
 
|-{{BMTHStyle}}
Line 20: Line 20:
 
|-  
 
|-  
 
| /serverworkspace/A  
 
| /serverworkspace/A  
| folder root of "Project" with project id "A"
+
| folder root of "Sentiment.Analysis.App" with project id "A"
 
|-  
 
|-  
 
| /serverworkspace/B  
 
| /serverworkspace/B  
Line 36: Line 36:
  
 
==== Notes ====
 
==== Notes ====
If you wish to use this legacy Orion 3.0 storage format, you should specify in your <code>orion.conf</code>:
+
[1] Orion 6.0 and later cannot run with this legacy format. You must migrate to the latest version as per below.
 +
 
 +
[2] If running the configuration web-ide from within Eclipse, it uses -data ${workspace_loc}/../foo . In this case you can backup any project files you want and remove the foo directory.
 +
 
 +
[3] If you wish to use this legacy Orion 3.0 storage format in Orion 4.0 or Orion 5.0, you should specify in your <code>orion.conf</code>:
 
<source lang="properties">
 
<source lang="properties">
 
orion.core.metastore=legacy
 
orion.core.metastore=legacy
 
</source>
 
</source>
 +
 
=== Orion 4.0 (SimpleMetaStore) ===
 
=== Orion 4.0 (SimpleMetaStore) ===
  
Line 57: Line 62:
 
| Server metadata workspace file, includes project list
 
| Server metadata workspace file, includes project list
 
|-
 
|-
| /serverworkspace/an/anthony/OrionContent/Project.json
+
| /serverworkspace/an/anthony/OrionContent/Sentiment.Analysis.App.json
 
| Server metadata project file, includes content location
 
| Server metadata project file, includes content location
 
|-
 
|-
| /serverworkspace/an/anthony/OrionContent/Project/
+
| /serverworkspace/an/anthony/OrionContent/Sentiment.Analysis.App/
| folder root of project "Project"
+
| folder root of project "Sentiment.Analysis.App"
|-
+
| /serverworkspace/an/anthony/OrionContent/Project Two.json
+
| Server metadata project file, includes content location
+
|-
+
| /serverworkspace/an/anthony/OrionContent/Project Two/
+
| folder root of project "Project Two"
+
 
|-
 
|-
 
| /serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search
 
| /serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search
Line 103: Line 102:
 
|-
 
|-
 
| /serverworkspace/metastore.json
 
| /serverworkspace/metastore.json
| Root of the orion filesystem.
+
| Root of the orion filesystem (no change).
 
|-
 
|-
 
| /serverworkspace/an/anthony/user.json
 
| /serverworkspace/an/anthony/user.json
| Server metadata user file, includes preferences, user rights and list of workspaces
+
| Server metadata user file, includes preferences, user rights and list of workspaces (no change). Unique Id for the user is anthony.
|-
+
| /serverworkspace/an/anthony/workspace.json
+
| Server metadata workspace file, includes project list (file location has changed in V2)
+
|-
+
| /serverworkspace/an/anthony/Project.json
+
| Server metadata project file, includes content location (file location has changed in V2)
+
 
|-
 
|-
| /serverworkspace/an/anthony/OrionContent/Project/
+
| /serverworkspace/an/anthony/anthony-OrionContent.json
| folder root of project "Project"
+
| Server metadata workspace file, includes project list (file location and name has changed in V2). Unique Id for the workspace is anthony-OrionContent.
 
|-
 
|-
| /serverworkspace/an/anthony/Project Two.json
+
| /serverworkspace/an/anthony/Sentiment.Analysis.App.json
| Server metadata project file, includes content location (file location has changed in V2)
+
| Server metadata project file, includes content location (file location has changed in V2). Unique Id for the project is Sentiment.Analysis.App.
 
|-
 
|-
| /serverworkspace/an/anthony/OrionContent/Project Two/
+
| /serverworkspace/an/anthony/OrionContent/Sentiment.Analysis.App/
| folder root of project "Project Two"
+
| folder root of project "Sentiment.Analysis.App" (no change)
 
|-
 
|-
 
| /serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search
 
| /serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search

Revision as of 14:12, 28 May 2014

Orion 3.0 (CompatibilityMetaStore)

The legacy server metadata was organized as follows:

File / Folder Description
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core/.settings/Projects.prefs Project list
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core/.settings/SiteConfigurations.prefs Site List
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core/.settings/Users.prefs User List, includes preferences, user rights and list of workspaces
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core/.settings/Workspaces.prefs Workspace list
/serverworkspace/A folder root of "Sentiment.Analysis.App" with project id "A"
/serverworkspace/B folder root of "Project Two" with project id "B"
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.user.securestorage Equinox Secure Storage for Users and Passwords
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search Orion Search
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core/tasks Orion Tasks

Notes

[1] Orion 6.0 and later cannot run with this legacy format. You must migrate to the latest version as per below.

[2] If running the configuration web-ide from within Eclipse, it uses -data ${workspace_loc}/../foo . In this case you can backup any project files you want and remove the foo directory.

[3] If you wish to use this legacy Orion 3.0 storage format in Orion 4.0 or Orion 5.0, you should specify in your orion.conf:

orion.core.metastore=legacy

Orion 4.0 (SimpleMetaStore)

The simple server metadata is organized as follows:

File / Folder Description
/serverworkspace/metastore.json Root of the orion filesystem.
/serverworkspace/an/anthony/user.json Server metadata user file, includes preferences, user rights and list of workspaces
/serverworkspace/an/anthony/OrionContent/workspace.json Server metadata workspace file, includes project list
/serverworkspace/an/anthony/OrionContent/Sentiment.Analysis.App.json Server metadata project file, includes content location
/serverworkspace/an/anthony/OrionContent/Sentiment.Analysis.App/ folder root of project "Sentiment.Analysis.App"
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search Orion Search (no change)
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core/tasks Orion Tasks (no change)

Notes

[1] The default layout will now be orion.file.layout=userTree, so user folders are organized in a hierarchy. In this case anthony is under /an/anthony on the server.

[2] In Orion 0.2 is was possible to create an account with a login of one or two characters. These accounts should be renamed on Windows to be at least three characters long to prevent migration problems.

Orion 4.0 Migration

The server administrator should perform the following steps to migrate the server from the legacy 3.0 format to the simple format:

  • Backup the server workspace. The migration renames project folders, so if there is any issue with the migration, the server may need to be restored to its original contents.
  • Delete the old index folder /serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search. Since the projects are moved, they will be reindexed.
  • Add the properties to the orion.conf configuration file for your server:
orion.core.metastore=simple
orion.file.layout=userTree
  • Start the orion server.
  • Review the migration log in /serverworkspace/.metadata/migration.log to ensure there are no ERROR messages.

Orion 6.0 (SimpleMetaStoreV2)

The second version of the simple server metadata is organized as follows:

File / Folder Description
/serverworkspace/metastore.json Root of the orion filesystem (no change).
/serverworkspace/an/anthony/user.json Server metadata user file, includes preferences, user rights and list of workspaces (no change). Unique Id for the user is anthony.
/serverworkspace/an/anthony/anthony-OrionContent.json Server metadata workspace file, includes project list (file location and name has changed in V2). Unique Id for the workspace is anthony-OrionContent.
/serverworkspace/an/anthony/Sentiment.Analysis.App.json Server metadata project file, includes content location (file location has changed in V2). Unique Id for the project is Sentiment.Analysis.App.
/serverworkspace/an/anthony/OrionContent/Sentiment.Analysis.App/ folder root of project "Sentiment.Analysis.App" (no change)
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search Orion Search (no change)
/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core/tasks Orion Tasks (no change)

Notes

[1] The workspace root folder /serverworkspace/an/anthony/OrionContent is no longer a "protected" location and can hold arbitrary files.

[2] Unexpected ("orphan") files found in /serverworkspace/an/anthony and /serverworkspace/an/anthony/OrionContent by the migration will be reported with an INFO message and deleted!

Orion 6.0 Migration

The server administrator should perform the following steps to migrate the server from the simple 4.0 format to the simple 6.0 format:

  • Backup the server workspace. The migration moves internal metadata files, so if there is any issue with the migration, the server may need to be restored to its original contents.
  • Add the properties to the orion.conf configuration file for your server:
orion.core.metastore=simple2
  • Start the orion server.
  • Review the migration log in /serverworkspace/.metadata/migration2.log to ensure there are no ERROR messages.

Back to the top