search

camunda / connectors

Camunda Connectors
https://docs.camunda.io/docs/components/integration-framework/connectors/out-of-the-box-connectors/available-connectors-overview/
Apache License 2.0
34 stars 36 forks source link

chore(readme): remove wrong env var hyphen usage #2771

Closed Langleu closed 2 weeks ago

Langleu commented 2 weeks ago

Description

Shells don't support hyphens or dashes in environment variables and will fail to export them. There are ways around this, but I'd not advertise those. Kubernetes can deal with it but depends on the application within whether it can properly load those.

My origin of the change stems from the manual setup where one is typically running some form of shell and based on that the advertised conversion from cluster-id to CLUSTER-ID doesn't work.

Additionally, Spring boot has relaxed binding rules where hyphens are also ignored. Probably stems from shells typically not supporting those out of the box.

I'm not sure whether you've more occurrences in other docs or so, just as a heads up that you shouldn't advertise it this way. The Helm chart is also not using the hyphens and drops it when configuring connectors.

Feel free to use the PR as you see fit, even close. I'd just like to avoid advertising something that does not work in where it's originally linked from.

Related issues

none, just thought I would provide a PR instead of going through slack.

closes #

Langleu commented 2 weeks ago

Actually see in the docs as well some usage of that:

https://docs.camunda.io/docs/next/self-managed/connectors-deployment/connectors-configuration/?configuration=local Would be good to have that ironed out. I know the alternative looks ugly but even Spring Boot advertises it that way.

You would maybe benefit from DRY as well to only have it in docs.camunda.io to keep things in sync.

Langleu commented 2 weeks ago

thanks! Added it to the merge queue. On the docs.camunda.io topic, up to your own discretion. From what I could see from other teams, they're all avoiding hyphens in general in their configs. Typically lowerUpercase and if they have one with a hyphen, they define the env var as BLA_BLA_BLABLABLALBLA.

sbuettner commented 2 weeks ago

Thats good input. I wasnt aware of this limitation.