******************** Version requirements ******************** Summary of changes for OMERO 5.5 and provisional changes for 5.6 ================================================================ Criteria for what is considered to be supportable includes whether support by both upstream developers and operating system distributions will be available for the lifetime of the |version| release (including security support), and also upon our resources allocated to CI and testing. If we are not actively testing it, we **cannot** claim it is supported or functional. Software components must be provided and supported either by an operating system distribution or their original developers. This section contains a summary of the changes made to the minimum version requirements for the current (|version|) release and also **possible** changes for the next release, albeit **tentatively at this point**. The intent is to provide a roadmap in order that sysadmins may plan ahead and ensure that prerequisites are in place ahead of time to ease future upgrades. The following sections provide more detailed information and the rationale for the changes. Please check the meaning of the various :ref:`symbols ` used on this page. Any system/component with a green tick symbol is supported. Operating systems ----------------- * Microsoft Windows * Client support only. * Rationale: see `blog post explanation `_ * MacOS X * MacOS X is typically suited only to client use, not serious server deployment, although the server can be expected to build on versions with current security support for development purposes. * Linux distribution CentOS/RHEL .. list-table:: :header-rows: 1 * - Distribution version - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 6.x - |Deprecated| - |Dropped| - |Dropped| * - 7.x - |Recommended| - |Recommended| - |Dropped| * - 8.x - |Upcoming| - |Upcoming| - |Recommended| * Linux distribution Ubuntu LTS .. list-table:: :header-rows: 1 * - Distribution version - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 14.04 - |Supported| - |Supported| - |Dropped| * - 16.04 - |Recommended| - |Recommended| - |Supported| * - 18.04 - |Upcoming| - |Supported| - |Recommended| * Only LTS versions are supported and tested. Non-LTS versions following a supported LTS release are likely to work but are not officially supported or tested. * Rationale: No change in this timeframe. Bitness ------- .. list-table:: :header-rows: 1 * - Bitness - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 32-bit - |Deprecated| for Ice and native code [client] - |Dropped| - |Dropped| * - 64-bit - |Recommended| - |Recommended| - |Recommended| * Rationale: OMERO is tested on 64-bit systems only. Components ---------- * PostgreSQL .. list-table:: :header-rows: 1 * - PostgreSQL - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 9.3 - |Deprecated| - |Dropped| - |Dropped| * - 9.4 - |Supported| - |Deprecated| - |Deprecated| * - 9.5 - |Supported| - |Supported| - |Deprecated| * - 9.6 - |Recommended| - |Supported| - |Deprecated| * - 10 - |Upcoming| - |Recommended| - |Supported| * - 11 - |Upcoming| - |Upcoming| - |Recommended| * Rationale: Current releases available for all supported systems from upstream and for CentOS/RHEL officially via SCL (software collections). * Python .. list-table:: :header-rows: 1 * - Python - OMERO.web 5.4 - OMERO.server 5.4 - OMERO 5.5 - OMERO 5.6 * - 2.6 - |Broken| - |Supported| - |Dropped| - |Dropped| * - 2.7 - |Recommended| - |Recommended| - |Recommended| - |Deprecated| * - 3.5 - |Broken| - |Broken| - |Broken| - |Supported| * - 3.6 - |Broken| - |Broken| - |Broken| - |Recommended| * Rationale: 2.7 is provided by all systems except for CentOS/RHEL 6.x, however it is available officially via SCL. * Ice .. list-table:: :header-rows: 1 * - Ice - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 3.5 - |Deprecated| - |Dropped| - |Dropped| * - 3.6 - |Recommended| - |Recommended| - |Recommended| * - 3.7 - |Unsupported| - |Unsupported| - |Unsupported| * Rationale: Ice releases often include breaking changes and Ice 3.7 requires substantial changes to OMERO. To avoid future maintenance burden OME's effort is better invested in migrating away from Ice completely. * Java .. list-table:: :header-rows: 1 * - Java - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 7 - |Deprecated| - |Dropped| - |Dropped| * - 8 - |Recommended| - |Recommended| - |Supported| * - 11 - |Unsupported| - |Supported| - |Recommended| * Rationale: For OMERO 5.4 deprecate Java 7 because security support ended in April 2015. MATLAB ships with Java 8 since R2017b. .. warning:: *Only* OpenJDK is supported from OMERO 5.5. OME no longer tests Oracle Java due to `licensing changes `__. * nginx .. list-table:: :header-rows: 1 * - nginx - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 1.8 - |Deprecated| - |Dropped| - |Dropped| * - 1.10 - |Recommended| - |Supported| - |Deprecated| * - 1.12 - |Supported| - |Recommended| - |Supported| * - 1.14 - |Upcoming| - |Supported| - |Recommended| * - 1.16 - |Upcoming| - |Upcoming| - |Upcoming| .. _support-levels: Support levels ============== The following table defines the symbols used throughout this page to describe the support status of a given component, as it progresses from being new and not supported, to supported and tested on a routine basis, and to finally being old and no longer supported nor tested. .. list-table:: :header-rows: 1 * - Level - Meaning - Description * - |Upcoming| - unsupported/new - New version not yet regularly tested and not officially supported; may or may not work (use at own risk) * - |Supported| - supported/suboptimal - Version which is tested, confirmed to work correctly, but may not offer optimal performance/experience * - |Recommended| - supported/optimal - Version which is regularly tested, confirmed to work correctly, recommended for optimal performance/experience * - |Deprecated| - supported/deprecated - Version which is less tested, expected to work correctly, but may not offer optimal performance/experience; official support may be dropped in the next major OMERO release * - |Dropped| - unsupported/old - Old version no longer tested and no longer officially supported; may or may not work (use at own risk) * - |Broken| - unsupported/broken - Known to not work * - |Unsupported| - unsupported/misc - Not supported for some reason other than the above Operating system support ======================== The following subsections detail the versions of each operating system which are supported by both its upstream developers (for security and general updates) and by OME for OMERO building and server deployment. UNIX (FreeBSD) -------------- It only really makes sense to support the base toolchain for major releases and the Ports tree (which is continually updated); these will be covered in the dependencies, below. Linux (CentOS and RHEL) ----------------------- General overview for `RHEL `__ and `CentOS `__ .. list-table:: :header-rows: 1 * - Version - Release date - Upstream support - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 - Details * - 6 - from Nov 2010 - to Nov 2020 - |Deprecated| - |Dropped| - |Dropped| - `Reference `__ * - 7 - from June 2014 - to June 2024 - |Recommended| - |Recommended| - |Dropped| - `Reference `__ * - 8 - from May 2019 - to May 2029 - |Upcoming| - |Upcoming| - |Recommended| - `Reference `__ RHEL/CentOS 7 is supported at present. Given the long life of enterprise releases, we intend to support only the latest release at any given time or else it ties us into very old dependencies. Linux (Ubuntu) -------------- `General overview `__ .. list-table:: :header-rows: 1 * - Version - Release date - Upstream support - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 14.04 LTS - from Apr 2014 - to Apr 2019 - |Supported| - |Dropped| - |Dropped| * - 16.04 LTS - from Apr 2016 - to Apr 2021 - |Recommended| - |Recommended| - |Supported| * - 18.04 LTS - from Apr 2018 - to Apr 2028 - |Upcoming| - |Supported| - |Recommended| Only the LTS releases are supported due to resource limitations upon CI and testing. Only the last two LTS releases are supported (being a bit more frequent than CentOS/RHEL). There is currently no CI testing for any version. Dependencies ============ The following subsections detail the versions of each dependency needed by OMERO which are supported by both its upstream developers (for security and general updates) and by OME for OMERO building and server and client deployment. .. note:: Versions in brackets are in development distributions and may change without notice. Package lists ------------- .. list-table:: :header-rows: 1 * - Operating system - Details * - CentOS 6 / RHEL 6 - `Reference `__ * - CentOS 7 / RHEL 7 - `Reference `__ * - Ubuntu - `Reference `__ * - Homebrew - `Reference `__ * - FreeBSD Ports - `Reference `__ PostgreSQL ---------- `General overview `__ OMERO support policies ^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: :header-rows: 1 * - Version - Release date - Upstream support - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 9.3 - from Sep 2013 - to Sep 2018 - |Deprecated| - |Dropped| - |Dropped| * - 9.4 - from Dec 2014 - to Dec 2019 - |Supported| - |Deprecated| - |Dropped| * - 9.5 - from Jan 2016 - to Jan 2021 - |Supported| - |Supported| - |Deprecated| * - 9.6 - from Sep 2016 - to Sep 2021 - |Recommended| - |Supported| - |Deprecated| * - 10 - from Oct 2017 - to Nov 2022 - |Upcoming| - |Recommended| - |Supported| * - 11 - from Oct 2018 - to Nov 2023 - |Upcoming| - |Upcoming| - |Recommended| * - Details - - `Reference `__ - - - Version provided by distribution ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If no version is provided, a suitable repository is indicated. .. list-table:: :header-rows: 1 * - Version - CentOS/RHEL - Ubuntu - Homebrew - FreeBSD Ports * - 9.4 - 6 (`postgresql `__), 7 (`postgresql `__) - 14.04, 16.04, 18.04 (`postgresql `__) - Yes - Yes * - 9.5 - 6 (`postgresql `__), 7 (`postgresql `__) - 14.04, 16.04, 18.04 (`postgresql `__) - Yes - Yes * - 9.6 - 6 (`postgresql `__), 7 (`postgresql `__), 8 (`postgresql `__) - 14.04, 16.04, 18.04 (`postgresql `__) - Yes - Yes * - 10 - 6 (`postgresql `__), 7 (`postgresql `__), 8 (`postgresql `__) - 14.04, 16.04, 18.04 (`postgresql `__) - Yes - Yes * - Details - - `Reference `__ - - The PostgreSQL project provides `packages `__ for supported platforms therefore distribution support is not necessary. .. _python-requirements: Python ------ OMERO support policies ^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: :header-rows: 1 * - Version - Release date - Upstream support - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 - Details * - 2.6 - from Oct 2008 - to Oct 2013 - |Dropped| [1]_ |Supported| [2]_ - |Dropped| - |Dropped| - `PEP 361 `__ * - 2.7 - from Jul 2010 - to Jan 2020 - |Recommended| - |Recommended| - |Deprecated| - `PEP 373 `__ * - 3.2 - from Feb 2011 - to Feb 2016 - |Broken| - |Broken| - |Broken| - `PEP 392 `__ * - 3.3 - from Sep 2012 - to Sep 2017 - |Broken| - |Broken| - |Broken| - `PEP 398 `__ * - 3.4 - from Mar 2014 - to Mar 2019 - |Broken| - |Broken| - |Broken| - `PEP 429 `__ * - 3.5 - from Sep 2015 - to Sep 2020 - |Broken| - |Broken| - |Supported| - `PEP 478 `__ * - 3.6 - from Dec 2016 - to Dec 2021 - |Broken| - |Broken| - |Recommended| - `PEP 494 `__ * - 3.7 - from Jun 2018 - to Jun 2023 - |Broken| - |Broken| - |Upcoming| - `PEP 537 `__ .. [1] For OMERO.web, Python 2.7 is the minimum supported version. .. [2] For OMERO.py and OMERO.server 5.4, Python 2.6 is the minimum supported version. Version provided by distribution ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: :header-rows: 1 * - Version - CentOS/RHEL - Ubuntu - Homebrew - FreeBSD Ports * - 2.6 - 6 - 10.04 - N/A - Yes * - 2.7 - 7 - 14.04, 16.04, 18.04 - Yes - Yes * - 3.2 - N/A - N/A - N/A - Yes * - 3.3 - N/A - N/A - N/A - Yes * - 3.4 - 7 (`EPEL `__) - 14.04 - N/A - Yes * - 3.5 - N/A - 16.04 - N/A - Yes * - 3.6 - 7 (`EPEL `__) - 18.04 - Yes - Yes * - Details - - `Python 2 `__ `Python 3 `__ - - At the moment 2.7 support is present upstream until 2020; 3.x versions continue to be released and retired regularly in parallel. The limiting factor will be distribution support for 2.7 as major packages are slowly switching to 3.x and this might cause problems if our python module dependencies are no longer available without major effort. The supported version of the Django module used by OMERO.web (1.8) requires Python 2.7. The older version (1.6) will work with Python 2.6 but lacks security support so should *not* be used. .. _ice-requirements: Ice --- :zeroc:`General overview ` OMERO support policies ^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: :header-rows: 1 * - Version - Release date - Upstream support - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 - Details * - 3.5 - from Mar 2013 - to Oct 2013 - |Deprecated| - |Dropped| - |Dropped| - :zerocforum:`3.5.0 <6093/ice-3-5-0-released>`, :zerocforum:`3.5.1 <6283/ice-3-5-1-released>` * - 3.6 - from June 2015 - to TBA - |Recommended| - |Recommended| - |Recommended| - :zerocforum:`3.6.0 <6631/ice-3-6-0-and-ice-touch-3-6-0-released>` (:zerocforum:`3.6.1 <45941/ice-3-6-0-and-ice-touch-3-6-1-released>` |Broken|), :zerocforum:`3.6.2 <46347/ice-ice-e-and-ice-touch-3-6-2-released>`, :zerocforum:`3.6.3 <46475/ice-ice-e-and-ice-touch-3-6-3-released>`, :zerocforum:`3.6.4 <46550/ice-ice-e-and-ice-touch-3-6-4-released>` * - 3.7 - from July 2017 - to TBA - |Unsupported| - |Unsupported| - |Unsupported| - :zerocforum:`3.7.0 <46530/ice-3-7-0-and-ice-touch-3-7-0-released>`, :zerocforum:`3.7.1 <46620/ice-3-7-1-released>` Version provided by distribution ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If no version is provided, a suitable repository is indicated. .. list-table:: :header-rows: 1 * - Version - CentOS/RHEL - Ubuntu - Homebrew - FreeBSD Ports * - 3.5 - 6, 7 (`zeroc `__) - 14.04, 16.04 - N/A - N/A * - 3.6 - 6, 7 (`zeroc `__) - 14.04, 16.04 (`zeroc `__) - Yes - Yes * - 3.7 - 7 (`zeroc `__) - 16.04, 18.04 (`zeroc `__) - Yes - Yes * - Details - - `Reference `__ - - Java ---- `General overview `__ OMERO support policies ^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: :header-rows: 1 * - Version - Release date - Upstream support - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 - Details * - 7 - from Jul 2011 - to Apr 2015 - |Deprecated| - |Dropped| - |Dropped| - `Reference `__ * - 8 - from Mar 2014 - to Jun 2023 - |Recommended| - |Recommended| - |Supported| - `Reference `__ * - 11 - from Sep 2018 - to Oct 2024 - |Unsupported| - |Supported| - |Recommended| - `Reference `__ Version provided by distribution ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: :header-rows: 1 * - Version - CentOS/RHEL - Ubuntu - Homebrew - FreeBSD Ports * - 7 - 6, 7 - 14.04 - N/A - Yes * - 8 - 6, 7 - 16.04, 18.04 - N/A - N/A * - 11 - 7 - 18.04 - N/A - Yes * - Details - - `Reference `__ - - Note that all distributions provide OpenJDK due to distribution restrictions by Oracle. `Oracle Java `__ may be used if downloaded separately. Nginx ----- `General overview `__ and `roadmap `__ OMERO support policies ^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: :header-rows: 1 * - Version - Release date - Upstream support - OMERO 5.4 - OMERO 5.5 - OMERO 5.6 * - 1.6 - from Apr 2014 - to Apr 2015 - |Deprecated| - |Dropped| - |Dropped| * - 1.8 - from Apr 2015 - to Jan 2016 - |Supported| - |Deprecated| - |Dropped| * - 1.10 - from Apr 2016 - to Apr 2017 - |Recommended| - |Supported| - |Deprecated| * - 1.12 - from Apr 2017 - to Apr 2018 - |Supported| - |Recommended| - |Supported| * - 1.14 - from Apr 2018 - to Apr 2019 - |Upcoming| - |Supported| - |Recommended| * - 1.16 - from Apr 2019 - TBA - |Upcoming| - |Upcoming| - |Upcoming| Version provided by distribution ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If no version is provided, a suitable repository is indicated. .. list-table:: :header-rows: 1 * - Version - CentOS/RHEL - Ubuntu - Homebrew - FreeBSD Ports * - 1.12 - 7 (`EPEL `__) - 14.04 (`nginx `__) - N/A - Yes * - 1.14 - N/A - 16.04, 18.04 (`nginx `__) - Yes - Yes * - Details - - - `Reference `__ -