Release Notes - Yoda v2.0

Version: 2.0

Released: TBA

What’s new

Changes affecting functionality for data stewards and researchers

  • Multi-file download: added support for downloading multiple files and folders directly from the portal as a zip file
  • Open data package download: added support for downloading an open data package from the landing page as a zip file
  • File browser navigation: when searching for data objects, the browser now navigates directly to the results page where the data object is located (this does not apply to collections with a large number of data objects).
  • Keyword selector: introduced a new tree keyword selector for use in metadata forms, supporting controlled vocabularies. It is currently used in the EPOS-MSL metadata schema
  • SURF Portal theme: added a new theme for the SURF portal
  • Multiple deposit groups: enhanced support for managing multiple deposit groups in the deposit module (previously, the deposit module supported only a single group per environment)
  • Landing page themes: added support for technical administrators to configure a customizable theme for landing pages using the landingpage_theme and landingpage_root Ansible parameters. It works by configuring Yoda to generate landing pages that use a custom CSS file.
  • Data package archiving: the data package archiving process will now automatically retry failed copy to vault operations, which improves the reliability of this process.
  • Vault archiving workflow: enhanced support for the vault archiving workflow
  • Secured status removal: removed the Secured status from the research space
  • Intake module removal: removed the intake module
  • Group manager: Group managers and technical admins can now change their role or remove themselves from a group as long as there is another group manager in the group

Changes affecting technical administrators

  • Ubuntu and AlmaLinux support: added support for Ubuntu 24.04 and AlmaLinux 9
  • New admin privilege group: introduced a new admin privilege group (priv-admin), which allows users to perform administrative tasks
  • Functional administration page: added a new administration page for performing functional tasks via the portal, such as setting a maintenance banner in the portal
  • Ansible library for iRODS: added an Ansible library to modify iRODS resources
  • NFS Shares Configuration: introduced an Ansible role for configuring NFS shares as iRODS storage resources
  • Rsyslog Support: added support for rsyslog to log iRODS messages in a readable format
  • RADIUS fallback removal: removed the RADIUS fallback option
  • Experimental caching: introduced experimental support for portal view and API caching

Other changes

  • Python: update rulesets to 3.12
  • iRODS: update to v4.3.4
  • Python-irodsclient: update to v3.2.0
  • GoCommands: update to v0.10.24
  • Flask and dependencies: update to v3.1.1
  • Bootstrap: update to v5.3.6
  • Mailpit: update to v1.27.4

Known issues

  • Collections with single apex “’” in the name do not work (irods/irods#5727)
  • Deadlock in msiDataObjRepl & msiDataObjCopy when called from Python (irods_rule_engine_plugin_python#54)
  • Deallocation of KeyValPair results in bad AVU or error (irods/irods#8265)
  • Renaming collection with multi-byte characters mangles subcollection paths (irods/irods#6239)
  • PAM passwords for e.g. iCommands expire too soon (within minutes). As a workaround, technical administrators can increase the password_min_time value manually (YDA-6547).
  • The group search function in the statistics module is unavailable (YDA-6548)
  • Dismissing notifications in the portal may fail under some circumstances (YDA-6549).
  • As a technical admin or group manager, changing your own role to viewer can fail under some circumstances (YDA-6550)

Upgrading from previous release

The playbook requires Ansible 2.16.x or higher.

Version constraints:

  • Requires Yoda external user service to be on version 1.9.x or higher.
  • Requires Yoda public server to be on version 1.9.x or higher.
  1. Backup/copy custom configurations made to Yoda version 1.9.5 / 1.10.0 To view what files were changed from the defaults, run git diff.

  2. After ensuring the configurations are stored safely in another folder, reset the Yoda folder using git stash or when you want to delete all changes made: git reset --hard.

  3. Check out the v2.0.0-rc.2 tag of the Yoda Git repository:
    git checkout v2.0.0-rc.2
    
  4. Set the Yoda version to v2.0.0-rc.2 in the configuration:
    yoda_version: v2.0.0-rc.2
    
  5. If the old configuration contained an iRODS authentication scheme setting, update it to use pam_password. Example:
    irods_authentication_scheme: pam_password
    
  6. It is recommended to explicitly set the Ansible interpreter path in the group_vars (if the Yoda environment servers all have the same Linux distribution) or in the host_vars (if they have different Linux distributions) in order to prevent problems with Ansible using a different interpreter than expected.

For EL 9 environments:

ansible_python_interpreter: /usr/bin/python3.9

For Ubuntu 24.04 LTS environments:

ansible_python_interpreter: /usr/bin/python3.12
  1. Install all Ansible collections needed to deploy Yoda:
    ansible-galaxy collection install -r requirements.yml
    
  2. Run the Ansible playbook in check mode:
    ansible-playbook -i <path-to-your-environment> playbook.yml --check
    ### EXAMPLE ###
    ansible-playbook -i /environments/development/allinone playbook.yml --check
    
  3. If the playbook has finished successfully in check mode, run the Ansible playbook normally:
    ansible-playbook -i <path-to-your-environment> playbook.yml
    ### EXAMPLE ###
    ansible-playbook -i /environments/development/allinone playbook.yml
    
  4. Update publication endpoints if there are published packages (DataCite, landingpages and OAI-PMH):
    irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/yoda-ruleset/tools/update-publications.r