Dashes in environmental value names are not compatible with some shells

CERT-Polska / karton

Distributed malware processing framework based on Python, Redis and S3.

https://karton-core.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

381 stars 45 forks source link

Dashes in environmental value names are not compatible with some shells #235

Closed nazywam closed 7 months ago

nazywam commented 9 months ago

Some of karton services use the dash (-) character within section names. This works fine for .ini files but can cause problems when configured using environmental values. [1]

Some of the solutions we could fix that:

base all services on bash instead of sh - it seems that bash handles them correctly
add a short pre-processor when loading values from env so that user can e.g. use a __ instead of a -

[1] https://github.com/kubernetes/kubernetes/issues/16863

nazywam commented 7 months ago

I think this issue can be closed after adding a small warning in the https://karton-core.readthedocs.io/en/latest/service_configuration.html docs section