Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update IceGrid templates to make the OMERO.tables module configurable #6395

Merged
merged 1 commit into from
Jul 25, 2024

Conversation

sbesson
Copy link
Member

@sbesson sbesson commented Jul 5, 2024

Add a new top-level TABLES_MODULE variable used by the Tables template to start the new server.
Functionally, this will need to be tested alongside a corresponding OMERO.py with the logic to replace @omero.tables.module@ by either the value of the omero.tables.module configuration or the default runTables value.

Together with ome/omero-py#419, the following scenarios should be tested

  • the default behavior should be unchanged i.e. starting the server either via omero admin start or the systemd service file should rewrite the IceGrid templates using the default runTables value and start the Tables service
  • setting omero config set omero.tables.module runTables in the OMERO configuration and restarting the server should have an identical behavior
  • setting omero config set omero.tables.module notexistingTables in the OMERO configuration and restarting the server should not start the Tables service and master.err should contain a line similar to /opt/omero/OMERO.venv/bin/python: No module named notexistingTables

Add a new top-level TABLES_MODULE variable used by the Tables template
to start the new server.
Functionally, this will need to be tested alongside a corresponding
OMERO.py with the logic to replace @omero.tables.module@ by either the
value of the omero.tables.module configuration or the default runTables
value.
@sbesson
Copy link
Member Author

sbesson commented Jul 11, 2024

Probably the outstanding question is whether this mechanism is in scope for the upcoming OMERO.server 5.6.12 @jburel?

If so, an initial documentation step would be to add the property to etc/omero.properties in this repository and add a new Tables header similar to ome/omero-py#416 to register the new property in the configuration glossary of the reference OMERO documentation at https://omero.readthedocs.io/en/latest/sysadmins/config.html

@jburel
Copy link
Member

jburel commented Jul 11, 2024

I think it will make sense to include this strategy in the upcoming release

@sbesson
Copy link
Member Author

sbesson commented Jul 18, 2024

As discussed this morning with @knabar and @jburel, OMERO.py 5.19.4 has just been released with the underlying infrastructure allowing to replace the token in the templates.

I quickly tested the behavior of a server restart with the templates modified as per with this PR with OMERO.py 5.19.3 (or earlier). In that case, the server components will start as expected except for the Tables service which will be marked as inactive. In addition master.err should include an error similar to:

/opt/omero/OMERO.venv/bin/python: Error while finding module specification for '@omero.tables.module@' (ModuleNotFoundError: No module named '@omero')

I assume the release notes of OMERO 5.6.12 should document the requirement to upgrade OMERO.py as part of the server upgrade but let me know if the above should also be captured e.g. in the troubleshooting section of the documentation.

@jburel jburel merged commit b545750 into ome:develop Jul 25, 2024
4 checks passed
@sbesson sbesson deleted the omero_tables_module branch July 25, 2024 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants