Added documentation for property precedence order, per-tenant configuration and /v1/health/config endpoint. #632
Conversation
|
|
||
| Includes the `user.timezone` property, which is force set to `GMT`. | ||
|
|
||
| This property cannot be overridden. |
There was a problem hiding this comment.
Overriding user.timezone results in the following warning:
Overwrite of user.timezone system property with IST may break database serialization of date. Kill Bill will overwrite to GMT
This code resets the value to GMT.
reshmabidikar
left a comment
reshmabidikar
left a comment
There was a problem hiding this comment.
I do not quite follow how this documentation fits into Aviate Health. Does this correspond to a new API endpoint that exposes all the config properties? Is this endpoint provided by the aviate plugin? If so, a couple of suggestions:
- Add the documentation for this endpoint in the API docs here
- Add a new section (maybe below the Metrics section) to the Aviate health doc and move this content to this section. Ensure that the API doc points to this documentation.
|
@vnandwana Will you rebase this PR based on latest |
…ration and /v1/health/config endpoint.
…ime Properties section.
vnandwana
force-pushed
the
health-config
branch
from
0865fd4 to
26e6981
Compare
Hi @reshmabidikar, thank you for your suggestions. I have addressed these comments, please review the changes at your convenience. This branch has been rebased onto the latest v3. API doc PR -- killbill/slate#352 |
reshmabidikar
left a comment
reshmabidikar
left a comment
There was a problem hiding this comment.
Looks good, I've left a few minor comments.
userguide/aviate/aviate-health.adoc
Outdated
|
|
||
| This provides fine-grained control in multi-tenant deployments, enabling different tenants to customize selected settings while still inheriting defaults from the global configuration. | ||
|
|
||
| For more details, see the official documentation: https://docs.killbill.io/latest/plugin_installation#per-tenant-configuration. |
There was a problem hiding this comment.
I think it would be better to point to this link as https://docs.killbill.io/latest/plugin_installation#per-tenant-configuration has more to do with per-tenant plugin configuration.
There was a problem hiding this comment.
Plz share more info on this, the present link is the same as the suggested link.
There was a problem hiding this comment.
I'm suggesting https://docs.killbill.io/latest/userguide_configuration#_per_tenant_properties, the present link is https://docs.killbill.io/latest/plugin_installation#per-tenant-configuration..
userguide/aviate/aviate-health.adoc
Outdated
| using value from 'EnvironmentVariables': '11s'` | ||
|
|
||
|
|
||
| To make it easier to understand the runtime values of these properties, Kill Bill provides the `/v1/health/config` endpoint. |
There was a problem hiding this comment.
Which endpoint does this refer to? Can we point to the doc link for this endpoint?
There was a problem hiding this comment.
PR for this endpoint is killbill/slate#352 -- if we need to link this API doc, we'll need to merge the Slate PR.
|
|
||
| * Runtime Configuration | ||
|
|
||
| Properties loaded from a configuration file specified via `-Dorg.killbill.server.properties=<propertyFile>`. |
There was a problem hiding this comment.
Does this also include the properties defined in catalina.properties in case of a Tomcat configuration? If so, would be good to mention this explicitly.
3 participants
Ticket -- https://github.com/killbill/technical-support/issues/216