Table of Contents

Setup

New Installation

Use the navigation on the left to start the installation of the Ometa Software Suite. Ensure that your system complies with the minimum system requirements before starting the installation process.

Upgrade

To ensure a smooth and successful upgrade to the latest features and improvements of the Ometa Framework, it's important to follow the recommended upgrade path. Due to the continuous evolution of the software across different versions, direct upgrades from very old installations to the newest release are sometimes not possible or recommended.

To manage the technical complexity and potential issues that can arise during upgrades, we often implement staged upgrades. This means that in certain situations, you might first need to upgrade to an intermediate version before you can proceed to your desired target version. Skipping intermediate steps can lead to compatibility problems or a failed upgrade.

Why Staged Upgrades?

  • Minimized Complexity: Staged upgrades break down the upgrade process into smaller, more manageable steps. This reduces the risk of encountering a large number of changes all at once and makes troubleshooting easier if issues occur.
  • Ensuring Compatibility: Intermediate versions often include necessary database migrations, configuration updates, or compatibility layers that are essential for a successful jump to later releases. Skipping these steps might leave your installation in an incompatible state.
  • Stable Transition: By upgrading incrementally, you can more easily identify and address any potential issues introduced at each stage, ensuring a more stable and reliable transition to the latest version.

Before initiating any upgrade, please carefully locate your currently installed version in the "Installed version" column of the table below. Then, find your desired upgrade version in the "Upgrade to version" column. The corresponding "Action to take" column will provide you with the necessary steps to follow for a successful upgrade.

Important:

  • Follow the "Action to take" instructions precisely. These instructions are crucial for a successful upgrade.
  • Always back up your data before starting any upgrade process. This is essential to protect against data loss in case of unexpected issues.
  • Review the release notes for each version you are upgrading to. Release notes contain important information about changes, new features, potential breaking changes, and any specific upgrade instructions.

Consult the Upgrade Compatibility Table Below:

Installed version Upgrade to version Action to take
pre-v5.2.x v5.3.x Intermediate Upgrade Required: First upgrade to the latest v5.2.x (e.g., v5.2.10), then upgrade to v5.3.x. This ensures compatibility with changes introduced in v5.3.x and later.

Documentation Naming Conventions

Within the setup documentation, there are many occurrences of references to specific names or variables like %OMETA_INSTALL_ROOT%. Those names and variables are used for easier reference from within the article to real world items, for example folders or files on disk.

For the full list of those conventions, consult Documentation Naming Conventions.