From a48fdcb889d3a836179e165407118bd940e7684d Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Mon, 30 Nov 2020 20:27:46 -0500 Subject: [PATCH 01/14] initial seeding of release notes --- doc/release-notes/5.3-release-notes.md | 70 ++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 doc/release-notes/5.3-release-notes.md diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md new file mode 100644 index 00000000000..24804b1c55c --- /dev/null +++ b/doc/release-notes/5.3-release-notes.md @@ -0,0 +1,70 @@ +# Dataverse 5.3 + +This release brings new features, enhancements, and bug fixes to Dataverse. Thank you to all of the community members who contributed code, suggestions, bug reports, and other assistance across the project. + +## Release Highlights + +### xxx + +xxx (#6919). + +## Major Use Cases + +Newly-supported use cases in this release include: + +- xxx. (Issue #6919, PR #7369) + +## Notes for Dataverse Installation Administrators + +### xxx + +xxx + +### New Database Settings and JVM Options + +xx + +- :xxx - xxx + +## Notes for Tool Developers and Integrators + +### xxx + +xxx + +## Complete List of Changes + +For the complete list of code changes in this release, see the [5.3 Milestone](https://github.com/IQSS/dataverse/milestone/93?closed=1) in Github. + +For help with upgrading, installing, or general questions please post to the [Dataverse Google Group](https://groups.google.com/forum/#!forum/dataverse-community) or email support@dataverse.org. + +## Installation + +If this is a new installation, please see our [Installation Guide](https://guides.dataverse.org/en/5.3/installation/). + +## Upgrade Instructions + +0\. These instructions assume that you've already successfully upgraded from Dataverse 4.x to Dataverse 5 following the instructions in the [Dataverse 5 Release Notes](https://github.com/IQSS/dataverse/releases/tag/v5.0). + +1\. Undeploy the previous version. + +- `/bin/asadmin list-applications` +- `/bin/asadmin undeploy dataverse<-version>` + +(where `` is where Payara 5 is installed, for example: `/usr/local/payara5`) + +2\. Stop payara and remove the generated directory, start. + +- `service payara stop` +- remove the generated directory: +`rm -rf /payara/domains/domain1/generated` +- `service payara start` + +3\. Deploy this version. + +- `/bin/asadmin deploy dataverse-5.2.war` + +4\. Restart payara + +- `service payara stop` +- `service payara start` From 63cb2664243d5fe818de2e34f3b8942deefc680d Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Mon, 30 Nov 2020 21:33:27 -0500 Subject: [PATCH 02/14] first few updates --- doc/release-notes/5.3-release-notes.md | 23 ++++++++++++++++------- doc/release-notes/7263-banner-messages.md | 7 ------- doc/release-notes/7275-aux-files.md | 3 --- 3 files changed, 16 insertions(+), 17 deletions(-) delete mode 100644 doc/release-notes/7263-banner-messages.md delete mode 100644 doc/release-notes/7275-aux-files.md diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 24804b1c55c..04e7d438195 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -4,21 +4,29 @@ This release brings new features, enhancements, and bug fixes to Dataverse. Than ## Release Highlights -### xxx +### Auxiliary Files -xxx (#6919). +### Banners + +### File Tags Searchable from Advanced Search + +File tags ("Documentation", "Data", "Code", etc.) now appear on the Advanced Search page. + +Performing a search for files on the dataset page now includes file tags. Previously, only file name and file description were searched. ## Major Use Cases Newly-supported use cases in this release include: -- xxx. (Issue #6919, PR #7369) +- Administrators can use a new API to manage banner messages and take advantage of new banner display options (Issue #7263, PR #7434) +- ## Notes for Dataverse Installation Administrators -### xxx +### New Banner API, Deprecated DB Settings + +The functionality previously provided by the DB settings :StatusMessageHeader and ::StatusMessageText is no longer supported and is now provided through the Manage Banner Messages API. Learn more in the [Native API Guide](https://guides.dataverse.org/en/5.x/api/). -xxx ### New Database Settings and JVM Options @@ -28,9 +36,10 @@ xx ## Notes for Tool Developers and Integrators -### xxx +## Experimental Auxiliary File Support + +Experimental endpoints have been added to allow auxiliary files to be added to datafiles. These auxiliary files can be deposited and accessed via API. Later releases will include options for accessing these files through the UI. For more information, see the Auxiliary File Support section of the [Developer Guide](https://guides.dataverse.org/en/5.3/developers/). -xxx ## Complete List of Changes diff --git a/doc/release-notes/7263-banner-messages.md b/doc/release-notes/7263-banner-messages.md deleted file mode 100644 index f53f6879199..00000000000 --- a/doc/release-notes/7263-banner-messages.md +++ /dev/null @@ -1,7 +0,0 @@ -## Major Use Cases - -- New API for Banners.. - -## Notes to Admins - -The functionality previously provided by the DB settings :StatusMessageHeader and ::StatusMessageText is no longer supported and is now provided through the Manage Banner Messages API. Learn more in the [Native API Guide](https://guides.dataverse.org/en/5.x/api/). diff --git a/doc/release-notes/7275-aux-files.md b/doc/release-notes/7275-aux-files.md deleted file mode 100644 index 24aa7f86f2d..00000000000 --- a/doc/release-notes/7275-aux-files.md +++ /dev/null @@ -1,3 +0,0 @@ -## Notes for Tool Developers and Integrators - -Experimental endpoints have been added to allow auxiliary files to be added to datafiles. These auxiliary files can be deposited and accessed via API. Later releases will include options for accessing these files through the UI. For more information, see the Auxiliary File Support section of the [Developer Guide](https://guides.dataverse.org/en/5.3/developers/). From 71aa435840debb85d873bf9c51f9dd9490ea325d Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Tue, 1 Dec 2020 13:58:47 -0500 Subject: [PATCH 03/14] highlights, use cases --- doc/release-notes/5.3-release-notes.md | 17 ++++++++++++----- doc/release-notes/7194-file-tags-search.md | 5 ----- 2 files changed, 12 insertions(+), 10 deletions(-) delete mode 100644 doc/release-notes/7194-file-tags-search.md diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 04e7d438195..f7c8e02bd13 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -4,11 +4,17 @@ This release brings new features, enhancements, and bug fixes to Dataverse. Than ## Release Highlights -### Auxiliary Files +### Auxiliary Files (Experimental) -### Banners +Auxiliary files can now be added to datafiles and accessed using new experimental API endpoints. These endpoints allow additional, non-Dataverse generated metadata to be added alongside datafiles in dataverse. -### File Tags Searchable from Advanced Search +The support for auxiliary files in Dataverse is being driven by integration with the [Open Differential Privacy (DP) Project](https://opendp.io) and is designed to support the deposit and retrieval of differentially private metadata, but the endpoints are not specific to differential privacy use cases. + +### Additional Banner Functionality + +Banners in Dataverse can now be set to allow dismissal by a logged in user. Previously, banners would persist until they were removed by an administrator. This allows administrators to more easily communicate one-time messages to users. + +### File Tags Searchable from Advanced Search and Dataset Search File tags ("Documentation", "Data", "Code", etc.) now appear on the Advanced Search page. @@ -18,8 +24,10 @@ Performing a search for files on the dataset page now includes file tags. Previo Newly-supported use cases in this release include: +- Users can use an API to add auxiliary files to files in order to provide metadata representations for specific tools or integrations (Issue #7275, PR #7350) - Administrators can use a new API to manage banner messages and take advantage of new banner display options (Issue #7263, PR #7434) -- +- Users replacing files will now have their files renamed when a file name conflict exists, making the behavior consistent with upload and edit (Issue #7335, PR #7336) +- Users will now be able to search on file tags on the advanced search and dataset pages (Issue #7194, PR #7385) ## Notes for Dataverse Installation Administrators @@ -27,7 +35,6 @@ Newly-supported use cases in this release include: The functionality previously provided by the DB settings :StatusMessageHeader and ::StatusMessageText is no longer supported and is now provided through the Manage Banner Messages API. Learn more in the [Native API Guide](https://guides.dataverse.org/en/5.x/api/). - ### New Database Settings and JVM Options xx diff --git a/doc/release-notes/7194-file-tags-search.md b/doc/release-notes/7194-file-tags-search.md deleted file mode 100644 index d56b29d7b98..00000000000 --- a/doc/release-notes/7194-file-tags-search.md +++ /dev/null @@ -1,5 +0,0 @@ -### File Tags Searchable from Advanced Search and Dataset Search. - -File tags ("Documentation", "Data", "Code", etc.) now appear on the Advanced Search page. - -Performing a search for files on the dataset page now includes file tags. (Previously, only file name and file description were searched.) From 5835e1ba3eec1b89dcbed940a9385b937f795547 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Tue, 1 Dec 2020 14:22:35 -0500 Subject: [PATCH 04/14] finalizing notes, commit before PR --- doc/release-notes/5.3-release-notes.md | 32 +++++++++++++++-------- doc/release-notes/5345-ejb-timers.md | 4 --- doc/release-notes/7417-payara-5.2020.6.md | 12 --------- 3 files changed, 21 insertions(+), 27 deletions(-) delete mode 100644 doc/release-notes/5345-ejb-timers.md delete mode 100644 doc/release-notes/7417-payara-5.2020.6.md diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index f7c8e02bd13..5b738591e9f 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -31,15 +31,20 @@ Newly-supported use cases in this release include: ## Notes for Dataverse Installation Administrators -### New Banner API, Deprecated DB Settings +### Payara 5.2020.6 Required -The functionality previously provided by the DB settings :StatusMessageHeader and ::StatusMessageText is no longer supported and is now provided through the Manage Banner Messages API. Learn more in the [Native API Guide](https://guides.dataverse.org/en/5.x/api/). +Some changes in this release require an upgrade to Payara 5.2020.6. -### New Database Settings and JVM Options +Instructions how to update can be found in the +[Payara documentation](https://docs.payara.fish/community/docs/5.2020.6/documentation/user-guides/upgrade-payara.html) + +### New Banner API, Obsolete DB Settings -xx +The functionality previously provided by the DB settings :StatusMessageHeader and ::StatusMessageText is no longer supported and is now provided through the Manage Banner Messages API. Learn more in the [API Guide](https://guides.dataverse.org/en/5.3/api/). + +### New Database Settings and JVM Options -- :xxx - xxx +No new DB Settings or JVM Options have been added in this release. See above note about obsolete options. ## Notes for Tool Developers and Integrators @@ -47,7 +52,6 @@ xx Experimental endpoints have been added to allow auxiliary files to be added to datafiles. These auxiliary files can be deposited and accessed via API. Later releases will include options for accessing these files through the UI. For more information, see the Auxiliary File Support section of the [Developer Guide](https://guides.dataverse.org/en/5.3/developers/). - ## Complete List of Changes For the complete list of code changes in this release, see the [5.3 Milestone](https://github.com/IQSS/dataverse/milestone/93?closed=1) in Github. @@ -69,18 +73,24 @@ If this is a new installation, please see our [Installation Guide](https://guide (where `` is where Payara 5 is installed, for example: `/usr/local/payara5`) -2\. Stop payara and remove the generated directory, start. +2\. Upgrade to Payara 5.2020.6 following the steps in the [Payara documentation](https://docs.payara.fish/community/docs/5.2020.6/documentation/user-guides/upgrade-payara.html) + +3\. Stop payara and remove the generated directory, start. - `service payara stop` -- remove the generated directory: +- remove the generated directory: `rm -rf /payara/domains/domain1/generated` - `service payara start` -3\. Deploy this version. +4\. Deploy this version. -- `/bin/asadmin deploy dataverse-5.2.war` +- `/bin/asadmin deploy dataverse-5.3.war` -4\. Restart payara +5\. Restart payara - `service payara stop` - `service payara start` + +6\. Reset the EJB timer database back to default: + +- `/asadmin set configs.config.server-config.ejb-container.ejb-timer-service.timer-datasource=jdbc/__TimerPool` diff --git a/doc/release-notes/5345-ejb-timers.md b/doc/release-notes/5345-ejb-timers.md deleted file mode 100644 index cf6c9ae5979..00000000000 --- a/doc/release-notes/5345-ejb-timers.md +++ /dev/null @@ -1,4 +0,0 @@ -Reset the EJB timer database back to default: -``` -/asadmin set configs.config.server-config.ejb-container.ejb-timer-service.timer-datasource=jdbc/__TimerPool -``` \ No newline at end of file diff --git a/doc/release-notes/7417-payara-5.2020.6.md b/doc/release-notes/7417-payara-5.2020.6.md deleted file mode 100644 index 8377e772b9f..00000000000 --- a/doc/release-notes/7417-payara-5.2020.6.md +++ /dev/null @@ -1,12 +0,0 @@ -## Update to Payara Platform 5.2020.6 - -In contrast to good old Glassfish 4, the Payara application server -is a maintained product, receiving both feature and - more important - -security and dependent technology updates. You should update the -application server platform on a regular basis, as it is a key component -of a running Dataverse deployment. - - - -Instructions how to update can be found in the -[Payara documentation](https://docs.payara.fish/community/docs/5.2020.6/documentation/user-guides/upgrade-payara.html) From 4d01377822d7197c68b657809b0c412bfc6e7b4e Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Tue, 1 Dec 2020 14:27:48 -0500 Subject: [PATCH 05/14] column header change --- doc/release-notes/5.3-release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 5b738591e9f..54830d504f6 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -48,7 +48,7 @@ No new DB Settings or JVM Options have been added in this release. See above not ## Notes for Tool Developers and Integrators -## Experimental Auxiliary File Support +### Experimental Auxiliary File Support Experimental endpoints have been added to allow auxiliary files to be added to datafiles. These auxiliary files can be deposited and accessed via API. Later releases will include options for accessing these files through the UI. For more information, see the Auxiliary File Support section of the [Developer Guide](https://guides.dataverse.org/en/5.3/developers/). From 87ff5fcb1f0b10d013e25054114f3d84127ecff6 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Tue, 8 Dec 2020 12:01:53 -0500 Subject: [PATCH 06/14] updates before code review and release cutting --- doc/release-notes/5.3-release-notes.md | 73 ++++++++++++--- .../7418-datasourcedefinition.md | 88 ------------------- doc/release-notes/7423-jms-move-to-code.md | 13 --- 3 files changed, 63 insertions(+), 111 deletions(-) delete mode 100644 doc/release-notes/7418-datasourcedefinition.md delete mode 100644 doc/release-notes/7423-jms-move-to-code.md diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 54830d504f6..5d8a14abe9f 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -20,6 +20,16 @@ File tags ("Documentation", "Data", "Code", etc.) now appear on the Advanced Sea Performing a search for files on the dataset page now includes file tags. Previously, only file name and file description were searched. +### Easier Configuration of Database Connections + +Previously, the configuration of the database connections has been quite static and not very easy to update. This has been an issue especially for cloud and container usage. Using new technologies provided by the move to Payara, you can now more easily configure the connection to your PostgreSQL DB. + +Using MicroProfile Config API (Issue #7000, Issue #7418), you can much more easily specify 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). + +Note that some settings have been moved from domain.xml to code, such as min and max pool size. + ## Major Use Cases Newly-supported use cases in this release include: @@ -44,7 +54,28 @@ The functionality previously provided by the DB settings :StatusMessageHeader an ### New Database Settings and JVM Options -No new DB Settings or JVM Options have been added in this release. See above note about obsolete options. +Several new DB options have been added in this release: + +- dataverse.db.name +- dataverse.db.user +- dataverse.db.password +- dataverse.db.host +- dataverse.db.port + +See above note about obsolete options. + +### Java Message System Configuration + +The Ingest process uses the Java Message System to create ingest tasks in a queue. That queue had been configured from command line or domain.xml before. This has now changed to being done +in code. + +In the unlikely case you might want to change any of these settings, feel free to change and recompile or raise an issue on Github. See `IngestQueueProducer` for more details. + +If you want to clean up your existing installation, you can delete the old, unused queue like this: + +```shell +asadmin delete-connector-connection-pool --cascade=true jms/IngestQueueConnectionFactoryPool +``` ## Notes for Tool Developers and Integrators @@ -66,31 +97,53 @@ If this is a new installation, please see our [Installation Guide](https://guide 0\. These instructions assume that you've already successfully upgraded from Dataverse 4.x to Dataverse 5 following the instructions in the [Dataverse 5 Release Notes](https://github.com/IQSS/dataverse/releases/tag/v5.0). -1\. Undeploy the previous version. +1\. Upgrade to Payara 5.2020.6. + +Instructions how to update can be found in the +[Payara documentation](https://docs.payara.fish/community/docs/5.2020.6/documentation/user-guides/upgrade-payara.html) + +2\. Undeploy the previous version. - `/bin/asadmin list-applications` - `/bin/asadmin undeploy dataverse<-version>` (where `` is where Payara 5 is installed, for example: `/usr/local/payara5`) -2\. Upgrade to Payara 5.2020.6 following the steps in the [Payara documentation](https://docs.payara.fish/community/docs/5.2020.6/documentation/user-guides/upgrade-payara.html) +3\. Update your database connection. + +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`.) + +- `/asadmin create-system-properties "dataverse.db.user=${DB_USER}"` +- `/asadmin create-system-properties "dataverse.db.host=${DB_HOST}"` +- `/asadmin create-system-properties "dataverse.db.port=${DB_PORT}"` +- `/asadmin create-system-properties "dataverse.db.name=${DB_NAME}"` +- `echo "AS_ADMIN_ALIASPASSWORD=${DB_PASS}" > /tmp/password.txt` -3\. Stop payara and remove the generated directory, start. +- `/asadmin create-password-alias --passwordfile /tmp/password.txt dataverse.db.password` +- `rm /tmp/password.txt` + +4\. Reset the EJB timer database back to default: + +- `/asadmin set configs.config.server-config.ejb-container.ejb-timer-service.timer-datasource=jdbc/__TimerPool` + +5\. Delete the old password alias and DB pool: + +- `/asadmin delete-jdbc-connection-pool --cascade=true dvnDbPool` +- `/asadmin delete-password-alias db_password_alias` + +6\. Stop payara and remove the generated directory, start. - `service payara stop` - remove the generated directory: `rm -rf /payara/domains/domain1/generated` - `service payara start` -4\. Deploy this version. +7\. Deploy this version. - `/bin/asadmin deploy dataverse-5.3.war` -5\. Restart payara +8\. Restart payara - `service payara stop` - `service payara start` - -6\. Reset the EJB timer database back to default: - -- `/asadmin set configs.config.server-config.ejb-container.ejb-timer-service.timer-datasource=jdbc/__TimerPool` diff --git a/doc/release-notes/7418-datasourcedefinition.md b/doc/release-notes/7418-datasourcedefinition.md deleted file mode 100644 index b8c5561c2c2..00000000000 --- a/doc/release-notes/7418-datasourcedefinition.md +++ /dev/null @@ -1,88 +0,0 @@ -## Release Highlights - -### 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 specify 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). - -Note that some settings have been moved from domain.xml to code such as min and max pool size. - -## Notes for Dataverse Installation Administrators - -### New JVM Options - -- dataverse.db.name -- dataverse.db.user -- dataverse.db.password -- dataverse.db.host -- dataverse.db.port - - - - - -🚨 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. -``` -/asadmin list-applications -/asadmin undeploy dataverse- -``` - -(where `` 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`.) - -``` -/asadmin create-system-properties "dataverse.db.user=${DB_USER}" -/asadmin create-system-properties "dataverse.db.host=${DB_HOST}" -/asadmin create-system-properties "dataverse.db.port=${DB_PORT}" -/asadmin create-system-properties "dataverse.db.name=${DB_NAME}" -echo "AS_ADMIN_ALIASPASSWORD=${DB_PASS}" > /tmp/password.txt -/asadmin create-password-alias --passwordfile /tmp/password.txt dataverse.db.password -rm /tmp/password.txt -``` - - - -Now you are safe to delete the old password alias and DB pool: -``` -/asadmin delete-jdbc-connection-pool --cascade=true dvnDbPool -/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/domains/domain1/generated -service payara start -``` - -3. Deploy this version. -``` -/bin/asadmin deploy dataverse-5.3.war -``` - -4. Restart Payara -``` -service payara stop -service payara start -``` diff --git a/doc/release-notes/7423-jms-move-to-code.md b/doc/release-notes/7423-jms-move-to-code.md deleted file mode 100644 index a324b805716..00000000000 --- a/doc/release-notes/7423-jms-move-to-code.md +++ /dev/null @@ -1,13 +0,0 @@ -# Java Message System Configuration - -The ingest part of Dataverse uses the Java Message System to create ingest tasks in a queue. -That queue had been configured from command line or domain.xml before. This has now changed to being done -in code. - -In the unlikely case you might want to change any of these settings, feel free to change and recompile or raise an issue. -See `IngestQueueProducer` for more details. - -If you want to clean up your existing installation, you can delete the old, unused queue like this: -```shell -asadmin delete-connector-connection-pool --cascade=true jms/IngestQueueConnectionFactoryPool -``` \ No newline at end of file From 232751af9f6be3c2ffcaee01c655aefe53a0d658 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Tue, 8 Dec 2020 17:35:08 -0500 Subject: [PATCH 07/14] update from code review --- doc/release-notes/5.3-release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 5d8a14abe9f..2dc7d02b8fa 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -125,7 +125,7 @@ Please configure your connection details, replacing all the `${DB_...}`. 4\. Reset the EJB timer database back to default: -- `/asadmin set configs.config.server-config.ejb-container.ejb-timer-service.timer-datasource=jdbc/__TimerPool` +- `/bin/asadmin set configs.config.server-config.ejb-container.ejb-timer-service.timer-datasource=jdbc/__TimerPool` 5\. Delete the old password alias and DB pool: From 5717a4024129a54a81e9c38d80fe4e3954388ad2 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Tue, 8 Dec 2020 17:44:24 -0500 Subject: [PATCH 08/14] updates from code review --- doc/release-notes/5.3-release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 2dc7d02b8fa..f8fe44287aa 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -136,7 +136,7 @@ Please configure your connection details, replacing all the `${DB_...}`. - `service payara stop` - remove the generated directory: -`rm -rf /payara/domains/domain1/generated` +`rm -rf /glassfish/domains/domain1/generated` - `service payara start` 7\. Deploy this version. From 9b875614cf006e0d7b182e4aca8f7ddaf5fd3a57 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Tue, 8 Dec 2020 18:00:28 -0500 Subject: [PATCH 09/14] udpates from code review --- doc/release-notes/5.3-release-notes.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index f8fe44287aa..039a2401e12 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -54,7 +54,7 @@ The functionality previously provided by the DB settings :StatusMessageHeader an ### New Database Settings and JVM Options -Several new DB options have been added in this release: +Several new JVM options have been added in this release: - dataverse.db.name - dataverse.db.user @@ -62,7 +62,10 @@ Several new DB options have been added in this release: - dataverse.db.host - dataverse.db.port -See above note about obsolete options. +For an overview of these new options, please see the +[Installation Guide](https://guides.dataverse.org/en/5.3/installation/config.html#jvm-options) + +See above note about obsolete DB options. ### Java Message System Configuration From f82f970aa6e1706dcf631eebcb498c159f6ffc96 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Wed, 9 Dec 2020 10:07:40 -0500 Subject: [PATCH 10/14] feedback from CR, adding bin --- doc/release-notes/5.3-release-notes.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 039a2401e12..59477bcbded 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -76,9 +76,7 @@ In the unlikely case you might want to change any of these settings, feel free t If you want to clean up your existing installation, you can delete the old, unused queue like this: -```shell -asadmin delete-connector-connection-pool --cascade=true jms/IngestQueueConnectionFactoryPool -``` +`/asadmin delete-connector-connection-pool --cascade=true jms IngestQueueConnectionFactoryPool` ## Notes for Tool Developers and Integrators @@ -117,13 +115,13 @@ Instructions how to update can be found in the 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`.) -- `/asadmin create-system-properties "dataverse.db.user=${DB_USER}"` -- `/asadmin create-system-properties "dataverse.db.host=${DB_HOST}"` -- `/asadmin create-system-properties "dataverse.db.port=${DB_PORT}"` -- `/asadmin create-system-properties "dataverse.db.name=${DB_NAME}"` +- `/bin/asadmin create-system-properties "dataverse.db.user=${DB_USER}"` +- `/bin/asadmin create-system-properties "dataverse.db.host=${DB_HOST}"` +- `/bin/asadmin create-system-properties "dataverse.db.port=${DB_PORT}"` +- `/bin/asadmin create-system-properties "dataverse.db.name=${DB_NAME}"` - `echo "AS_ADMIN_ALIASPASSWORD=${DB_PASS}" > /tmp/password.txt` -- `/asadmin create-password-alias --passwordfile /tmp/password.txt dataverse.db.password` +- `/bin/asadmin create-password-alias --passwordfile /tmp/password.txt dataverse.db.password` - `rm /tmp/password.txt` 4\. Reset the EJB timer database back to default: @@ -132,8 +130,8 @@ Please configure your connection details, replacing all the `${DB_...}`. 5\. Delete the old password alias and DB pool: -- `/asadmin delete-jdbc-connection-pool --cascade=true dvnDbPool` -- `/asadmin delete-password-alias db_password_alias` +- `/bin/asadmin delete-jdbc-connection-pool --cascade=true dvnDbPool` +- `/bin/asadmin delete-password-alias db_password_alias` 6\. Stop payara and remove the generated directory, start. From faf0e2b13f70cd46a82a8a883f1e1cf2533d8d8f Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Wed, 9 Dec 2020 10:29:54 -0500 Subject: [PATCH 11/14] adding bin in one more place --- doc/release-notes/5.3-release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 59477bcbded..0671a86cfc8 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -76,7 +76,7 @@ In the unlikely case you might want to change any of these settings, feel free t If you want to clean up your existing installation, you can delete the old, unused queue like this: -`/asadmin delete-connector-connection-pool --cascade=true jms IngestQueueConnectionFactoryPool` +`/bin/asadmin delete-connector-connection-pool --cascade=true jms IngestQueueConnectionFactoryPool` ## Notes for Tool Developers and Integrators From 788af532e0c390cfbd9c6423d181bcfd09d36c45 Mon Sep 17 00:00:00 2001 From: landreev Date: Wed, 9 Dec 2020 13:26:55 -0500 Subject: [PATCH 12/14] Update 5.3-release-notes.md --- doc/release-notes/5.3-release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 0671a86cfc8..8f397b13400 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -76,7 +76,7 @@ In the unlikely case you might want to change any of these settings, feel free t If you want to clean up your existing installation, you can delete the old, unused queue like this: -`/bin/asadmin delete-connector-connection-pool --cascade=true jms IngestQueueConnectionFactoryPool` +`/bin/asadmin delete-connector-connection-pool --cascade=true jms IngestQueueConnectionFactoryPool` ## Notes for Tool Developers and Integrators From 02215f12da7c70cbaa8ca9e7ba5c9c748214d629 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Wed, 9 Dec 2020 18:41:09 -0500 Subject: [PATCH 13/14] adding - --- doc/release-notes/5.3-release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index 8f397b13400..a569fed9a62 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -76,7 +76,7 @@ In the unlikely case you might want to change any of these settings, feel free t If you want to clean up your existing installation, you can delete the old, unused queue like this: -`/bin/asadmin delete-connector-connection-pool --cascade=true jms IngestQueueConnectionFactoryPool` +- `/bin/asadmin delete-connector-connection-pool --cascade=true jms IngestQueueConnectionFactoryPool` ## Notes for Tool Developers and Integrators From 42843fc944a886f39d76ae5e99fc8d8463bef426 Mon Sep 17 00:00:00 2001 From: Danny Brooke Date: Thu, 10 Dec 2020 11:49:44 -0500 Subject: [PATCH 14/14] adding release note from MPConfig api --- doc/release-notes/5.3-release-notes.md | 8 ++++++++ doc/release-notes/7457-introduce-mpconfig.md | 10 ---------- 2 files changed, 8 insertions(+), 10 deletions(-) delete mode 100644 doc/release-notes/7457-introduce-mpconfig.md diff --git a/doc/release-notes/5.3-release-notes.md b/doc/release-notes/5.3-release-notes.md index a569fed9a62..544d7a41914 100644 --- a/doc/release-notes/5.3-release-notes.md +++ b/doc/release-notes/5.3-release-notes.md @@ -67,6 +67,14 @@ For an overview of these new options, please see the See above note about obsolete DB options. +### Introducing MicroProfile Config API + +With this Dataverse release, Dataverse Administrators can start to make use of the MicroProfile Config API. + +This will benefit both developers and sysadmins, but the codebase will have to be refactored to make use of it. As this will take time, we will always provide a backward compatible way of using it. + +For more details about these new options, please see the Consuming Configuration section of the [Developer Guide](https://guides.dataverse.org/en/5.3/developers/). + ### Java Message System Configuration The Ingest process uses the Java Message System to create ingest tasks in a queue. That queue had been configured from command line or domain.xml before. This has now changed to being done diff --git a/doc/release-notes/7457-introduce-mpconfig.md b/doc/release-notes/7457-introduce-mpconfig.md deleted file mode 100644 index 2f90590fca5..00000000000 --- a/doc/release-notes/7457-introduce-mpconfig.md +++ /dev/null @@ -1,10 +0,0 @@ -## Introducing MicroProfile Config API - -With this Dataverse release, we start to make use of the MicroProfile Config API. (As you might have noticed -for the database connection settings.) - -This will benefit both devs and sysadmins, but the codebase will have to be refactored to make use of it. -As this will take time, we will always provide a backward compatible way of using it. - -For more details, please see the development guide about "Consuming Configuration", which also -explains the benefits in more detail. \ No newline at end of file