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.
Difference between revisions of "Orion/Metadata migration"
< Orion
(→Orion 6.0 Migration) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
=== Orion 3.0 (CompatibilityMetaStore) === | === Orion 3.0 (CompatibilityMetaStore) === | ||
| − | The legacy server metadata | + | The legacy server metadata was organized as follows: |
{|{{BMTableStyle}} | {|{{BMTableStyle}} | ||
|-{{BMTHStyle}} | |-{{BMTHStyle}} | ||
| Line 20: | Line 20: | ||
|- | |- | ||
| /serverworkspace/A | | /serverworkspace/A | ||
| − | | folder root of " | + | | 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/ | + | | /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/ | + | | /serverworkspace/an/anthony/OrionContent/Sentiment.Analysis.App/ |
| − | | folder root of project " | + | | folder root of project "Sentiment.Analysis.App" |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|- | |- | ||
| /serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search | | /serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search | ||
| Line 80: | Line 79: | ||
[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. | [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 === | + | ==== 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: | 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. | + | * Backup the [[Orion/Server_admin_guide#Changing_the_server_workspace|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 <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 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/ | + | | /serverworkspace/an/anthony/anthony-OrionContent.json |
| − | | Server metadata workspace file, includes project list (file location has changed in V2) | + | | 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/ | + | | /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/ | + | | /serverworkspace/an/anthony/OrionContent/Sentiment.Analysis.App/ |
| − | | folder root of project " | + | | 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 | ||
| Line 132: | Line 125: | ||
[1] The workspace root folder /serverworkspace/an/anthony/OrionContent is no longer a "protected" location and can hold arbitrary files. | [1] The workspace root folder /serverworkspace/an/anthony/OrionContent is no longer a "protected" location and can hold arbitrary files. | ||
| − | === Orion 6.0 Migration === | + | [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: | 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. | + | * Backup the [[Orion/Server_admin_guide#Changing_the_server_workspace|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 <code>orion.conf</code> configuration file for your server: | * Add the properties to the <code>orion.conf</code> configuration file for your server: | ||
<source lang="properties"> | <source lang="properties"> | ||
| Line 144: | Line 139: | ||
* Review the migration log in <code>/serverworkspace/.metadata/migration2.log</code> to ensure there are no <code>ERROR</code> messages. | * Review the migration log in <code>/serverworkspace/.metadata/migration2.log</code> to ensure there are no <code>ERROR</code> messages. | ||
| + | === Orion 7.0 (SimpleMetaStore) === | ||
| + | |||
| + | Starting with Orion 7.0, there is now one version of the server metadata supported. It is organized as follows: | ||
| + | {|{{BMTableStyle}} | ||
| + | |-{{BMTHStyle}} | ||
| + | ! 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 (no change). Unique Id for the workspace is anthony-OrionContent. | ||
| + | |- | ||
| + | | /serverworkspace/an/anthony/Sentiment.Analysis.App.json | ||
| + | | Server metadata project file, includes content location (no change). 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) | ||
| + | |} | ||
| + | |||
| + | ==== Orion 7.0 Migration ==== | ||
| + | |||
| + | When the Orion 7.0 server is started, the server is now automatically migrated to the simple 7.0 format. Users are automatically migrated when they are first accessed by the server. This can either be when the user logs in or when the user is indexed. | ||
| + | |||
| + | The Orion log file now contains migration information. Ensure there are no <code>ERROR</code> messages in the log as you would normally. | ||
| + | |||
| + | Unexpected ("orphan") files found in /serverworkspace/ by the migration will be reported with an <code>INFO</code> message and moved to /serverworkspace/.archive. The files moved to the archive can be deleted without restarting the server. | ||
| + | |||
| + | ==== Changes from Orion 6.0 ==== | ||
| + | |||
| + | [1] The server now only allows one workspace. Requests to create a second workspace return the existing "Orion Content" workspace. As a result, the migration in Orion 7.0 folds multiple workspaces into one workspace and removes secondary workspaces. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=439735 Close the capability to create multiple workspaces]. | ||
| + | |||
| + | [2] The server workspace folder can now be moved. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=436578 Renaming the install directory breaks all the workspaces]. | ||
| + | |||
| + | === Orion 8.0 (SimpleMetaStore) === | ||
| + | |||
| + | The server metadata in Orion 8.0 is organized as follows: | ||
| + | |||
| + | {|{{BMTableStyle}} | ||
| + | |-{{BMTHStyle}} | ||
| + | ! 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 (no change). Unique Id for the workspace is anthony-OrionContent. | ||
| + | |- | ||
| + | | /serverworkspace/an/anthony/Sentiment.Analysis.App.json | ||
| + | | Server metadata project file, includes content location (no change). 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/tasks | ||
| + | | Orion Tasks (no change) | ||
| + | |} | ||
| + | |||
| + | ==== Orion 8.0 Migration ==== | ||
| + | |||
| + | When the Orion 8.0 server is started, the server is automatically migrated to the Orion 8.0 format. Users are automatically migrated when they are first accessed by the server. This can either be when the user logs in or when the user performs internal tasks. | ||
| + | |||
| + | The Orion log file now contains migration information. Ensure there are no <code>ERROR</code> messages in the log as you would normally. | ||
| + | |||
| + | Unexpected ("orphan") files found in /serverworkspace/ by the migration will be reported with an <code>INFO</code> message and moved to /serverworkspace/.archive. The files moved to the archive can be deleted without restarting the server. | ||
| + | |||
| + | ==== Changes from Orion 8.0 ==== | ||
| + | |||
| + | [1] The server no longer uses an index for search and no longer requires the files under /serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=450017 Provide a reliable "grep" style search]. | ||
| + | [2] Internally the format of the user metadata was updated. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=444864 Orion User API needs cleanup ]. | ||
[[Category:Orion]] | [[Category:Orion]] | ||
Latest revision as of 16:25, 20 January 2015
Contents
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.confconfiguration file for your server:
orion.core.metastore=simple orion.file.layout=userTree
- Start the orion server.
- Review the migration log in
/serverworkspace/.metadata/migration.logto ensure there are noERRORmessages.
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.confconfiguration file for your server:
orion.core.metastore=simple2
- Start the orion server.
- Review the migration log in
/serverworkspace/.metadata/migration2.logto ensure there are noERRORmessages.
Orion 7.0 (SimpleMetaStore)
Starting with Orion 7.0, there is now one version of the server metadata supported. It 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 (no change). Unique Id for the workspace is anthony-OrionContent. |
| /serverworkspace/an/anthony/Sentiment.Analysis.App.json | Server metadata project file, includes content location (no change). 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) |
Orion 7.0 Migration
When the Orion 7.0 server is started, the server is now automatically migrated to the simple 7.0 format. Users are automatically migrated when they are first accessed by the server. This can either be when the user logs in or when the user is indexed.
The Orion log file now contains migration information. Ensure there are no ERROR messages in the log as you would normally.
Unexpected ("orphan") files found in /serverworkspace/ by the migration will be reported with an INFO message and moved to /serverworkspace/.archive. The files moved to the archive can be deleted without restarting the server.
Changes from Orion 6.0
[1] The server now only allows one workspace. Requests to create a second workspace return the existing "Orion Content" workspace. As a result, the migration in Orion 7.0 folds multiple workspaces into one workspace and removes secondary workspaces. See Close the capability to create multiple workspaces.
[2] The server workspace folder can now be moved. See Renaming the install directory breaks all the workspaces.
Orion 8.0 (SimpleMetaStore)
The server metadata in Orion 8.0 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 (no change). Unique Id for the workspace is anthony-OrionContent. |
| /serverworkspace/an/anthony/Sentiment.Analysis.App.json | Server metadata project file, includes content location (no change). 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/tasks | Orion Tasks (no change) |
Orion 8.0 Migration
When the Orion 8.0 server is started, the server is automatically migrated to the Orion 8.0 format. Users are automatically migrated when they are first accessed by the server. This can either be when the user logs in or when the user performs internal tasks.
The Orion log file now contains migration information. Ensure there are no ERROR messages in the log as you would normally.
Unexpected ("orphan") files found in /serverworkspace/ by the migration will be reported with an INFO message and moved to /serverworkspace/.archive. The files moved to the archive can be deleted without restarting the server.
Changes from Orion 8.0
[1] The server no longer uses an index for search and no longer requires the files under /serverworkspace/.metadata/.plugins/org.eclipse.orion.server.core.search. See Provide a reliable "grep" style search.
[2] Internally the format of the user metadata was updated. See Orion User API needs cleanup .