Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Orion/Metadata migration"

(Notes)
Line 84: Line 84:
 
The server administrator should perform the following steps to migrate the server from the legacy 3.0 format to the simple format:
 
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. The migration renames project folders, so if there is some issue with the migration, the server may need to be restored to its original contents.
+
* Backup the server. 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 <code>/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search</code>. Since the projects are moved, they will be reindexed.
 
* Delete the old index folder <code>/serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search</code>. Since the projects are moved, they will be reindexed.
 
* Add the properties to the <code>orion.conf</code> configuration file for your server:
 
* Add the properties to the <code>orion.conf</code> configuration file for your server:
Line 93: Line 93:
 
* Start the orion server.
 
* Start the orion server.
 
* Review the migration log in <code>/serverworkspace/.metadata/migration.log</code> to ensure there are no <code>ERROR</code> messages.
 
* Review the migration log in <code>/serverworkspace/.metadata/migration.log</code> to ensure there are no <code>ERROR</code> messages.
 +
 +
=== Orion 6.0 (SimpleMetaStoreV2) ===
 +
 +
The second version of the simple server metadata is organized as follows:
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
! 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/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/
 +
| folder root of project "Project"
 +
|-
 +
| /serverworkspace/an/anthony/Project Two.json
 +
| Server metadata project file, includes content location (file location has changed in V2)
 +
|-
 +
| /serverworkspace/an/anthony/OrionContent/Project Two/
 +
| folder root of project "Project Two"
 +
|-
 +
| /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.
 +
 +
=== 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. 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 <code>orion.conf</code> configuration file for your server:
 +
<source lang="properties">
 +
orion.core.metastore=simpleV2
 +
</source>
 +
* Start the orion server.
 +
* Review the migration log in <code>/serverworkspace/.metadata/migrationV2.log</code> to ensure there are no <code>ERROR</code> messages.
 +
  
  
 
[[Category:Orion]]
 
[[Category:Orion]]

Revision as of 11:54, 22 April 2014

Orion 3.0 (CompatibilityMetaStore)

The legacy server metadata is 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 "Project" 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

If you wish to use this legacy Orion 3.0 storage format, 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/Project.json Server metadata project file, includes content location
/serverworkspace/an/anthony/OrionContent/Project/ folder root of project "Project"
/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 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. 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.
/serverworkspace/an/anthony/user.json Server metadata user file, includes preferences, user rights and list of workspaces
/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/ folder root of project "Project"
/serverworkspace/an/anthony/Project Two.json Server metadata project file, includes content location (file location has changed in V2)
/serverworkspace/an/anthony/OrionContent/Project Two/ folder root of project "Project Two"
/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.

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. 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=simpleV2
  • Start the orion server.
  • Review the migration log in /serverworkspace/.metadata/migrationV2.log to ensure there are no ERROR messages.

Back to the top