db_password_alias changed to dataverse.db.password #7418 #7422

[pdurbin]

What this PR does / why we need it:

Pull request #7422 didn't include a doc change having to do with db_password_alias being renamed to dataverse.db.password.

Which issue(s) this PR closes:

None but is part of the issue that the original pull request closed: #7418

Special notes for your reviewer:

None.

Suggestions on how to test this:

Just a doc change.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No.

Is there a release notes update needed for this change?:

I don't think so. The upgrade instructions from the previous pull request explain about deleting the old alias.

Additional documentation:

None.

[coveralls]

Coverage remained the same at 19.4% when pulling 5ee7338 on 7418-db-pw-alias into ee3b4f4 on develop.

[poikilotherm]

There's also a possibility to stay with the alias as is. Just explored this. See https://docs.payara.fish/community/docs/5.2020.6/documentation/payara-server/server-configuration/var-substitution/usage-of-variables.html#examples-ver-ref, which would allow us to add a payara-expression-config.properties:

dataverse.db.password={ALIAS=db_password_alias}

It would allow for great backward compatibility, also new installations should use the new format. 😄

[poikilotherm]

As requested on IRC by @pdurbin

The name change in the alias (db_password_alias -> dataverse.db.password) happened because Payara has a MicroProfile Config Source "password", which reads from the aliases store, providing the password to the DataSourceDefinition.

This way, we can provide the database password from any of the possibe mpconfig sources consistently as "dataverse.db.password". It's important to be consistent here and make a single, reusable scope for anything database related.

My above comment was about an option I discovered to provide a backward compatibility, so existing installations wouldn't have to mangle the alias store during update.

FWIW: the other password aliases are subject to change in a future version. #7000 will hopefully cover a lot more over time.

[landreev]

@poikilotherm thanks for the explanation.
@pdurbin once again - good eye, it would be confusing to keep mentioning this "db_password_alias" in the docs.