Charm configuration deprecated option flag

[Stuart Bishop]

As Juju becomes more featureful, more and more charm configuration options become unnecessary. Unfortunately, they still need to hang around for quite some time for backwards compatibility reasons.

Could we get a boolean flag on charm configuration items that flag the option as 'deprecated'?

I think it is fine if Juju core completely ignores the new flag. Optionally the CLI and/or the GUI can warn if a deprecated option is set.

The charm store and any other systems that generate documentation should use the flag, hiding the deprecated options (which often conflict or contradict other charm options or model configuration).

https://jujucharms.com/new/postgresql is an example of a charm with many deprecated options, and a correspondingly confusing generated configuration section.

I suggest config.yaml that looks like:

options:
   admin_interface:
   default: ""
   type: string
   description: Ignored. Use Juju spaces.
   deprecated: true

[Richard Harding (rharding)]

Thanks, I can see the need to be able to help with that over time. It feels like something we need to bring to the current discussions around improving config for the roadmap.

[Canonical Juju QA Bot (juju-qa-bot)]

This bug has not been updated in 2 years, so we're marking it Low importance. If you believe this is incorrect, please update the importance.