openstack-origin config setting documentation is stale and incomplete

[Mike McCracken]

the doc string in config.yaml for this charm only covers Precise and Trusty, and doesn't mention openstack liberty.

Ideally the docs would be up to date with what the charm currently supports, and would also mention what versions of openstack are supported with non-LTS releases. I looked at the code, and it looks like the LTS releases support many openstack versions , while the non-LTS releases only support a single openstack release, the one that was concurrently released. The docs should mention that.

I think probably a good solution here is to have config.yaml just point to a URL, maybe on the wiki where you post the release notes, and have a full and current matrix of supported versions at that URL.

This affects most of the openstack charms.

[Ryan Beisner (1chb1n)]

+1 to making this more clear. Currently, there is a certain amount of research and assumption placed on the user to determine:

"What versions of Ubuntu + OpenStack can I deploy with this charm?"

I'd suggest that:

(a) Each of the OpenStack Charms ReleaseNotes wiki pages should be issued containing the then-current list of deployable combinations (and which are LTS, which are iterim/dev/test).

and

(b) Each of the OpenStack Charms READMEs should point to that ReleaseNotes wiki URL, in addition to these:
https://wiki.ubuntu.com/ServerTeam/OpenStackCharms
https://wiki.ubuntu.com/ServerTeam/CloudArchive
http://www.ubuntu.com/info/release-end-of-life

...

Recent ReleaseNote examples:
https://wiki.ubuntu.com/ServerTeam/OpenStackCharms/ReleaseNotes1510
https://wiki.ubuntu.com/ServerTeam/OpenStackCharms/ReleaseNotes1504
https://wiki.ubuntu.com/ServerTeam/OpenStackCharms/ReleaseNotes1501

[James Page (james-page)]

I added a section to:

  https://wiki.ubuntu.com/ServerTeam/OpenStackCharms

to detail how to use openstack-origin - I think it covers all the bases, but feel free to add/edit as required.

[Edward Hope-Morley (hopem)]

The charm config.yamls were recently updated (look for "config cleanup" in the commit logs) and this will be in the 17.08 release.