From d0a1194d2155e5c06e70386ee2b3f5e6596959b0 Mon Sep 17 00:00:00 2001
From: Oliver Bertuch <o.bertuch@fz-juelich.de>
Date: Wed, 18 Nov 2020 13:49:10 +0100
Subject: [PATCH] Add release notes docs, including references to #7417 and
 #5345

---
 .../7418-datasourcedefinition.md              | 75 +++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 doc/release-notes/7418-datasourcedefinition.md

diff --git a/doc/release-notes/7418-datasourcedefinition.md b/doc/release-notes/7418-datasourcedefinition.md
new file mode 100644
index 00000000000..7afcddcaf8b
--- /dev/null
+++ b/doc/release-notes/7418-datasourcedefinition.md
@@ -0,0 +1,75 @@
+## Easier Configuration of Database Connections
+
+Dataverse now being able to use up-to-date Java technologies, transforms
+the way how to configure the connection to your PostgreSQL database.
+
+In the past, the configuration of the connection has been quite static
+and not very easy to update. This has been an issue especially for cloud
+and container usage.
+
+Using MicroProfile Config API (#7000, #7418), you can much more easily deposit configuration
+details. For an overview of supported options, please see the
+[installation guide](https://guides.dataverse.org/en/5.3/installation/config.html#jvm-options).
+
+
+<!-- ## Update to Payara Platform 5.2020.6 -->
+<!-- ... -->
+
+<!-- PLACEHOLDER REPLACEMENT TEXT FOR PAYARA UPGRADE NOTE #7417 -->
+🚨 THIS VERSION OF DATAVERSE **REQUIRES** UPGRADING TO PAYARA 5.2020.6. 🚨
+
+<!-- ... -->
+
+## Upgrading from earlier releases
+
+ℹ️ You need to update the Payara Application Server before continuing here. See above.
+
+1. Undeploy the previous version.
+```
+<payara install path>/asadmin list-applications
+<payara install path>/asadmin undeploy dataverse-<version>
+```
+
+(where `<payara install path>` is where Payara 5 is installed, for example: `/usr/local/payara5`)
+
+2. Update your database connection before updating.
+
+Please configure your connection details, replacing all the `${DB_...}`.
+(If you are using a PostgreSQL server on `localhost:5432`, you can omit `dataverse.db.host` and `dataverse.db.port`.)
+
+```
+<payara install path>/asadmin create-system-properties "dataverse.db.user=${DB_USER}"
+<payara install path>/asadmin create-system-properties "dataverse.db.host=${DB_HOST}"
+<payara install path>/asadmin create-system-properties "dataverse.db.port=${DB_PORT}"
+<payara install path>/asadmin create-system-properties "dataverse.db.name=${DB_NAME}"
+echo "AS_ADMIN_ALIASPASSWORD=${DB_PASS}" > /tmp/password.txt
+<payara install path>/asadmin create-password-alias --passwordfile /tmp/password.txt dataverse.db.password
+rm /tmp/password.txt
+```
+
+<!-- PLACE HOLDER FOR EJB TIMER DATABASE RESET NOTE #5345 -->
+
+Now you are safe to delete the old password alias and DB pool:
+```
+<payara install path>/asadmin delete-jdbc-connection-pool --cascade=true dvnDbPool
+<payara install path>/asadmin delete-password-alias db_password_alias
+```
+
+3. Stop payara and remove the generated directory, start.
+```
+service payara stop
+# remove the generated directory:
+rm -rf <payara install path>/payara/domains/domain1/generated
+service payara start
+```
+
+3. Deploy this version.
+```
+<payara install path>/bin/asadmin deploy dataverse-5.3.war
+```
+
+4. Restart Payara
+```
+service payara stop
+service payara start
+```
\ No newline at end of file