[MAGNOLIA-6921] Refactor jr config file shipped w/ Magnolia bundles Created: 12/Jan/17  Updated: 05/Jan/18  Resolved: 05/Jan/18

Status: Closed
Project: Magnolia
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Jan Haderka Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: tech-debt
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Release notes required:
Yes
Documentation update required:
Yes
Date of First Response:
Story Points: 3

 Description   

The config files mentioned in %subj% are often taken as "default"/"best practice" by users and used without deeper thought for configuration provided. This often results in decisions about storage that are sub-par at best. Aim of the ticket is to improve the situation by following:

  • rename said files
    • ditch "bundle" and "search" from name converting jackrabbit-bundle-mysql-search.xml to just jackrabbit-mysql.xml
    • for remote DB setups (mysql, postgres, ingres) provide two separate configuration for the different setup:
      • one using currently provided setup (PersistenceManager in DB, FileStore and DataStore in FS)
      • one with everything in DB only
    • name each setup as appropriate using extra suffix (that suffix will be used only for remote DB configurations so NOT for H2 or Derby)
    • explain purpose of the config file in html comment on top of each file (one is providing (in most cases) better performance, but is more difficult to backup/restore due to split in storage, while other is easiest for backup/restore since all is in one place, but might be slower (depending on performance of DB and network in given setup))

at the end there should be 9 config files provided by us:

jackrabbit-derby.xml
jackrabbit-h2.xml
jackrabbit-mysql-filestore.xml
jackrabbit-mysql-dbstore.xml
jackrabbit-postgres-filestore.xml
jackrabbit-postgres-dbstore.xml
jackrabbit-ingres-filestore.xml
jackrabbit-ingres-dbstore.xml
jackrabbit-memory.xml

The naming above is just proposal, as part of the ticket, please suggest final naming for different configurations. Other variants considered have been (so far):

  • jr-mysql-filesystem.xml vs jr-mysql-only.xml
  • jr-mysql-and-fs.xml vs jr-mysql-only.xml
  • jr-mysql-and-fs.xml vs jr-mysql-db-only.xml


 Comments   
Comment by Antti Hietala [ 19/May/17 ]

Renaming the files is not a breaking change but we would prefer to do this with the next major release.

Generated at Mon Feb 12 04:19:05 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.