[
https://issues.apache.org/jira/browse/UNOMI-1007?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Serge Huber updated UNOMI-1007:
-------------------------------
Description:
h3. Summary
The manual and the quickstart explain how to configure the health check with
{{UNOMI_HEALTHCHECK_ENABLED}}, {{UNOMI_HEALTHCHECK_PROVIDERS}} and
{{UNOMI_HEALTHCHECK_TIMEOUT}}. In 4.0 Unomi no longer reads these variables, so
changing them does nothing. Only {{UNOMI_HEALTHCHECK_PASSWORD}} still works.
The variables stopped being read with UNOMI-919.
The goal of this ticket is that the three variables work again, in a safe way,
and that the documentation matches.
h3. Decided approach
* Read the three variables again, as in 3.0.
* Check the values: unknown provider names are ignored with a warning, the
timeout must stay within sensible bounds, and an invalid value falls back to
the safe default with a warning.
* Disabling the health check turns the endpoint off. It never makes it answer
without authentication.
* No variable can turn off authentication. A blank password is still refused.
* Update the manual, the quickstart, the health check README and the Docker
examples.
h3. How to test
Manual check: start Unomi with the health check disabled through the
environment, then with a custom list of providers. Check that the health check
follows these settings.
Automated tests to add:
* Each of the three variables reaches the health check configuration.
* A health check integration test with the health check disabled, and one with
a reduced list of providers.
* Unknown provider names, a timeout out of bounds, and invalid values fall back
to safe defaults with a warning.
* The health check refuses requests without valid credentials, whatever the
settings. The existing blank password test still passes.
was:
h3. Summary
The manual and the quickstart explain how to configure the health check with
{{UNOMI_HEALTHCHECK_ENABLED}}, {{UNOMI_HEALTHCHECK_PROVIDERS}} and
{{UNOMI_HEALTHCHECK_TIMEOUT}}. In 4.0 Unomi no longer reads these variables, so
changing them does nothing. Only {{UNOMI_HEALTHCHECK_PASSWORD}} still works.
The variables stopped being read with UNOMI-919.
The goal of this ticket is that the code and the documentation agree.
h3. Ways to explore
* Read the three variables again, as in 3.0.
* Otherwise, remove them from the manual, the quickstart and the health check
README, and explain how to set these options in the configuration file.
* The health check must still require authentication, whatever the settings.
h3. How to test
Manual check: start Unomi with the health check disabled through the
environment, and with a custom list of providers. Check that the health check
follows these settings, or that the documentation no longer mentions them.
Automated tests to add if the variables are read again:
* A test that each of the three variables reaches the health check
configuration.
* A health check integration test with the health check disabled, and one with
a reduced list of providers.
In every case:
* A test that the health check still refuses requests without valid
credentials, whatever the settings. The existing blank password test still
passes.
> Health check environment variables no longer have any effect
> ------------------------------------------------------------
>
> Key: UNOMI-1007
> URL: https://issues.apache.org/jira/browse/UNOMI-1007
> Project: Apache Unomi
> Issue Type: Bug
> Affects Versions: unomi-4.0.0
> Reporter: Serge Huber
> Priority: Major
> Fix For: unomi-4.0.0
>
>
> h3. Summary
> The manual and the quickstart explain how to configure the health check with
> {{UNOMI_HEALTHCHECK_ENABLED}}, {{UNOMI_HEALTHCHECK_PROVIDERS}} and
> {{UNOMI_HEALTHCHECK_TIMEOUT}}. In 4.0 Unomi no longer reads these variables,
> so changing them does nothing. Only {{UNOMI_HEALTHCHECK_PASSWORD}} still
> works. The variables stopped being read with UNOMI-919.
> The goal of this ticket is that the three variables work again, in a safe
> way, and that the documentation matches.
> h3. Decided approach
> * Read the three variables again, as in 3.0.
> * Check the values: unknown provider names are ignored with a warning, the
> timeout must stay within sensible bounds, and an invalid value falls back to
> the safe default with a warning.
> * Disabling the health check turns the endpoint off. It never makes it answer
> without authentication.
> * No variable can turn off authentication. A blank password is still refused.
> * Update the manual, the quickstart, the health check README and the Docker
> examples.
> h3. How to test
> Manual check: start Unomi with the health check disabled through the
> environment, then with a custom list of providers. Check that the health
> check follows these settings.
> Automated tests to add:
> * Each of the three variables reaches the health check configuration.
> * A health check integration test with the health check disabled, and one
> with a reduced list of providers.
> * Unknown provider names, a timeout out of bounds, and invalid values fall
> back to safe defaults with a warning.
> * The health check refuses requests without valid credentials, whatever the
> settings. The existing blank password test still passes.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
