Improve docs for `enable-version-pinning` config constraint

samuelallan72 commented 3 months ago

I observed this on a cloud with enable-version-pinning set to true for octavia-ovn-chassis and ovn-chassis. COU plan/upgrade emits this error output:

Cannot generate plan for 'octavia-ovn-chassis'
        Cannot upgrade 'octavia-ovn-chassis'. 'enable-version-pinning' must be set to 'false'.
Cannot generate plan for 'ovn-chassis'
        Cannot upgrade 'ovn-chassis'. 'enable-version-pinning' must be set to 'false'.

I couldn't find the reason why it must be set to false, and I couldn't find any recommendation for what to do now (is it safe to set the config to false on a production cloud?).

We should improve the docs here.

samuelallan72 commented 3 months ago

More information for context (that we can add to the error message and COU docs):

this constraint was added in https://github.com/canonical/charmed-openstack-upgrader/pull/338
upstream docs recommend disabling version pinning in these circumstances: https://docs.openstack.org/charm-guide/latest/project/procedures/ovn-upgrade-2203.html#disable-version-pinning

Pjack commented 1 month ago

An idea is to implement a cou lint command to check the environment and print out detail information.

canonical / charmed-openstack-upgrader

Improve docs for `enable-version-pinning` config constraint #460