search

quarkiverse / quarkus-operator-sdk

Quarkus Extension to create Kubernetes Operators in Java using the Java Operator SDK (https://github.com/java-operator-sdk/java-operator-sdk) project
Apache License 2.0
119 stars 50 forks source link

Change prefix for configuration properties from `quarkus.operator-sdk` to `qosdk`? #733

Open metacosm opened 1 year ago

metacosm commented 1 year ago

This would be shorter to type and would also bypass conversion issues between env variables and property names.

kdubb commented 11 months ago

This seems like a pretty big departure from Quarkus norms for a Quarkiverse project (which all live under quarkus.), for a few keystrokes.

Just dropping the -sdk. would get you nearly the same savings; and even then I don't think it's worth the deviation.

metacosm commented 11 months ago

This seems like a pretty big departure from Quarkus norms for a Quarkiverse project (which all live under quarkus.), for a few keystrokes.

Indeed, but then again, I think that having everything with the same prefix makes it useless to have the prefix because it becomes just noise. So I feel that switching to qosdk as the prefix would streamline things and make it easier for folks to discover and type properties (even when there's no auto-completion available).

Just dropping the -sdk. would get you nearly the same savings; and even then I don't think it's worth the deviation.

Dropping the -sdk part is needed because this will remove ambiguity during the env <-> property name conversion process which has and is causing issues.

kdubb commented 11 months ago

make it easier for folks to discover and type properties (even when there's no auto-completion available).

Objectively this will make it harder. Right now I know, without looking anywhere, it's the plugin name... so starts quarks.operator-sdk. or QUARKUS_OPERATOR_SDK_. Migrating from this will require me to look it up.

Maybe just alias them to some other root?

metacosm commented 11 months ago

make it easier for folks to discover and type properties (even when there's no auto-completion available).

Objectively this will make it harder. Right now I know, without looking anywhere, it's the plugin name... so starts quarks.operator-sdk. or QUARKUS_OPERATOR_SDK_. Migrating from this will require me to look it up.

An example of the problem is how does Quarkus knows that QUARKUS_OPERATOR_SDK_ maps to a property named quarkus.operator-sdk or quarkus.operator.sdk?

Don't get me wrong, I get your points but there's a real issue at the moment with the prefix.

Maybe just alias them to some other root?