Skip to content

Commit

Permalink
improve SMTP configuration documentation/comments
Browse files Browse the repository at this point in the history
Add some more information regarding SMTP configuration parameters,
in particular regarding how the EUS SMTP parameters changed
between Yoda 1.8 and 1.9.
  • Loading branch information
stsnel committed Sep 8, 2023
1 parent d41a2c8 commit 682cf7d
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/administration/configuring-yoda.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ These settings also affect the External User Service (EUS).

Variable | Description
-----------------------------|---------------------------------------------
smtp_server | SMTP server to send mail to
smtp_server | SMTP server to send mail to (smtp://server.name:port or smtps://server.name:port, e.g. smtp://localhost:25)
smtp_username | SMTP server username
smtp_password | SMTP server password
smtp_auth | Whether to use SMTP authentication (true/false, default: true)
Expand Down
25 changes: 18 additions & 7 deletions docs/release-notes/release-1.9.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,43 +74,54 @@ metadata_schemas:
active: true
```

7. Set `postgresql_perform_db_upgrade` to `true` in the configuration to perform the database upgrase from Postgresql 9 to 15.
7. If you use the External User Service (EUS): some EUS parameters have changed from Yoda 1.8 to 1.9. Yoda 1.9 performs server certificate validation of requests from the provider to the EUS server by default. This can be disabled by setting `eus_api_tls_verify` to `false`. For some SMTP parameters, EUS uses joint parameters with the provider in Yoda 1.9:

| Old parameter (1.8) | New parameter | Notes |
|---------------------|----------------|--------------------------------------|
| eus_smtp_host | smtp_server | New format. e.g. smtp://localhost:25 |
| eus_smtp_port | smtp_server | New format. e.g. smtp://localhost:25 |
| eus_smtp_auth | smtp_auth | |
| eus_smtp_security | smtp_server | New format. e.g. smtp://localhost:25 |

Please see the [configuration guide](../administration/configuring-yoda.md) for more information.

8. Set `postgresql_perform_db_upgrade` to `true` in the configuration to perform the database upgrade from Postgresql 9 to 15.
Optionally set `postgresql_remove_old_data_after_upgrade` to `true` in the configuration to clean up PostgreSQL 9 data and shim after the upgrade.
```yaml
postgresql_perform_db_upgrade: true
postgresql_remove_old_data_after_upgrade: false
```

8. Install all Ansible collections needed to deploy Yoda:
9. Install all Ansible collections needed to deploy Yoda:
```bash
ansible-galaxy collection install -r requirements.yml
```

9. Run the Ansible playbook in check mode.
10. Run the Ansible playbook in check mode.
```bash
ansible-playbook -i <path-to-your-environment> playbook.yml --check
### EXAMPLE ###
ansible-playbook -i /environments/development/allinone playbook.yml --check
```

10. If the playbook has finished successfully in check mode, run the Ansible playbook normally.
11. If the playbook has finished successfully in check mode, run the Ansible playbook normally.
```bash
ansible-playbook -i <path-to-your-environment> playbook.yml
### EXAMPLE ###
ansible-playbook -i /environments/development/allinone playbook.yml
```

11. Update all publication metadata to support DOI versioning.
13. Update all publication metadata to support DOI versioning.
```bash
irule -r irods_rule_engine_plugin-python-instance -F /etc/irods/yoda-ruleset/tools/transform-existing-publications.r
```

12. Update all metadata JSON in the vault to latest metadata JSON version (`default-2` to `default-3`).
14. Update all metadata JSON in the vault to latest metadata JSON version (`default-2` to `default-3`).
```bash
irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/yoda-ruleset/tools/check-metadata-for-schema-updates.r
```

13. Update publication endpoints if there are published packages (DataCite, landingpages and OAI-PMH):
15. Update publication endpoints if there are published packages (DataCite, landingpages and OAI-PMH):
```bash
irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/yoda-ruleset/tools/update-publications.r
```
2 changes: 2 additions & 0 deletions roles/yoda_external_user_service/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ eus_db_password: PLACEHOLDER
eus_db_users_id_seq: users_id_seq

smtp_server: PLACEHOLDER # SMTP server to send mail to
# (smtp://server.name:port or smtps://server.name:port,
# e.g. smtp://localhost:25)
smtp_username: PLACEHOLDER # SMTP server username
smtp_password: PLACEHOLDER # SMTP server password
smtp_auth: true # Whether to use SMTP authentication
Expand Down
2 changes: 2 additions & 0 deletions roles/yoda_rulesets/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@ notifications_sender_name: "Yoda system" # Notifiations sender name
notifications_reply_to: [email protected] # Notifiations Reply-To email address

smtp_server: PLACEHOLDER # SMTP server to send mail to
# (smtp://server.name:port or smtps://server.name:port,
# e.g. smtp://localhost:25)
smtp_username: PLACEHOLDER # SMTP server username
smtp_password: PLACEHOLDER # SMTP server password
smtp_auth: true # Whether to use SMTP authentication
Expand Down

0 comments on commit 682cf7d

Please sign in to comment.