installer: clarify experimental config flag

[Pothulapati]

Description

This PR updates the flag descriptions, and the render display
notes to be more explicit on what experimental config is.

This flag is required, to make sure users are opting in explicitely/
knowlingly to use the experimental config.

Signed-off-by: Tarun Pothulapati [email protected]

Related Issue(s)

Fixes #8107

How to test

render cmd should have the renamed naming, and messages

Release Notes

Renamed `danger-use-unsupported-config` flag in the installer to `use-experimental-config`

Documentation

/werft no-preview

[csweichel]

I'm a bit late to the party - the motivation for this switch is to have a clear (and deliberately inconvenient) hurdle to use experimental config. If we don't have a cost associated with this config, what distinguishes it from regular config other than some random bit "experimental" in the config?

@metcalfc's proposal was 💯 on point imho: just make the warning/message clearer and tell users what they have to do to use the experimental bit config.

Also, the assumption that "users have experimental config in there so they must know what they're doing" is flawed. Say you get config sent to you, don't really understand it in detail, then this flag will make (hopefully) make you stop and think for a second. Granted, with the Replicated layer on top that's less of a concern - but still valid. Imagine a new hire at Gitpod needing to use the installer and stumbling over this switch, you've just taught them there's "experimental config". Add some more detail to the flag description and error message, and they understand why it's there.

[Pothulapati]

Say you get config sent to you, don't really understand it in detail, then this flag will make (hopefully) make you stop and think for a second. Granted, with the Replicated layer on top that's less of a concern - but still valid. Imagine a new hire at Gitpod needing to use the installer and stumbling over this switch, you've just taught them there's "experimental config". Add some more detail to the flag description and error message, and they understand why it's there.

Agree on the points specified here! Updated the PR to rename the flag, and have the display messages be clearer.

[mustard-mh]

/hold
this PR block merge pool now, I leave hold here

[corneliusludmann]

build is green now, next try

/unhold