diff --git a/docs/release-notes/release-1.6.md b/docs/release-notes/release-1.6.md index e4965d184..d35c512e5 100644 --- a/docs/release-notes/release-1.6.md +++ b/docs/release-notes/release-1.6.md @@ -21,18 +21,17 @@ Upgrade is supported by Ansible (2.9.x). Requires Yoda external user service to be on version 1.5.x or higher. Requires Yoda public server to be on version 1.6.x or higher. -1. Backup/copy custom configurations made to Yoda version 1.5. -To view what files were changed from the defaults, run `git diff`. - -2. After making sure 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`. +1. Set Yoda release to `release-1.6` in configuration. +```yaml +yoda_version: release-1.6 +``` -3. Checkout branch `release-1.6` of the Yoda Git repository -```bash -git checkout release-1.6 +2. Set the default schema to `default-1` in configuration. +```yaml +default_yoda_schema: default-1 ``` -This will set Yoda release to `release-1.6` in configuration as well as the default schema to `default-1`. -4. The core modules (`research`, `vault`, `statistics`, `group-manager`) are enabled by default in Yoda 1.6. +3. The core modules (`research`, `vault`, `statistics`, `group-manager`) are enabled by default in Yoda 1.6. Only extra modules have to be enabled in the configuration. So `modules` becomes `extra_modules` and all core modules should be removed from the `extra_modules` list. Update the configuration according to your specifications. @@ -46,7 +45,7 @@ This will set Yoda release to `release-1.6` in configuration as well as the defa version: "{{ yoda_version }}" ``` -5. The core rulesets (`core` and `irods-ruleset-uu`) are enabled by default in Yoda 1.6. +4. The core rulesets (`core` and `irods-ruleset-uu`) are enabled by default in Yoda 1.6. Only extra modules have to be enabled in the configuration. Furthermore, the research ruleset (`irods-ruleset-research`) has been merged with the UU ruleset (`irods-ruleset-uu`). So `rulesets` becomes `extra_rulesets`; @@ -63,31 +62,31 @@ This will set Yoda release to `release-1.6` in configuration as well as the defa install_scripts: no ``` -6. Run the Ansible playbook in check mode. +5. Run the Ansible playbook in check mode. ```bash ansible-playbook -i playbook.yml --check ### EXAMPLE ### ansible-playbook -i /environments/development/allinone playbook.yml --check ``` -7. If the playbook has finished succesfully in check mode, run the Ansible playbook normally. +6. If the playbook has finished succesfully in check mode, run the Ansible playbook normally. ```bash ansible-playbook -i playbook.yml ### EXAMPLE ### ansible-playbook -i /environments/development/allinone playbook.yml ``` -8. Convert all metadata XML in the vault to JSON (`default-0` XML to `default-0` JSON). +7. Convert all metadata XML in the vault to JSON (`default-0` XML to `default-0` JSON). ```bash irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/irods-ruleset-uu/tools/check-vault-metadata-xml-for-transformation-to-json.r ``` -9. Update all metadata JSON in the vault to latest metadata JSON version (`default-0` to `default-1`). +8. Update all metadata JSON in the vault to latest metadata JSON version (`default-0` to `default-1`). ```bash irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/irods-ruleset-uu/tools/check-metadata-for-schema-updates.r ``` -10. Update publication endpoints if there are published packages (landingpages and OAI-PMH)): +9. Update publication endpoints if there are published packages (landingpages and OAI-PMH)): ```bash irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/irods-ruleset-uu/tools/update-publications.r ```