FISH-788: update docs for directory config source #126
Conversation
…nality. This doc change aligns the docs with the new implementation of the directory config source for MicroProfile Config API. - See PR payara/Payara#5007 - Internal ticket FISH-788
|
|
||
| === Map property names to a sub-directory structure | ||
|
|
||
| _Since *5.2020.7* _ | ||
| _Since *5.2021.1* _ |
There was a problem hiding this comment.
Please change this if necessary. Can be done via GH suggestion comment for example.
docs/modules/ROOT/pages/documentation/microprofile/config/directory.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/documentation/microprofile/config/directory.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/documentation/microprofile/config/directory.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/documentation/microprofile/config/directory.adoc
Outdated
Show resolved
Hide resolved
|
Resolved by payara/Payara#5104 |
There was a problem hiding this comment.
Do not merge this (yet) as the code PR seems to introduce errors during deployment of application. Further investigation is required and it might not be included in 5.2021.1 .
MPCONFIG DirConfigSource: error during setup.
java.io.IOException: Given MPCONFIG directory 'secrets' is no directory, cannot be read or has a leading dot.
An undocumented default setting present since 2020/10 was missing.
|
|
@OndroMih @rdebusscher do you want to add some words about the need to restart the server after setting the directory? Also, should we document how that can be avoided by using a PREBOOT or POSTBOOT script? This config source is pretty much about being used for K8s and containers, so that would be a very handy info for users. |
|
General point is: Add as much and as detailed info as possible in the doc. But main info seems to be added already (as far as my quick check reveals) |
There was a problem hiding this comment.
Hi @poikilotherm,
Could you change 'server (the DAS)' default value to just 'server-config' - just to keep it consistent with the rest of our docs, sorry I didn't catch it in the first docs PR. Otherwise looks good to merge to me.
… config source FISH-788
…source configuration. FISH-788
|
As requested, I fixed the wording and added some hints about restarting and using the bootscripts when inside containers. |
|
Thx for merging! Glad to see this is done 😄 |
Match directory config source docs to current functionality, as payara/Payara#5007 has been merged. 🎉
This doc change aligns the docs with the new implementation of the directory config source for MicroProfile Config API.
Please review and feel free to change to adapt language, conventions etc.
A former pull request #114 has implemented large parts of this, so this is just an update.